Sign in
Custom domain

Update a custom domain

Updates a custom domain assigned to a scope.

patch/scope_domain/{id}

Path parameters

idstring required

The unique ID for the custom domain.

Request body

namestring required

The name of the custom domain to update.

status'pending_approval' | 'pending_hook' | 'pending_approval_denied' | 'pending' | 'creating' | 'recreating' | 'active' | 'updating' | 'updating_approval' | 'deleting' | 'deleted' | 'failed' | 'stopping' | 'stopped' | 'cancelled'

The status of the scope.

Example request

{
  "name": "api.crypto-inc.com",
  "status": "active"
}

Response

The operation was successful.

idstring required

The application-wide unique ID for the custom domain.

namestring required

The name of the custom domain.

typestring required

The type of the domain.

status'active' | 'pending'

The status of the domain.

created_atstring date-time

The ISO-8601 UTC timestamp of when the custom domain was created.

updated_atstring date-time

The ISO-8601 UTC timestamp of when the custom domain was last updated.

Example response

{
  "id": "e78a0d21-3c48-7421-81cd-203fe84b8e47",
  "name": "api.crypto-inc.com",
  "type": "scope",
  "selector": {
    "organization_id": "1",
    "nrn": "organization=1:account=2:namespace=3:application=4",
    "scope_id": "1234"
  },
  "status": "active",
  "created_at": "2025-01-02T00:00:00Z",
  "updated_at": "2025-02-02T00:00:00Z"
}

Changes