Recent searches

in
Developer ReferenceAPI

Site DAMs

On this page

Get Site DAM details

GET/api/v0/site-dams/{site_dam_uuid}
Path parameters:
site_dam_uuidUUIDRequired#
Example request:
Bash
Copied to clipboard
curl https://app.cloudcannon.com/api/v0/site-dams/{site_dam_uuid} \
  -H "X-API-KEY: <your-api-key>"
Terminal
Responses:
200OK
JSON
Copied to clipboard
{
  "uuid": "string",
  "id": 0,
  "site_id": 0,
  "dam_uuid": "string",
  "config": {},
  "created_at": "2024-01-01T00:00:00Z",
  "updated_at": "2024-01-01T00:00:00Z",
  "uploads_locked": true,
  "reference_key": "string",
  "site_uuid": "00000000-0000-0000-0000-000000000000",
  "dam": {
    "uuid": "00000000-0000-0000-0000-000000000000",
    "id": 0,
    "access_key": "string",
    "base_url": "string",
    "created_at": "2024-01-01T00:00:00Z",
    "dam_type": "string",
    "name": "string",
    "updated_at": "2024-01-01T00:00:00Z",
    "max_upload_size": 0,
    "organisation_uuid": "00000000-0000-0000-0000-000000000000",
    "config": {},
    "extra_params": "string"
  }
}
Response
403Forbidden
JSON
Copied to clipboard
{
  "error": "string"
}
Response

Update site dam details

PUT/api/v0/site-dams/{site_dam_uuid}
Path parameters:
site_dam_uuidUUIDRequired#
Request body:
dam_uuidstring#
uploads_lockedboolean#
configobjectNullable#
reference_keystringNullable#
Example request:
Bash
Copied to clipboard
curl https://app.cloudcannon.com/api/v0/site-dams/{site_dam_uuid} \
  -X PUT \
  -H "X-API-KEY: <your-api-key>" \
  -H "Content-Type: application/json" \
  -d '{
    "dam_uuid": "string",
    "uploads_locked": true,
    "config": {},
    "reference_key": "string"
  }'
Terminal
Responses:
200OK
JSON
Copied to clipboard
{
  "uuid": "string",
  "id": 0,
  "site_id": 0,
  "dam_uuid": "string",
  "config": {},
  "created_at": "2024-01-01T00:00:00Z",
  "updated_at": "2024-01-01T00:00:00Z",
  "uploads_locked": true,
  "reference_key": "string",
  "site_uuid": "00000000-0000-0000-0000-000000000000",
  "dam": {
    "uuid": "00000000-0000-0000-0000-000000000000",
    "id": 0,
    "access_key": "string",
    "base_url": "string",
    "created_at": "2024-01-01T00:00:00Z",
    "dam_type": "string",
    "name": "string",
    "updated_at": "2024-01-01T00:00:00Z",
    "max_upload_size": 0,
    "organisation_uuid": "00000000-0000-0000-0000-000000000000",
    "config": {},
    "extra_params": "string"
  }
}
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 Site DAM

DELETE/api/v0/site-dams/{site_dam_uuid}
Path parameters:
site_dam_uuidUUIDRequired#
Example request:
Bash
Copied to clipboard
curl https://app.cloudcannon.com/api/v0/site-dams/{site_dam_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
Open in a new tab