Configuration

Create a domain parameter.

Changed on
put/configure/domain

Request

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

Request body

keystring required

The unique key used to identify the parameter.

valuestring required

The value to apply for the parameter.

descriptionstring

The parameter's description.

inTestsboolean

Whether the parameter should be exposed to test sessions.

domainstring

The API key identifying the domain of the parameter. This is required if the community API key used for authentication refers to a community that is not linked to a specific domain.

Response

Domain parameter created.

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