Retrieve information about an operation

Responses

🟢200Retrieve information about an operation response

application/json

Body

result

api-shield

required

Any of

operation

allOf {2}

endpoint

string <uri-template>

endpoint

required

The endpoint which can contain path parameter templates in curly braces, each will be replaced from left to right with {varN}, starting with {var1}, during insertion. This will further be Cloudflare-normalized upon insertion. See: https://developers.cloudflare.com/rules/normalization/how-it-works/.

<= 4096 characters

Example:

/api/v1/users/{var1}

Match pattern:

^/.*$

features

optional

host

string <hostname>

host

required

RFC3986-compliant host.

<= 255 characters

Example:

www.example.com

last_updated

string <date-time>

timestamp

read-onlyrequired

Example:

2014-01-01T05:20:00.12345Z

method

enum<string>

method

required

The HTTP method used to access the endpoint.

Allowed values:

GETPOSTHEADOPTIONSPUTDELETECONNECTPATCHTRACE

Example:

GET

operation_id

string

uuid

read-onlyrequired

UUID

<= 36 characters

Example:

f174e90a-fafe-4643-bbbc-4a0ed4fc8415

errors

array [object {2}]

messages

required

Example:

[]

code

integer

required

>= 1000

message

string

required

messages

array [object {2}]

messages

required

Example:

[]

code

integer

required

>= 1000

message

string

required

success

enum<boolean>

required

Whether the API call was successful

Allowed value:

true

Example:

true

Example

{
    "errors": [],
    "messages": [],
    "result": {
        "endpoint": "/api/v1/users/{var1}",
        "features": {
            "thresholds": {
                "auth_id_tokens": 0,
                "data_points": 0,
                "last_updated": "2014-01-01T05:20:00.12345Z",
                "p50": 0,
                "p90": 0,
                "p99": 0,
                "period_seconds": 0,
                "requests": 0,
                "suggested_threshold": 0
            }
        },
        "host": "www.example.com",
        "last_updated": "2014-01-01T05:20:00.12345Z",
        "method": "GET",
        "operation_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
    },
    "success": true
}

🟢200Retrieve information about an operation response failure

Retrieve information about an operation

Request

Request samples

Responses