API Reference/Brokers

Brokers

For authentication instructions, see API overview.

Endpoints

get/api/v2/brokers

post/api/v2/brokers

get/api/v2/brokers/:id

put/api/v2/brokers/:id

delete/api/v2/brokers/:id

get

List all brokers

Returns a list of brokers. The brokers are returned in sorted order, with the most recent appearing first.

Query parameters

limitinteger
The number of records to return
pageinteger
The page number
orderstring
The order of the records
sortBystring
The sort of the records
fieldsstring
The filter of the records
pstring
policyFilters
qstring
search query

Request

cURL

export ICLOUDREADY_API_KEY=[your api key]
curl \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://api.icloud-ready.com/api/v2/brokers

Response

No response schema

post

Create broker

Create broker. You need to pass through any required fields, and you can optionally pass through other fields.

Request body

namestring
addressobject
contactsarray

Request

cURL

export ICLOUDREADY_API_KEY=[your api key]
curl -X POST -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://api.icloud-ready.com/api/v2/brokers \
	-d 'name="Broker1"' \
	-d 'address="object"' \
	-d 'contacts="array"'

Response

No response schema

get

Retrieve broker

Returns a single broke, which you can request by passing through an id in the url.

Path parameters

idstring
ID of the broker

Request

cURL

export ICLOUDREADY_API_KEY=[your api key]
curl \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://api.icloud-ready.com/api/v2/brokers/:id

Response

No response schema

put

Update broker

Path parameters

idstring
ID of the broker

Request body

namestring
addressobject
contactsarray

Request

cURL

export ICLOUDREADY_API_KEY=[your api key]
curl -X PUT \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://api.icloud-ready.com/api/v2/brokers/:id \
	-d 'name="Broker1"' \
	-d 'address="object"' \
	-d 'contacts="array"'

Response

No response schema

delete

Delete broker

Path parameters

idstring
ID of the broker

Request

cURL

export ICLOUDREADY_API_KEY=[your api key]
curl -X DELETE \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://api.icloud-ready.com/api/v2/brokers/:id

Response

No response schema