Request

Enables to query a specific request. The Request identifier is obtained from the Request Object from any asynchronous requests performed on the API.

Get the status of a request.

get

Authorizations

api_key

x-api-keystringRequired

Query parameters

request_idstringRequired

Responses

200

200 response

application/json

get

/queue/request

HTTPcURLJavaScriptPython

GET /queue/request?request_id=text HTTP/1.1
Host: /
x-api-key: YOUR_API_KEY
Accept: */*

200

200 response

{
  "request": {
    "request_uuid": "text",
    "request_name": "text",
    "request_verb": "text",
    "response_eta": "text",
    "created_at": "text",
    "satellite_id": "text",
    "request_status": {
      "status_code": null,
      "status_name": "text"
    }
  },
  "response": {
    "payload_size": "text",
    "received_at": "text",
    "payload": {},
    "signature": "text",
    "is_verified": "True/False"
  }
}

delete

Authorizations

api_key

x-api-keystringRequired

Query parameters

request_idstringRequired

Responses

200

200 response

application/json

delete

/queue/request

HTTPcURLJavaScriptPython

DELETE /queue/request?request_id=text HTTP/1.1
Host: /
x-api-key: YOUR_API_KEY
Accept: */*

200

200 response

{
  "request": {
    "request_uuid": "text",
    "request_name": "text",
    "request_verb": "text",
    "response_eta": "text",
    "created_at": "text",
    "satellite_id": "text",
    "request_status": {
      "status_code": null,
      "status_name": "text"
    }
  },
  "response": {
    "payload_size": "text",
    "received_at": "text",
    "payload": {},
    "signature": "text",
    "is_verified": "True/False"
  }
}