Configuration

Update a test service.

Changed on
post/configure/service

Request

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

Request body

keystring required

The unique key used to identify the service and its underlying domain parameter.

addressstring

The new address to apply for the service. Skip this if no update should be made.

descriptionstring

The service's description. Skip this if no update should be made.

serviceType'messaging' | 'validation' | 'processing'

The type of the service. Skip this if no update should be made.

apiType'soap' | 'rest'

The API type of the service. Skip this if no update should be made.

authBasicUsernamestring

When HTTP basic authentication is used, this is the username to use. Skip this if no update should be made or set with an empty string to delete all basic authentication information.

authBasicPasswordstring

When HTTP basic authentication is used, this is the password to use. Skip this if no update should be made.

authTokenUsernamestring

When the WS-Security UsernameToken profile is used, this is the username to use. Skip this if no update should be made or set with an empty string to delete all token authentication information.

authTokenPasswordstring

When the WS-Security UsernameToken profile is used, this is the password to use. Skip this if no update should be made.

authTokenPasswordType'digest' | 'text'

When the WS-Security UsernameToken profile is used, this is the type of password provision to use. Skip this if no update should be made.

authHttpHeaderNamestring

When authentication via HTTP header is used, this is the name of the header. Skip this if no update should be made or set with an empty string to delete all header-based authentication information.

authHttpHeaderValuestring

When authentication via HTTP header is used, this is the value of the header to use. Skip this if no update should be made.

identifierstring

The service's reference identifier. Skip this if no update should be made or set with an empty string to delete the existing value.

versionstring

The service's version. Skip this if no update should be made or set with an empty string to delete the existing value.

domainstring

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

Response

Test service updated.

Changes

  • 26fb91f21fa6Revision changes
    • info

      added the new optional request property

    • info

      added the new optional request property

    • 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
    • warning

      removed the request property

    • warning

      removed the request property

    • 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