PApax8
Provision Results

Create Provision Result

post/provision-requests/{provisionRequestId}/results

Request

  • Base URL
    https://api.pax8.com/v2
  • URL
    https://api.pax8.com/v2/provision-requests/{provisionRequestId}/results
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://api.pax8.com/v1/token

Path parameters

provisionRequestIdstring uuid required

Request body

idstring uuid
provisionAttemptIdstring uuid
status'Success' | 'Fail' required

The status of the provision result. Must be either Success or Fail. If Fail an errorMessage should be present.

errorMessagestring

When the status is Fail, the errorMessage field should contain relevant error information that a person can understand and action. The errorMessage input is truncated to 500 characters.

metadataobject
externalProvisionerSubscriptionIdstring

Cannot be empty and must only contain alphanumeric values, hyphens and underscores.

externalProvisionerPartnerIdstring

Cannot be empty and must only contain alphanumeric values, hyphens and underscores.

externalProvisionerCompanyIdstring

Cannot be empty and must only contain alphanumeric values, hyphens and underscores.

externalProvisionerPartnerEnrollmentIdstring

Cannot be empty and must only contain alphanumeric values, hyphens and underscores.

Example request

{
  "errorMessage": "Unable to provision the subscription because the provided email domain is already in use."
}

Response

OK

idstring uuid
provisionAttemptIdstring uuid
status'Success' | 'Fail' required

The status of the provision result. Must be either Success or Fail. If Fail an errorMessage should be present.

errorMessagestring

When the status is Fail, the errorMessage field should contain relevant error information that a person can understand and action. The errorMessage input is truncated to 500 characters.

metadataobject
externalProvisionerSubscriptionIdstring

Cannot be empty and must only contain alphanumeric values, hyphens and underscores.

externalProvisionerPartnerIdstring

Cannot be empty and must only contain alphanumeric values, hyphens and underscores.

externalProvisionerCompanyIdstring

Cannot be empty and must only contain alphanumeric values, hyphens and underscores.

externalProvisionerPartnerEnrollmentIdstring

Cannot be empty and must only contain alphanumeric values, hyphens and underscores.

Example response

{
  "errorMessage": "Unable to provision the subscription because the provided email domain is already in use."
}

Changes

No recorded changes to this operation across all 1 revision of this API.