Get an onboarding activation

get https://{hostname}/appsec/v1/onboardings/{onboardingId}/activations/{activationId}

App & API Protector, App & API Protector with the Advanced Security module Returns the status of an activation. Activations can take about 20 minutes. If an activation fails, this API responds with the underlying error status.

Responses

Response body

object

activationId

integer

required

The unique identifier for an activation.

activationStatus

string

required

length ≥ 1

Read-only The status of the activation. When the status is Activation can take about 20 minutes. A value of ACTIVE means activation succeeded and your site is ready for validation. A value of FAILED means the onboarding failed to activate and specific information about the failure is returned in the error response. When PENDING, the activation partially completed and the response shows you what additional steps you need to complete to finish your activation.

PENDING ACTIVE FAILED

activationStatusLink

uri

required

The URL for the operation to request the activation status.

completedDate

date-time

The ISO 8601 timestamp when the activation reaches a steady state and validates across the Akamai network.

createdBy

string

required

length ≥ 1

Read-only The user who created the activation request.

createdDate

date-time

required

Read-only The ISO 8601 timestamp when the activation request was submitted.

network

string

required

length ≥ 1

Specifies the network where you are activating your onboarding, either STAGING, or PRODUCTION.

STAGING PRODUCTION

onboardingLink

string

required

length ≥ 1

The URL to get the onboarding's details.

percentComplete

integer

The percentage of the activation that is complete.

retryAfter

integer

The time remaining, in seconds, until the activation finishes. If your activation fails and you need to try activating again, you won't be able to until this value reaches 0.

`onboardingId` or `activationId` was not found.

Language

Authentication

Remember to add your authentication credentials to run this code.

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://hostname/appsec/v1/onboardings/onboardingId/activations/activationId \
3
     --header 'accept: application/json'


xxxxxxxxxx
10
 
1
{
2
  "activationId": 51,
3
  "activationStatus": "ACTIVE",
4
  "activationStatusLink": "/appsec/v1/onboardings/101/activations/51",
5
  "completedDate": "2014-03-01T21:12:57Z",
6
  "createdBy": "afero",
7
  "createdDate": "2014-03-02T02:22:12Z",
8
  "network": "STAGING",
9
  "onboardingLink": "/appsec/v1/onboardings/101"
10
}

200Onboarding Activation is completed.

202Onboarding activation is in progress.

403Forbidden. You are not authorized to use this API.

404Not found. The onboardingId or activationId was not found.

500Conflict. Onboarding activation failed.

`onboardingId` or `activationId` was not found.