Examples in

Request Bins API

The REST API behind Request Bins: create bins and find them by URL, rename, disable and delete them, read the requests they recorded and empty them, and check your plan and usage. Every operation below shows its request in the language picked at the top of the page. Request Bins has no SDK yet, so TypeScript, Python and Go use each language's usual HTTP client.

Calls take an API key for Request Bins, created in your account console. Reading captured requests with a key needs a paid plan; the quickstart walks through a first bin, and the reference covers what a bin URL answers, roles and each plan's limits.

Base URL: https://bins.nimbusnexus.net
Authentication: Authorization: Bearer <API key>
Version: Request Bins 0.1.0 · OpenAPI spec

Before the examples

The examples read your API key from BINS_API_KEY.

Shell

export BINS_API_KEY="<your-api-key>"

Bins

GET/v1/bins

List Bins

The workspace's bins, newest first. url or slug returns at most one, or none.

Parameters

Name	In	Type	Description
limit	query	integer	—
offset	query	integer	—
url	query	string \| null	Only the bin this public URL names.
slug	query	string \| null	Only the bin with this slug.

Responses

200Successful Response
401error.code = unauthorized
403error.code = forbidden
404error.code = not_found
413error.code = payload_too_large
422error.code = validation_error
500error.code = internal_error

Example

curl -X GET "https://bins.nimbusnexus.net/v1/bins" \
  -H "Authorization: Bearer $BINS_API_KEY"

POST/v1/bins

Create Bin

Create a bin. Its URL is answered and recorded at once.

Request body

Field	Type	Description
label	string	—
expires_in_minutes	integer \| null	—

Responses

201Successful Response
401error.code = unauthorized
402error.code = quota_exceeded | workspace_frozen | workspace_suspended
403error.code = forbidden
404error.code = not_found
413error.code = payload_too_large
422error.code = validation_error
500error.code = internal_error

Example

curl -X POST "https://bins.nimbusnexus.net/v1/bins" \
  -H "Authorization: Bearer $BINS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

GET/v1/bins/{bin_id}

Read Bin

Parameters

Name	In	Type	Description
bin_id*	path	string	—

Responses

200Successful Response
401error.code = unauthorized
403error.code = forbidden
404error.code = not_found
413error.code = payload_too_large
422error.code = validation_error
500error.code = internal_error

Example

curl -X GET "https://bins.nimbusnexus.net/v1/bins/<bin_id>" \
  -H "Authorization: Bearer $BINS_API_KEY"

PATCH/v1/bins/{bin_id}

Patch Bin

Rename a bin, or switch it off (disabled: it answers and records nothing) and on.

Parameters

Name	In	Type	Description
bin_id*	path	string	—

Request body

Field	Type	Description
label	string \| null	—
status	"active" \| "disabled" \| null	—

Responses

200Successful Response
401error.code = unauthorized
402error.code = workspace_frozen | workspace_suspended
403error.code = forbidden
404error.code = not_found
413error.code = payload_too_large
422error.code = validation_error
500error.code = internal_error

Example

curl -X PATCH "https://bins.nimbusnexus.net/v1/bins/<bin_id>" \
  -H "Authorization: Bearer $BINS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

DELETE/v1/bins/{bin_id}

Delete Bin

Delete a bin: its URL stops recording at once, its slug is never issued again, and its captured requests are removed shortly after.

Parameters

Name	In	Type	Description
bin_id*	path	string	—

Responses

204Successful Response
401error.code = unauthorized
403error.code = forbidden
404error.code = not_found
413error.code = payload_too_large
422error.code = validation_error
500error.code = internal_error

Example

curl -X DELETE "https://bins.nimbusnexus.net/v1/bins/<bin_id>" \
  -H "Authorization: Bearer $BINS_API_KEY"

Captured requests

GET/v1/bins/{bin_id}/requests

List Requests

A bin's captured requests, newest first. Poll with since set to the newest received_at already seen; walk back with until.

Parameters

Name	In	Type	Description
bin_id*	path	string	—
since	query	string \| null	Only requests received after this instant (strict).
until	query	string \| null	Only requests received at or before this instant.
limit	query	integer	—
offset	query	integer	—

Responses

200Successful Response
401error.code = unauthorized
402error.code = not_entitled
403error.code = forbidden
404error.code = not_found
413error.code = payload_too_large
422error.code = validation_error
500error.code = internal_error

Example

curl -X GET "https://bins.nimbusnexus.net/v1/bins/<bin_id>/requests" \
  -H "Authorization: Bearer $BINS_API_KEY"

DELETE/v1/bins/{bin_id}/requests

Empty Bin

Delete every captured request in a bin. The bin keeps its URL and keeps recording.

Parameters

Name	In	Type	Description
bin_id*	path	string	—

Responses

200Successful Response
401error.code = unauthorized
403error.code = forbidden
404error.code = not_found
413error.code = payload_too_large
422error.code = validation_error
500error.code = internal_error

Example

curl -X DELETE "https://bins.nimbusnexus.net/v1/bins/<bin_id>/requests" \
  -H "Authorization: Bearer $BINS_API_KEY"

GET/v1/requests/{request_id}

Read Request

One captured request in full: headers in arrival order, the query, and the body.

Parameters

Name	In	Type	Description
request_id*	path	string	—

Responses

200Successful Response
401error.code = unauthorized
402error.code = not_entitled
403error.code = forbidden
404error.code = not_found
413error.code = payload_too_large
422error.code = validation_error
500error.code = internal_error

Example

curl -X GET "https://bins.nimbusnexus.net/v1/requests/<request_id>" \
  -H "Authorization: Bearer $BINS_API_KEY"

Plan and usage

GET/v1/plan

Read Plan

Responses

200Successful Response
401error.code = unauthorized
403error.code = forbidden
404error.code = not_found
413error.code = payload_too_large
422error.code = validation_error
500error.code = internal_error

Example

curl -X GET "https://bins.nimbusnexus.net/v1/plan" \
  -H "Authorization: Bearer $BINS_API_KEY"

GET/v1/usage

Read Usage

Responses

200Successful Response
401error.code = unauthorized
403error.code = forbidden
404error.code = not_found
413error.code = payload_too_large
422error.code = validation_error
500error.code = internal_error

Example

curl -X GET "https://bins.nimbusnexus.net/v1/usage" \
  -H "Authorization: Bearer $BINS_API_KEY"

Edit this page on GitHub