Health check

GET

/api/v1/health

const url = 'https://files.centralcodestation.com/api/v1/health';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://files.centralcodestation.com/api/v1/health

Liveness and the adapters in use. Also served at /health without the API prefix.

API conventions

Responses

200

Success.

application/json

object

status

required

string

service

required

string

version

required

string

object_store

required

The object store adapter.

string

content_delivery

required

The content delivery adapter.

string

processing_queue

required

string

search_provider

required

string

time

required

string format: date-time

Example

{
  "status": "ok",
  "service": "ccs-files",
  "object_store": "standard",
  "content_delivery": "standard",
  "processing_queue": "standard",
  "search_provider": "standard"
}

default

Error: see error for the code.

application/json

object

status_code

required

number

error

required

Stable snake_case error code.

string

Allowed values: invalid_request invalid_cursor invalid_limit invalid_json invalid_name depth_exceeded invalid_move role_locked invalid_redirect_uri invalid_id_token webhook_url_not_allowed invalid_grant invalid_token share_password_required insufficient_scope not_tenant_member no_application_access tenant_not_available client_context_mismatch principal_not_allowed files_access_not_granted missing_capability missing_action platform_admin_required tenant_suspended partial_permission cannot_grant_more_than_held tenant_owner_required folder_managed share_password_invalid not_found application_not_found role_not_found file_not_found folder_not_found upload_not_found version_not_found share_not_found entry_not_found rendition_not_available job_not_found taxonomy_not_found upload_expired upload_not_open name_conflict scan_pending file_quarantined file_trashed file_pending file_locked file_on_hold status_locked version_is_current folder_busy idempotency_key_reused share_gone share_limit_reached revision_mismatch file_too_large quota_exceeded payload_too_large upload_incomplete size_mismatch hash_mismatch type_not_allowed not_previewable too_many_entries too_many_file_ids too_many_scopes too_many_applications taxonomy_value_invalid public_visibility_disabled share_links_disabled webhook_unreachable rate_limited server_error not_implemented identity_unavailable storage_unavailable notifications_unavailable storage_account_not_found storage_migration_not_found storage_account_in_use storage_account_not_verified storage_migration_in_progress storage_account_verification_failed storage_adapter_not_allowed

message

required

One of:

string
Array<string>

string

path

required

string

timestamp

required

string format: date-time

Example

{
  "status_code": 403,
  "error": "invalid_request",
  "message": "This client is not bound to this tenant/application",
  "path": "/api/v1/tenants/t1/applications/a1/files/01J9Z6S9Q5F5R6Y2W2GZ3B3K4D"
}