---
title: Deployment
description: The PingOne /environments/{{envID}}/apiServers/{{apiServerID}}/deployment endpoint provides operations to read and deploy an API service resource.
component: pingone-api
page_id: pingone-api:authorize:api-access-management/api-services/deployment
canonical_url: https://developer.pingidentity.com/pingone-api/authorize/api-access-management/api-services/deployment.html
section_ids:
  api-service-deployment-data-model: API service deployment data model
  service-deployment-status-codes: API service deployment codes
---

# Deployment

The PingOne `/environments/{{envID}}/apiServers/{{apiServerID}}/deployment` endpoint provides operations to read and deploy an API service resource.

To create, modify, or delete an API service resource, refer to [API services](../api-services.html).

## API service deployment data model

| Property                       | Type?   | Required? | Mutable?  | Description                                                                                                                                                         |
| ------------------------------ | ------- | --------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `accessControl.custom`         | Object  | Optional  | Mutable   | Defines if the operation will use custom policy rather than the "Group" or "Scope" `accessControl` requirement.                                                     |
| `accessControl.custom.enabled` | Boolean | Optional  | Mutable   | If `TRUE`, custom policy will be used for the endpoint. Defaults to `FALSE`.                                                                                        |
| `authorizationVersion.id`      | String  | Optional  | Read-only | The UUID of the last deployed policy authorization version. This is present only if custom polcies are enabled and the API service has been deployed at least once. |
| `decisionEndpoint.id`          | String  | Required  | Read-only | The UUID of the decision endpoint.                                                                                                                                  |
| `deployedAt`                   | Date    | Optional  | Read-only | The time of most recent successful deployment. Null if the API service has never been successfully deployed.                                                        |
| `policy.id`                    | String  | Optional  | Read-only | The ID of the root policy.                                                                                                                                          |
| `status.code`                  | String  | Required  | Read-only | The deployment status code. For possible values, refer to [Deployment status codes](#service-deployment-status-codes).                                              |
| `status.error`                 | Object  | Optional  | Read-only | Error details returned if the last deployment request failed.                                                                                                       |
| `status.error.id`              | String  | Required  | Read-only | A unique identifier for the error.                                                                                                                                  |
| `status.error.code`            | String  | Required  | Read-only | A general fault code that identifies the the type of error. Refer to [Error codes](../../../platform/reference/error-codes.html).                                   |
| `status.error.message`         | String  | Required  | Read-only | A short human-readable description of the error.                                                                                                                    |

## API service deployment codes

| Status code                            | Description                                                                |
| -------------------------------------- | -------------------------------------------------------------------------- |
| `POLICIES_CREATE_IN_PROGRESS`          | The policy bundle for the API service's managed policies is being created. |
| `DECISION_ENDPOINT_CREATE_IN_PROGRESS` | A decision endpoint is being created for the API service.                  |
| `DECISION_ENDPOINT_UPDATE_IN_PROGRESS` | The API service's decision endpoint is being updated.                      |
| `DEPLOYMENT_SUCCESSFUL`                | The API service's policies have been successfully deployed.                |
| `DEPLOYMENT_FAILED`                    | HAP-MGMT was unable to deploy the API service's policies.                  |
| `DEPLOYMENT_UNINITIALIZED`             | A deployment has not yet been attempted.                                   |