API Reference/Tags

Tags

For authentication instructions, see API overview.

Endpoints

get/api/v2/tags

post/api/v2/tags

get/api/v2/tags/:id

put/api/v2/tags/:id

patch/api/v2/tags/:id

delete/api/v2/tags/deleted/:id

get

List all tags

Returns a list of tags. The tags 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/tags

Response

No response schema

post

Create tags

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

Request body

namestring
activeboolean
defaultboolean

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/tags \
	-d 'name="string"' \
	-d 'active="boolean"' \
	-d 'default="boolean"'

Response

No response schema

get

Retrieve tags

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

Path parameters

idstring
ID of the tag

Request

cURL

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

Response

No response schema

put

Update tags

Path parameters

idstring
ID of the tag

Request body

namestring
activeboolean
defaultboolean

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/tags/:id \
	-d 'name="string"' \
	-d 'active="boolean"' \
	-d 'default="boolean"'

Response

No response schema

patch

Update tags soft

Update tags soft by setting the values of the parameters passed. Any parameters not set will be unchanged.

Path parameters

idstring
ID of the tag

Request

cURL

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

Response

No response schema

delete

Delete tags

Path parameters

idstring
ID of the tag

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/tags/deleted/:id

Response

No response schema