Custom domain

Read a custom domain

Changed on

Read a custom domain assigned to a scope.

get/scope_domain/{id}

Request

  • Base URL
    https://api.nullplatform.com
  • URL
    https://api.nullplatform.com/scope_domain/{id}
  • Auth
    HTTP bearer

Path parameters

idstring uuid required

The unique ID for the custom domain.

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.

nrnstring

The NRN of the scope the custom domain is associated with. Not returned in list responses.

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",
  "nrn": "organization=1:account=2:namespace=3:application=4:scope=1234",
  "selector": {
    "organization_id": 1,
    "nrn": "organization=1:account=2:namespace=3:application=4:scope=1234",
    "scope_id": 1234
  },
  "status": "active",
  "created_at": "2025-01-02T00:00:00Z",
  "updated_at": "2025-02-02T00:00:00Z"
}

Changes

    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • breaking

      the / response's property type changed from string to integer for status

    • breaking

      the / response's property type changed from string to integer for status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • info

      media type application/json was changed to a more specific media type application/problem+json for the response status

    • info

      media type application/json was changed to a more specific media type application/problem+json for the response status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      response property message deprecated

    • info

      response property message deprecated

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status