API Reference

Ping

gethttps://api.circle.com/ping

Checks that the service is running.

Response

200

429TooManyRequestsResponse

Response Body

object

code

integer

Required

Code that corresponds to the error.

message

string

Required

Human-readable message that describes the error.

errors

array of objects

Array of detailed error descriptions

Show 3 properties

error

string

Required

Type of descriptive error

Allowed valuesMISSING_OR_INVALID_FIELD

location

string

The key or path where the error occurred

message

string

Required

Detailed description of the error

RequestChoose a language

ResponseChoose an example

1{
2  "message": "pong"
3}

Did this page help you?