Custom domain

Update a custom domain

Changed on

Updates a custom domain assigned to a scope.

patch/scope_domain/{id}

Request

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

Path parameters

idstring required

The unique ID for the custom domain.

Request body

namestring

The name of the custom domain to update. Changing the name sets an active domain back to pending.

status'active' | 'pending'

The status of the custom domain.

Example request

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

Response

The operation was successful. The response has no body.

Changes

    • breaking

      removed the enum value cancelled of the request property

    • breaking

      removed the enum value creating of the request property

    • breaking

      removed the enum value deleted of the request property

    • breaking

      removed the enum value deleting of the request property

    • breaking

      removed the enum value failed of the request property

    • breaking

      removed the enum value pending_approval of the request property

    • breaking

      removed the enum value pending_approval_denied of the request property

    • breaking

      removed the enum value pending_hook of the request property

    • breaking

      removed the enum value recreating of the request property

    • breaking

      removed the enum value stopped of the request property

    • breaking

      removed the enum value stopping of the request property

    • breaking

      removed the enum value updating of the request property

    • breaking

      removed the enum value updating_approval of the request property

    • breaking

      removed the media type application/json for the response with the status

    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for 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

    • breaking

      removed the required property from the response with the status

    • info

      the request property became optional

    • 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

      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