Recent searches

in
Developer ReferenceAPI

Projects

On this page

Get project details

GET/api/v0/projects/{project_uuid}
Path parameters:
project_uuidUUID | integerRequired#
Example request:
Bash
Copied to clipboard
curl https://app.cloudcannon.com/api/v0/projects/{project_uuid} \
  -H "X-API-KEY: <your-api-key>"
Terminal
Responses:
200OK
JSON
Copied to clipboard
{
  "uuid": "00000000-0000-0000-0000-000000000000",
  "id": 0,
  "name": "string",
  "description": "string",
  "git_repository": "string",
  "allow_all_branching": true,
  "prevent_permissions_granted_on_branch": true,
  "main_git_branch": "string",
  "external_url": "string",
  "links": [
    {
      "name": "string",
      "link": "string"
    }
  ],
  "provider": "string",
  "default_destroy_on_publish": true,
  "default_authentication": "string",
  "default_publish_mode": "string",
  "last_synced": "2024-01-01T00:00:00Z",
  "last_compiled": "2024-01-01T00:00:00Z",
  "last_compiled_success": "2024-01-01T00:00:00Z",
  "auto_create_site_on_pr": true,
  "comment_on_pr": true,
  "pr_comment_skip_drafts": true,
  "pr_comment_footer": "string",
  "auto_create_skip_drafts": true,
  "pr_tab_visible": true,
  "publishing_tab_visible": true,
  "branches_tab_visible": true,
  "created_at": "2024-01-01T00:00:00Z",
  "updated_at": "2024-01-01T00:00:00Z",
  "has_default_password": true,
  "organisation_uuid": "00000000-0000-0000-0000-000000000000",
  "main_site": {
    "site_name": "string",
    "subpath": "string",
    "stable_domain": "string",
    "ssg": "string",
    "last_synced": "2024-01-01T00:00:00Z",
    "last_output": "2024-01-01T00:00:00Z",
    "last_compiled": "2024-01-01T00:00:00Z",
    "last_compressed": "2024-01-01T00:00:00Z",
    "last_internationalised": "2024-01-01T00:00:00Z",
    "last_published": "2024-01-01T00:00:00Z",
    "last_cleaned": "2024-01-01T00:00:00Z",
    "storage_provider": "string",
    "client_author_name": "string",
    "client_author_email": "string",
    "create_source": "string",
    "hosting_choice": "string",
    "building_locked": true,
    "editing_locked": true,
    "uploads_locked": true,
    "browsing_locked": true,
    "last_compiled_success": "2024-01-01T00:00:00Z",
    "preview_url": "string",
    "documentation_url": "string",
    "support_url": "string",
    "client_editor_route": "string",
    "active_quest": "string",
    "created_at": "2024-01-01T00:00:00Z",
    "updated_at": "2024-01-01T00:00:00Z",
    "mode": "string",
    "project_id": 0,
    "project_uuid": "string",
    "pr_number": 0,
    "pr_external_url": "string",
    "cloudcannon_config_path": "string",
    "output_storage_provider": "string",
    "base_domain": {
      "uuid": "00000000-0000-0000-0000-000000000000",
      "id": 0,
      "base_domain": "string",
      "uses_dns": true,
      "auto_generate_ssl_failures": 0,
      "auto_generate_ssl_max_failures": 0,
      "next_ssl_generate_attempt_at": "2024-01-01T00:00:00Z",
      "ssl_generation_failing_email_sent_at": "2024-01-01T00:00:00Z",
      "in_cloudflare_beta": true,
      "cloudflare_dns_migrated": true,
      "cloudflare_zone_id": "string",
      "cloudflare_zone_create_error": "string",
      "cloudflare_zone_create_error_from_cloudflare": true,
      "mx_record": "string",
      "spf_record": "string",
      "minimum_tls_version": "string",
      "cloudflare_name_servers": [
        "string"
      ],
      "name_servers": [
        "string"
      ],
      "cloudflare_dns_migration": [
        {}
      ],
      "a_record": [
        {}
      ],
      "cname_record": [
        {}
      ],
      "txt_record": [
        {}
      ]
    }
  }
}
Response
401Unauthorized
JSON
Copied to clipboard
{
  "error": "string"
}
Response
403Forbidden
JSON
Copied to clipboard
{
  "error": "string"
}
Response

Update project details

PUT/api/v0/projects/{project_uuid}
Path parameters:
project_uuidUUID | integerRequired#
Request body:
namestringRequired#
external_urlstringNullable#
descriptionstringNullable#
linksstring#
default_destroy_on_publishboolean#
default_authenticationstringNullable#
default_publish_modestringNullable#
default_passwordstring | boolean#
pr_tab_visibleboolean#
publishing_tab_visibleboolean#
branches_tab_visibleboolean#
Example request:
Bash
Copied to clipboard
curl https://app.cloudcannon.com/api/v0/projects/{project_uuid} \
  -X PUT \
  -H "X-API-KEY: <your-api-key>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "external_url": "string",
    "description": "string",
    "links": "string",
    "default_destroy_on_publish": true,
    "default_authentication": "string",
    "default_publish_mode": "string",
    "default_password": "string",
    "pr_tab_visible": true,
    "publishing_tab_visible": true,
    "branches_tab_visible": true
  }'
Terminal
Responses:
200OK
JSON
Copied to clipboard
{
  "uuid": "00000000-0000-0000-0000-000000000000",
  "id": 0,
  "name": "string",
  "description": "string",
  "git_repository": "string",
  "allow_all_branching": true,
  "prevent_permissions_granted_on_branch": true,
  "main_git_branch": "string",
  "external_url": "string",
  "links": [
    {
      "name": "string",
      "link": "string"
    }
  ],
  "provider": "string",
  "default_destroy_on_publish": true,
  "default_authentication": "string",
  "default_publish_mode": "string",
  "last_synced": "2024-01-01T00:00:00Z",
  "last_compiled": "2024-01-01T00:00:00Z",
  "last_compiled_success": "2024-01-01T00:00:00Z",
  "auto_create_site_on_pr": true,
  "comment_on_pr": true,
  "pr_comment_skip_drafts": true,
  "pr_comment_footer": "string",
  "auto_create_skip_drafts": true,
  "pr_tab_visible": true,
  "publishing_tab_visible": true,
  "branches_tab_visible": true,
  "created_at": "2024-01-01T00:00:00Z",
  "updated_at": "2024-01-01T00:00:00Z",
  "has_default_password": true,
  "organisation_uuid": "00000000-0000-0000-0000-000000000000",
  "main_site": {
    "site_name": "string",
    "subpath": "string",
    "stable_domain": "string",
    "ssg": "string",
    "last_synced": "2024-01-01T00:00:00Z",
    "last_output": "2024-01-01T00:00:00Z",
    "last_compiled": "2024-01-01T00:00:00Z",
    "last_compressed": "2024-01-01T00:00:00Z",
    "last_internationalised": "2024-01-01T00:00:00Z",
    "last_published": "2024-01-01T00:00:00Z",
    "last_cleaned": "2024-01-01T00:00:00Z",
    "storage_provider": "string",
    "client_author_name": "string",
    "client_author_email": "string",
    "create_source": "string",
    "hosting_choice": "string",
    "building_locked": true,
    "editing_locked": true,
    "uploads_locked": true,
    "browsing_locked": true,
    "last_compiled_success": "2024-01-01T00:00:00Z",
    "preview_url": "string",
    "documentation_url": "string",
    "support_url": "string",
    "client_editor_route": "string",
    "active_quest": "string",
    "created_at": "2024-01-01T00:00:00Z",
    "updated_at": "2024-01-01T00:00:00Z",
    "mode": "string",
    "project_id": 0,
    "project_uuid": "string",
    "pr_number": 0,
    "pr_external_url": "string",
    "cloudcannon_config_path": "string",
    "output_storage_provider": "string",
    "base_domain": {
      "uuid": "00000000-0000-0000-0000-000000000000",
      "id": 0,
      "base_domain": "string",
      "uses_dns": true,
      "auto_generate_ssl_failures": 0,
      "auto_generate_ssl_max_failures": 0,
      "next_ssl_generate_attempt_at": "2024-01-01T00:00:00Z",
      "ssl_generation_failing_email_sent_at": "2024-01-01T00:00:00Z",
      "in_cloudflare_beta": true,
      "cloudflare_dns_migrated": true,
      "cloudflare_zone_id": "string",
      "cloudflare_zone_create_error": "string",
      "cloudflare_zone_create_error_from_cloudflare": true,
      "mx_record": "string",
      "spf_record": "string",
      "minimum_tls_version": "string",
      "cloudflare_name_servers": [
        "string"
      ],
      "name_servers": [
        "string"
      ],
      "cloudflare_dns_migration": [
        {}
      ],
      "a_record": [
        {}
      ],
      "cname_record": [
        {}
      ],
      "txt_record": [
        {}
      ]
    }
  }
}
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 project

DELETE/api/v0/projects/{project_uuid}
Path parameters:
project_uuidUUID | integerRequired#
Example request:
Bash
Copied to clipboard
curl https://app.cloudcannon.com/api/v0/projects/{project_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

List branches for the project repository

GET/api/v0/projects/{project_uuid}/branches
Path parameters:
project_uuidUUID | integerRequired#
Example request:
Bash
Copied to clipboard
curl https://app.cloudcannon.com/api/v0/projects/{project_uuid}/branches \
  -H "X-API-KEY: <your-api-key>"
Terminal
Responses:
200OK
JSON
Copied to clipboard
[
  {
    "name": "string",
    "sha": "string",
    "updated_at": "2024-01-01T00:00:00Z",
    "sites": [
      {
        "uuid": "string",
        "site_name": "string",
        "stable_domain": "string"
      }
    ],
    "is_default": true,
    "pull_request": {
      "number": 0,
      "title": "string",
      "external_url": "string",
      "state": "string",
      "updated_at": "2024-01-01T00:00:00Z"
    }
  }
]
Response
401Unauthorized
JSON
Copied to clipboard
{
  "error": "string"
}
Response
402FeatureNotOnPlan
JSON
Copied to clipboard
{
  "errors": {}
}
Response
403Forbidden
JSON
Copied to clipboard
{
  "error": "string"
}
Response
404Not Found
JSON
Copied to clipboard
{
  "error": "string"
}
Response
422Unprocessable
JSON
Copied to clipboard
{
  "errors": {}
}
Response

Update project Git details

PUT/api/v0/projects/{project_uuid}/git
Path parameters:
project_uuidUUID | integerRequired#
Request body:
git_repositorystringRequired#
allow_all_branchingboolean#
prevent_permissions_granted_on_branchboolean#
main_git_branchstringNullable#
providerstringRequired#
Example request:
Bash
Copied to clipboard
curl https://app.cloudcannon.com/api/v0/projects/{project_uuid}/git \
  -X PUT \
  -H "X-API-KEY: <your-api-key>" \
  -H "Content-Type: application/json" \
  -d '{
    "git_repository": "string",
    "allow_all_branching": true,
    "prevent_permissions_granted_on_branch": true,
    "main_git_branch": "string",
    "provider": "string"
  }'
Terminal
Responses:
200OK
JSON
Copied to clipboard
{
  "uuid": "00000000-0000-0000-0000-000000000000",
  "id": 0,
  "name": "string",
  "description": "string",
  "git_repository": "string",
  "allow_all_branching": true,
  "prevent_permissions_granted_on_branch": true,
  "main_git_branch": "string",
  "external_url": "string",
  "links": [
    {
      "name": "string",
      "link": "string"
    }
  ],
  "provider": "string",
  "default_destroy_on_publish": true,
  "default_authentication": "string",
  "default_publish_mode": "string",
  "last_synced": "2024-01-01T00:00:00Z",
  "last_compiled": "2024-01-01T00:00:00Z",
  "last_compiled_success": "2024-01-01T00:00:00Z",
  "auto_create_site_on_pr": true,
  "comment_on_pr": true,
  "pr_comment_skip_drafts": true,
  "pr_comment_footer": "string",
  "auto_create_skip_drafts": true,
  "pr_tab_visible": true,
  "publishing_tab_visible": true,
  "branches_tab_visible": true,
  "created_at": "2024-01-01T00:00:00Z",
  "updated_at": "2024-01-01T00:00:00Z",
  "has_default_password": true,
  "organisation_uuid": "00000000-0000-0000-0000-000000000000",
  "main_site": {
    "site_name": "string",
    "subpath": "string",
    "stable_domain": "string",
    "ssg": "string",
    "last_synced": "2024-01-01T00:00:00Z",
    "last_output": "2024-01-01T00:00:00Z",
    "last_compiled": "2024-01-01T00:00:00Z",
    "last_compressed": "2024-01-01T00:00:00Z",
    "last_internationalised": "2024-01-01T00:00:00Z",
    "last_published": "2024-01-01T00:00:00Z",
    "last_cleaned": "2024-01-01T00:00:00Z",
    "storage_provider": "string",
    "client_author_name": "string",
    "client_author_email": "string",
    "create_source": "string",
    "hosting_choice": "string",
    "building_locked": true,
    "editing_locked": true,
    "uploads_locked": true,
    "browsing_locked": true,
    "last_compiled_success": "2024-01-01T00:00:00Z",
    "preview_url": "string",
    "documentation_url": "string",
    "support_url": "string",
    "client_editor_route": "string",
    "active_quest": "string",
    "created_at": "2024-01-01T00:00:00Z",
    "updated_at": "2024-01-01T00:00:00Z",
    "mode": "string",
    "project_id": 0,
    "project_uuid": "string",
    "pr_number": 0,
    "pr_external_url": "string",
    "cloudcannon_config_path": "string",
    "output_storage_provider": "string",
    "base_domain": {
      "uuid": "00000000-0000-0000-0000-000000000000",
      "id": 0,
      "base_domain": "string",
      "uses_dns": true,
      "auto_generate_ssl_failures": 0,
      "auto_generate_ssl_max_failures": 0,
      "next_ssl_generate_attempt_at": "2024-01-01T00:00:00Z",
      "ssl_generation_failing_email_sent_at": "2024-01-01T00:00:00Z",
      "in_cloudflare_beta": true,
      "cloudflare_dns_migrated": true,
      "cloudflare_zone_id": "string",
      "cloudflare_zone_create_error": "string",
      "cloudflare_zone_create_error_from_cloudflare": true,
      "mx_record": "string",
      "spf_record": "string",
      "minimum_tls_version": "string",
      "cloudflare_name_servers": [
        "string"
      ],
      "name_servers": [
        "string"
      ],
      "cloudflare_dns_migration": [
        {}
      ],
      "a_record": [
        {}
      ],
      "cname_record": [
        {}
      ],
      "txt_record": [
        {}
      ]
    }
  }
}
Response
401Unauthorized
JSON
Copied to clipboard
{
  "error": "string"
}
Response
403Forbidden
JSON
Copied to clipboard
{
  "error": "string"
}
Response
422Unprocessable
JSON
Copied to clipboard
{
  "errors": {}
}
Response

List open pull requests for the project repository

GET/api/v0/projects/{project_uuid}/pull-requests
Path parameters:
project_uuidUUID | integerRequired#
Example request:
Bash
Copied to clipboard
curl https://app.cloudcannon.com/api/v0/projects/{project_uuid}/pull-requests \
  -H "X-API-KEY: <your-api-key>"
Terminal
Responses:
200OK
JSON
Copied to clipboard
[
  {
    "number": 0,
    "state": "string",
    "title": "string",
    "body": "string",
    "created_at": "2024-01-01T00:00:00Z",
    "updated_at": "2024-01-01T00:00:00Z",
    "closed_at": "2024-01-01T00:00:00Z",
    "merged_at": "2024-01-01T00:00:00Z",
    "locked": true,
    "draft": true,
    "head": {
      "ref": "string",
      "sha": "string",
      "repo": {
        "name": "string",
        "full_name": "string"
      }
    },
    "base": {
      "ref": "string",
      "sha": "string",
      "repo": {
        "name": "string",
        "full_name": "string"
      }
    },
    "is_external_contributor": true,
    "sites": [
      {
        "uuid": "string",
        "site_name": "string",
        "stable_domain": "string"
      }
    ]
  }
]
Response
401Unauthorized
JSON
Copied to clipboard
{
  "error": "string"
}
Response
402FeatureNotOnPlan
JSON
Copied to clipboard
{
  "errors": {}
}
Response
403Forbidden
JSON
Copied to clipboard
{
  "error": "string"
}
Response
404Not Found
JSON
Copied to clipboard
{
  "error": "string"
}
Response
422Unprocessable
JSON
Copied to clipboard
{
  "errors": {}
}
Response

Refresh deploy-preview PR comments for every site on this project

POST/api/v0/projects/{project_uuid}/refresh-pr-comments
Path parameters:
project_uuidUUID | integerRequired#
Example request:
Bash
Copied to clipboard
curl https://app.cloudcannon.com/api/v0/projects/{project_uuid}/refresh-pr-comments \
  -X POST \
  -H "X-API-KEY: <your-api-key>"
Terminal
Responses:
200OK
JSON
Copied to clipboard
{
  "uuid": "00000000-0000-0000-0000-000000000000",
  "id": 0,
  "name": "string",
  "description": "string",
  "git_repository": "string",
  "allow_all_branching": true,
  "prevent_permissions_granted_on_branch": true,
  "main_git_branch": "string",
  "external_url": "string",
  "links": [
    {
      "name": "string",
      "link": "string"
    }
  ],
  "provider": "string",
  "default_destroy_on_publish": true,
  "default_authentication": "string",
  "default_publish_mode": "string",
  "last_synced": "2024-01-01T00:00:00Z",
  "last_compiled": "2024-01-01T00:00:00Z",
  "last_compiled_success": "2024-01-01T00:00:00Z",
  "auto_create_site_on_pr": true,
  "comment_on_pr": true,
  "pr_comment_skip_drafts": true,
  "pr_comment_footer": "string",
  "auto_create_skip_drafts": true,
  "pr_tab_visible": true,
  "publishing_tab_visible": true,
  "branches_tab_visible": true,
  "created_at": "2024-01-01T00:00:00Z",
  "updated_at": "2024-01-01T00:00:00Z",
  "has_default_password": true,
  "organisation_uuid": "00000000-0000-0000-0000-000000000000",
  "main_site": {
    "site_name": "string",
    "subpath": "string",
    "stable_domain": "string",
    "ssg": "string",
    "last_synced": "2024-01-01T00:00:00Z",
    "last_output": "2024-01-01T00:00:00Z",
    "last_compiled": "2024-01-01T00:00:00Z",
    "last_compressed": "2024-01-01T00:00:00Z",
    "last_internationalised": "2024-01-01T00:00:00Z",
    "last_published": "2024-01-01T00:00:00Z",
    "last_cleaned": "2024-01-01T00:00:00Z",
    "storage_provider": "string",
    "client_author_name": "string",
    "client_author_email": "string",
    "create_source": "string",
    "hosting_choice": "string",
    "building_locked": true,
    "editing_locked": true,
    "uploads_locked": true,
    "browsing_locked": true,
    "last_compiled_success": "2024-01-01T00:00:00Z",
    "preview_url": "string",
    "documentation_url": "string",
    "support_url": "string",
    "client_editor_route": "string",
    "active_quest": "string",
    "created_at": "2024-01-01T00:00:00Z",
    "updated_at": "2024-01-01T00:00:00Z",
    "mode": "string",
    "project_id": 0,
    "project_uuid": "string",
    "pr_number": 0,
    "pr_external_url": "string",
    "cloudcannon_config_path": "string",
    "output_storage_provider": "string",
    "base_domain": {
      "uuid": "00000000-0000-0000-0000-000000000000",
      "id": 0,
      "base_domain": "string",
      "uses_dns": true,
      "auto_generate_ssl_failures": 0,
      "auto_generate_ssl_max_failures": 0,
      "next_ssl_generate_attempt_at": "2024-01-01T00:00:00Z",
      "ssl_generation_failing_email_sent_at": "2024-01-01T00:00:00Z",
      "in_cloudflare_beta": true,
      "cloudflare_dns_migrated": true,
      "cloudflare_zone_id": "string",
      "cloudflare_zone_create_error": "string",
      "cloudflare_zone_create_error_from_cloudflare": true,
      "mx_record": "string",
      "spf_record": "string",
      "minimum_tls_version": "string",
      "cloudflare_name_servers": [
        "string"
      ],
      "name_servers": [
        "string"
      ],
      "cloudflare_dns_migration": [
        {}
      ],
      "a_record": [
        {}
      ],
      "cname_record": [
        {}
      ],
      "txt_record": [
        {}
      ]
    }
  }
}
Response
401Unauthorized
JSON
Copied to clipboard
{
  "error": "string"
}
Response
403Forbidden
JSON
Copied to clipboard
{
  "error": "string"
}
Response

Get sites from projects

GET/api/v0/projects/{project_uuid}/sites
Path parameters:
project_uuidUUID | integerRequired#
Filters:
authenticationstring#
auto_generate_sslboolean#
base_domain_idinteger#
base_domain_uuidstring#
bearer_tokensstring | integer | boolean | string (date-time)#
browsing_lockedboolean#
building_lockedboolean#
cloudflare_errorstring#
cloudflare_hostnamestring | integer | boolean | string (date-time)#
cloudflare_hostname_uuidstring#
compile_errorstring#
compiledstring | integer | boolean | string (date-time)#
created_at_gtstring#
created_at_gtestring#
created_at_ltstring#
created_at_ltestring#
custom_ssl_expiringstring | integer | boolean | string (date-time)#
dam_uuidstring#
domain_namestring#
domain_not_resolvingstring | integer | boolean | string (date-time)#
editing_lockedboolean#
errorstring | integer | boolean | string (date-time)#
failing_formsstring | integer | boolean | string (date-time)#
filesstring#
force_sslboolean#
has_client_passwordstring | integer | boolean | string (date-time)#
has_domain_namestring | integer | boolean | string (date-time)#
has_output_storage_providerstring | integer | boolean | string (date-time)#
has_sourcestring | integer | boolean | string (date-time)#
has_storage_providerstring | integer | boolean | string (date-time)#
has_subpathstring | integer | boolean | string (date-time)#
has_unsaved_changesstring | integer | boolean | string (date-time)#
hosting_choicestring#
idinteger#
inactivestring | integer | boolean | string (date-time)#
inbox_uuidstring#
last_compiledstring#
last_compiled_statusstring | integer | boolean | string (date-time)#
last_compiled_successstring#
last_syncedstring#
latest_hosted_build_idinteger#
localesstring#
needs_cleanboolean#
never_syncedstring | integer | boolean | string (date-time)#
old_includesstring | integer | boolean | string (date-time)#
organisation_idinteger#
organisation_uuidstring#
output_errorstring#
output_storage_providerstring#
owner_lockedstring | integer | boolean | string (date-time)#
owner_trialstring | integer | boolean | string (date-time)#
project_idinteger#
project_uuidstring#
publish_branchstring | integer | boolean | string (date-time)#
repeatablesstring | integer | boolean | string (date-time)#
site_namestring#
site_scannerstring | integer | boolean | string (date-time)#
sourcestring | integer | boolean | string (date-time)#
ssgstring#
ssl_certificatestring | integer | boolean | string (date-time)#
ssl_certificate_expiredstring | integer | boolean | string (date-time)#
ssl_certificate_idinteger#
storage_providerstring#
storage_provider_details_full_namestring | integer | boolean | string (date-time)#
sync_errorstring#
updated_at_gtstring#
updated_at_gtestring#
updated_at_ltstring#
updated_at_ltestring#
uploads_lockedboolean#
use_rbenv_buildsboolean#
uses_i18nboolean#
uuidstring#
searchstring#
Sorting:
sort_attributestring#

Attribute to sort the results by

Defaults to: "id"

Allowed values: id uuid site_name domain_name created_at updated_at last_synced last_compressed last_compiled last_cleaned priority_domain_at storage_provider stable_domain subpath sync_error

sort_directionstring#

Direction to sort the results

Defaults to: "ASC"

Allowed values: ASC DESC

Pagination:
pageinteger#

Page number to fetch (1-indexed)

itemsinteger#

Number of items per page

Example request:
Bash
Copied to clipboard
curl https://app.cloudcannon.com/api/v0/projects/{project_uuid}/sites \
  -H "X-API-KEY: <your-api-key>"
Terminal
Responses:
200OK
JSON
Copied to clipboard
[
  {
    "uuid": "00000000-0000-0000-0000-000000000000",
    "id": 0,
    "site_name": "string",
    "subpath": "string",
    "stable_domain": "string",
    "ssg": "string",
    "last_synced": "2024-01-01T00:00:00Z",
    "last_output": "2024-01-01T00:00:00Z",
    "last_compiled": "2024-01-01T00:00:00Z",
    "last_compressed": "2024-01-01T00:00:00Z",
    "last_internationalised": "2024-01-01T00:00:00Z",
    "last_published": "2024-01-01T00:00:00Z",
    "last_cleaned": "2024-01-01T00:00:00Z",
    "storage_provider": "string",
    "client_author_name": "string",
    "client_author_email": "string",
    "create_source": "string",
    "hosting_choice": "string",
    "building_locked": true,
    "editing_locked": true,
    "uploads_locked": true,
    "browsing_locked": true,
    "last_compiled_success": "2024-01-01T00:00:00Z",
    "preview_url": "string",
    "documentation_url": "string",
    "support_url": "string",
    "client_editor_route": "string",
    "active_quest": "string",
    "created_at": "2024-01-01T00:00:00Z",
    "updated_at": "2024-01-01T00:00:00Z",
    "mode": "string",
    "project_id": 0,
    "project_uuid": "string",
    "pr_number": 0,
    "pr_external_url": "string",
    "cloudcannon_config_path": "string",
    "output_storage_provider": "string",
    "domain_name": "string",
    "site_icon_state": "string",
    "sync_error": "string",
    "output_error": "string",
    "has_open_editing_session": true,
    "storage_provider_details": {},
    "output_storage_provider_data": {},
    "has_site_password": true,
    "has_client_password": true,
    "has_main_source_dam": true,
    "build_configuration": {}
  }
]
Response
401Unauthorized
JSON
Copied to clipboard
{
  "error": "string"
}
Response
403Forbidden
JSON
Copied to clipboard
{
  "error": "string"
}
Response
Open in a new tab