Domain management

Search for domains.

Changed on
get/domains

Request

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

Query parameters

namestring

An optional value to filter domains with based on their short and long names. The value is checked in a case-insensitive manner and using wildcard matching.

Response

Domains retrieved.

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 required

The domain's API key.

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