Recent searches

in
Developer ReferenceAPI

Inbox Targets

On this page

Get Inbox Target Details

GET/api/v0/inbox-targets/{inbox_target_uuid}
Path parameters:
inbox_target_uuidUUIDRequired#
Example request:
Bash
Copied to clipboard
curl https://app.cloudcannon.com/api/v0/inbox-targets/{inbox_target_uuid} \
  -H "X-API-KEY: <your-api-key>"
Terminal
Responses:
200OK
JSON
Copied to clipboard
{
  "uuid": "00000000-0000-0000-0000-000000000000",
  "id": 0,
  "target_type": "string",
  "target": "string",
  "validated": true,
  "config": {},
  "inbox_uuid": "00000000-0000-0000-0000-000000000000",
  "created_at": "2024-01-01T00:00:00Z",
  "updated_at": "2024-01-01T00:00:00Z"
}
Response
403Forbidden
JSON
Copied to clipboard
{
  "error": "string"
}
Response

Update inbox target config

PUT/api/v0/inbox-targets/{inbox_target_uuid}
Path parameters:
inbox_target_uuidUUIDRequired#
Request body:
configobject#
Example request:
Bash
Copied to clipboard
curl https://app.cloudcannon.com/api/v0/inbox-targets/{inbox_target_uuid} \
  -X PUT \
  -H "X-API-KEY: <your-api-key>" \
  -H "Content-Type: application/json" \
  -d '{
    "config": {}
  }'
Terminal
Responses:
200OK
JSON
Copied to clipboard
{
  "uuid": "00000000-0000-0000-0000-000000000000",
  "id": 0,
  "target_type": "string",
  "target": "string",
  "validated": true,
  "config": {},
  "inbox_uuid": "00000000-0000-0000-0000-000000000000",
  "created_at": "2024-01-01T00:00:00Z",
  "updated_at": "2024-01-01T00:00:00Z"
}
Response
401Unauthorized
JSON
Copied to clipboard
{
  "error": "string"
}
Response
403Forbidden
JSON
Copied to clipboard
{
  "error": "string"
}
Response
422Unprocessable
JSON
Copied to clipboard
{
  "errors": {}
}
Response

Delete Inbox Target

DELETE/api/v0/inbox-targets/{inbox_target_uuid}
Path parameters:
inbox_target_uuidUUIDRequired#
Example request:
Bash
Copied to clipboard
curl https://app.cloudcannon.com/api/v0/inbox-targets/{inbox_target_uuid} \
  -X DELETE \
  -H "X-API-KEY: <your-api-key>"
Terminal
Responses:
204Deleted
401Unauthorized
JSON
Copied to clipboard
{
  "error": "string"
}
Response
403Forbidden
JSON
Copied to clipboard
{
  "error": "string"
}
Response

Restart validation process for target

POST/api/v0/inbox-targets/{inbox_target_uuid}/revalidate
Path parameters:
inbox_target_uuidUUIDRequired#
Example request:
Bash
Copied to clipboard
curl https://app.cloudcannon.com/api/v0/inbox-targets/{inbox_target_uuid}/revalidate \
  -X POST \
  -H "X-API-KEY: <your-api-key>"
Terminal
Responses:
200OK
JSON
Copied to clipboard
{
  "uuid": "00000000-0000-0000-0000-000000000000",
  "id": 0,
  "target_type": "string",
  "target": "string",
  "validated": true,
  "config": {},
  "inbox_uuid": "00000000-0000-0000-0000-000000000000",
  "created_at": "2024-01-01T00:00:00Z",
  "updated_at": "2024-01-01T00:00:00Z"
}
Response
403Forbidden
JSON
Copied to clipboard
{
  "error": "string"
}
Response
Open in a new tab