API docs by Redocly

Request catcher (2.0.0)

Download OpenAPI specification:Download

Capture all requests and save them to a unique bin

Get all request bins

Get all request bins (a list of bin ids and request count for that bin)

Responses

Response samples

Content type
application/json
{
  • "bins": [
    ],
  • "count": 0
}

Delete all request bins

Delete all request bins

Responses

Response samples

Content type
application/json
{
  • "status_code": 100,
  • "status_text": "string",
  • "messages": [
    ]
}

Create a new request bin

Create a new request bin which respond as given

Request Body schema: application/json
object

The response specifications for the request bin

object

The config for the request bin

Responses

Request samples

Content type
application/json
{
  • "response": {
    },
  • "service": {
    }
}

Response samples

Content type
application/json
{
  • "bin_id": "b70fa97f-3b45-460c-9232-49cbcf83f256",
  • "created_at": "2019-08-24T14:15:22Z",
  • "expire_at": "2019-08-24T14:15:22Z",
  • "endpoint": "http://example.com",
  • "config": {
    },
  • "request_count": 0
}

Get a request bin

Get the config and summary for a request bin identified by it's id

path Parameters
binId
required
string <uuid> (Uuid) ^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{...

The bin id

Responses

Response samples

Content type
application/json
{
  • "bin_id": "b70fa97f-3b45-460c-9232-49cbcf83f256",
  • "created_at": "2019-08-24T14:15:22Z",
  • "expire_at": "2019-08-24T14:15:22Z",
  • "endpoint": "http://example.com",
  • "config": {
    },
  • "request_count": 0
}

Delete a request bin

Delete a request bin identified by it's id

path Parameters
binId
required
string <uuid> (Uuid) ^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{...

The bin id

Responses

Response samples

Content type
application/json
{
  • "status_code": 100,
  • "status_text": "string",
  • "details": {
    }
}

Update a request bin

Update the config for a request bin identified by it's id

path Parameters
binId
required
string <uuid> (Uuid) ^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{...

The bin id

Request Body schema: application/json
object

The response specifications for the request bin

object

The config for the request bin

Responses

Request samples

Content type
application/json
{
  • "response": {
    },
  • "service": {
    }
}

Response samples

Content type
application/json
{
  • "bin_id": "b70fa97f-3b45-460c-9232-49cbcf83f256",
  • "created_at": "2019-08-24T14:15:22Z",
  • "expire_at": "2019-08-24T14:15:22Z",
  • "endpoint": "http://example.com",
  • "config": {
    },
  • "request_count": 0
}

Get all requests which are captured in the request bin

Get all requests which are captured in the request bin identified by it's id

path Parameters
binId
required
string <uuid> (Uuid) ^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{...

The bin id

Responses

Response samples

Content type
application/json
{
  • "request": [
    ],
  • "count": 0
}

Remove all requests which are captured in the request bin

Remove all requests which are captured in the request bin identified by it's id

path Parameters
binId
required
string <uuid> (Uuid) ^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{...

The bin id

Responses

Response samples

Content type
application/json
{
  • "status_code": 100,
  • "status_text": "string",
  • "details": {
    }
}

Get a single request from a request bin

Get a single request from a request bin identified by the bin id anf the reuest id

path Parameters
binId
required
string <uuid> (Uuid) ^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{...

The bin id

requestId
required
integer (PositiveInteger) >= 1

The request

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "datetime": "2019-08-24T14:15:22Z",
  • "ip": "192.168.0.1",
  • "ips": [
    ],
  • "protocol": "http",
  • "secure": true,
  • "method": "GET",
  • "uri": "http://example.com",
  • "path": "string",
  • "hostname": "string",
  • "headers": [
    ],
  • "raw_body": "string",
  • "parsed_body": { },
  • "query": { }
}

Delete a single request from a request bin

Delete a single request from a request bin identified by the bin id anf the reuest id

path Parameters
binId
required
string <uuid> (Uuid) ^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{...

The bin id

requestId
required
integer (PositiveInteger) >= 1

The request

Responses

Response samples

Content type
application/json
{
  • "status_code": 100,
  • "status_text": "string",
  • "details": {
    }
}