Service API
Version: 1.7.9
API Endpoints
| Request | Description |
|---|---|
| GET /v1/service_instances/usageBillingReport | Returns the usage reports for billing. The usage reports have one line per Service Instance. |
| GET /v1/service_instances/summary | Returns a summary of all the currently active Services. The list is a composition of all the active Services belonging to the Tenant users (or Child Tenant users) with one line per Service Type (plus FIPS / non FIPS). |
| GET /v1/service_instances/usageDetails | Returns usage details of all the Services that existed during the provided period. The list is a composition of all the Services belonging to the Tenant users (or Child Tenant users) with one line per Service Type (FIPS or non FIPS). This endpoint is deprecated and it will be removed from the API by the end of 2023. |
| PUT /v1/service_instances/{id}/bindings | Create a new Service Client bound to the identified Service. |
| GET /v1/service_instances/{id}/bindings/{clientId} | Returns the identified Service Client binding details. |
| GET /v1/service_instances/{id}/bindings | Returns the list of provisioned and bound Service Clients. |
| GET /v1/service_instances/{id} | Return details of the identified Service Instance. |
| GET /v1/service_instances | Returns information about the active Service Instances in your Tenant. |
| POST /v1/service_instances | Create a Service Instance. |
| DELETE /v1/service_instances/{id}/bindings/{clientId} | Delete the identified Client. |
| DELETE /v1/service_instances/{id} | Delete the identified Service Instance. Deleting the Service Instance will invalidate any existing credentials. |
| PUT /v1/services/{id}/client | Bind a new Luna Cloud HSM Client to the targeted Service and download the Client. This API is deprecated and is only used by on Demand and Key Management On Demand Services. Use PUT /service_instances/ |
| POST /v1/services | Provision a new Service. This API is deprecated and is only used by Luna Cloud HSM and Key Management On Demand Services. Use POST /service_instances instead. |
| DELETE /v1/services/{id} | Delete the identified Service. Deleting the Service will invalidate any existing credentials. This API is deprecated and is only used by Luna Cloud HSM and Key Management On Demand Services. Use the DELETE /service_instances/ |
| GET /v1/services/{id}/client/{clientId} | Returns the Client binding details matching the identified Client. This API is deprecated and is only used by Luna Cloud HSM and Key Management On Demand Services. Use the GET /service_instances/ |
| GET /v1/services/{id}/client | Returns the list of provisioned Clients. This API is deprecated and is only used by Luna Cloud HSM and Key Management On Demand Services. Use GET /service_instances/ |
| GET /v1/services/{id} | Returns details of the identified Service. This API is deprecated and is only used by Luna Cloud HSM and Key Management On Demand Services. Use the GET /service_instances/ |
| GET /v1/services | Returns information about the active Services in the Tenant order by creation date (most recent first). This API is deprecated and is only used by Luna Cloud HSM and Key Management On Demand Services. Use the GET /service_instances instead. |
| DELETE /v1/services/{id}/client/{clientId} | Delete the Client matching the identified Client. This API is deprecated and is only used by Luna Cloud HSM and Key Management On Demand Services. Use the DELETE /service_instances/ |
Authorization
OAuth2
For more information about authorization see Getting Started Using the DPoD API.
- Type: OAuth
- Scopes:
- dpod.tenant.spadmin: Service Provider Administrator
- dpod.tenant.admin: Tenant Administrator
- dpod.tenant.appowner: Application Owner
- dpod.tenant.api_appowner: Application Owner API platform credentials
- dpod.tenant.api_service: Service credentials
- dpod.tenant.api_spadmin: Service Provider Administrator API platform credentials