Domain management

Create a domain.

Changed on
put/domain

Request

  • Base URL: ${apiUrl} (relative, and the document was published on a file host, not at the API’s origin)
  • URL: ${apiUrl}/domain
  • Auth: API key in header ITB_API_KEY

Request body

shortNamestring required

The domain's short name.

fullNamestring required

The domain's full name.

descriptionstring

The domain's description.

reportMetadatastring

The domain's additional metadata for XML reports.

apiKeystring

The API key to set for the domain. If this key is already assigned, a new one will be generated.

Response

Domain created.

apiKeystring required

The API key value.

Changes

  • 26fb91f21fa6Revision changes
    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

  • 433b3c0ae6d4Revision changes
    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status