Key and Secret Manager

All operations require authentication.

3 operationsv2/okms/resource

List OKMS servicesProduction

GET

/v2/okms/resource

Returns the OKMS services of the account, with their region, KMIP and REST endpoints, and counts of keys, secrets and KMIP objects.

Query parameters

iamTags

object

Filter resources on IAM tags

Headers

X-Pagination-Cursor

string

Pagination cursor

X-Pagination-Size

integer

Pagination size

Response

200ResponseWithIAM[]successful operation

iam

read-only

ResourceMetadata

IAM resource metadata

read-only

stringuuid

Unique identifier of the OKMS

kmipEndpoint

read-only

string

KMS kmip API endpoint

kmipObjectCount

read-only

integer

Number of KMIP objects (non destroyed)

kmipRsaEndpoint

read-only

string

KMS kmip RSA API endpoint

pciDssEnabled

read-only

boolean

Whether PCI-DSS compliance is enabled on the service

pciDssEnabledAt

read-only

stringdate-time

Tells when PCI-DSS compliance was enabled

publicCA

read-only

string

KMS public CA (Certificate Authority)

publicRsaCA

read-only

string

KMS public RSA CA (Certificate Authority)

region

read-only

RegionEnum

Region the key management service runs in, which is where your keys and secrets are stored

Valuesap-south-mumap-southeast-sgpap-southeast-sydca-east-bhsca-east-toreu-central-waweu-south-mileu-west-erieu-west-graeu-west-limeu-west-pareu-west-rbxeu-west-sbg

restEndpoint

read-only

string

KMS rest API endpoint

secretCount

read-only

integer

Number of secrets

secretVersionCount

read-only

integer

Number of secret versions

serviceKeyCount

read-only

integer

Number of service keys

serviceKeyCountDetails

read-only

ServiceKeyCountDetails

Number of service keys per protection level

swaggerEndpoint

read-only

string

KMS rest API swagger UI

Reads your token from $OVH_TOKEN

$ curl https://api.eu.ovhcloud.com/v2/okms/resource \
  -H "authorization: Bearer $OVH_TOKEN"

ResponseExample

1[2  {3    "iam": {4      "displayName": "string",5      "id": "00000000-0000-0000-0000-000000000000",6      "state": "EXPIRED",7      "tags": {8        "key": "string"9      },10      "urn": "string"11    },12    "id": "00000000-0000-0000-0000-000000000000",13    "kmipEndpoint": "string",14    "kmipObjectCount": 0,15    "kmipRsaEndpoint": "string",16    "pciDssEnabled": true,17    "pciDssEnabledAt": "2024-01-01T12:00:00Z",18    "publicCA": "string",19    "publicRsaCA": "string",20    "region": "ap-south-mum",21    "restEndpoint": "string",22    "secretCount": 0,23    "secretVersionCount": 0,24    "serviceKeyCount": 0,25    "serviceKeyCountDetails": {26      "hsm": 0,27      "software": 028    },29    "swaggerEndpoint": "string"30  }31]

Get an OKMS serviceProduction

GET

/v2/okms/resource/{okmsId}

Returns the OKMS service with its endpoints and resource counts. Set publicCA to true to include the KMS public CA certificate.

Path parameters

okmsId

required

stringuuid

Okms ID

Query parameters

publicCA

boolean

Add KMS public CA (Certificate Authority) in the output

Response

200ResponseWithIAMsuccessful operation

iam

read-only

ResourceMetadata

IAM resource metadata

read-only

stringuuid

Unique identifier of the OKMS

kmipEndpoint

read-only

string

KMS kmip API endpoint

kmipObjectCount

read-only

integer

Number of KMIP objects (non destroyed)

kmipRsaEndpoint

read-only

string

KMS kmip RSA API endpoint

pciDssEnabled

read-only

boolean

Whether PCI-DSS compliance is enabled on the service

pciDssEnabledAt

read-only

stringdate-time

Tells when PCI-DSS compliance was enabled

publicCA

read-only

string

KMS public CA (Certificate Authority)

publicRsaCA

read-only

string

KMS public RSA CA (Certificate Authority)

region

read-only

RegionEnum

Region the key management service runs in, which is where your keys and secrets are stored

Valuesap-south-mumap-southeast-sgpap-southeast-sydca-east-bhsca-east-toreu-central-waweu-south-mileu-west-erieu-west-graeu-west-limeu-west-pareu-west-rbxeu-west-sbg

restEndpoint

read-only

string

KMS rest API endpoint

secretCount

read-only

integer

Number of secrets

secretVersionCount

read-only

integer

Number of secret versions

serviceKeyCount

read-only

integer

Number of service keys

serviceKeyCountDetails

read-only

ServiceKeyCountDetails

Number of service keys per protection level

swaggerEndpoint

read-only

string

KMS rest API swagger UI

Example uses okmsId = 00000000-0000-0000-0000-000000000000

$ curl https://api.eu.ovhcloud.com/v2/okms/resource/{okmsId} \
  -H "authorization: Bearer $OVH_TOKEN"

ResponseExample

1{2  "iam": {3    "displayName": "string",4    "id": "00000000-0000-0000-0000-000000000000",5    "state": "EXPIRED",6    "tags": {7      "key": "string"8    },9    "urn": "string"10  },11  "id": "00000000-0000-0000-0000-000000000000",12  "kmipEndpoint": "string",13  "kmipObjectCount": 0,14  "kmipRsaEndpoint": "string",15  "pciDssEnabled": true,16  "pciDssEnabledAt": "2024-01-01T12:00:00Z",17  "publicCA": "string",18  "publicRsaCA": "string",19  "region": "ap-south-mum",20  "restEndpoint": "string",21  "secretCount": 0,22  "secretVersionCount": 0,23  "serviceKeyCount": 0,24  "serviceKeyCountDetails": {25    "hsm": 0,26    "software": 027  },28  "swaggerEndpoint": "string"29}

Update an OKMS serviceProduction

PUT

/v2/okms/resource/{okmsId}

Enables or disables PCI-DSS enforcement on the service.

Path parameters

okmsId

required

stringuuid

Okms ID

Request body (required)

pciDssEnabled

boolean

Enable or disable PCI-DSS compliance

Response

200Responsesuccessful operation

read-only

stringuuid

Unique identifier of the OKMS

kmipEndpoint

read-only

string

KMS kmip API endpoint

kmipObjectCount

read-only

integer

Number of KMIP objects (non destroyed)

kmipRsaEndpoint

read-only

string

KMS kmip RSA API endpoint

pciDssEnabled

read-only

boolean

Whether PCI-DSS compliance is enabled on the service

pciDssEnabledAt

read-only

stringdate-time

Tells when PCI-DSS compliance was enabled

publicCA

read-only

string

KMS public CA (Certificate Authority)

publicRsaCA

read-only

string

KMS public RSA CA (Certificate Authority)

region

read-only

RegionEnum

Region the key management service runs in, which is where your keys and secrets are stored

Valuesap-south-mumap-southeast-sgpap-southeast-sydca-east-bhsca-east-toreu-central-waweu-south-mileu-west-erieu-west-graeu-west-limeu-west-pareu-west-rbxeu-west-sbg

restEndpoint

read-only

string

KMS rest API endpoint

secretCount

read-only

integer

Number of secrets

secretVersionCount

read-only

integer

Number of secret versions

serviceKeyCount

read-only

integer

Number of service keys

serviceKeyCountDetails

read-only

ServiceKeyCountDetails

Number of service keys per protection level

swaggerEndpoint

read-only

string

KMS rest API swagger UI

Example uses okmsId = 00000000-0000-0000-0000-000000000000

$ curl https://api.eu.ovhcloud.com/v2/okms/resource/{okmsId} \
  -H "authorization: Bearer $OVH_TOKEN"

ResponseExample

1{2  "id": "00000000-0000-0000-0000-000000000000",3  "kmipEndpoint": "string",4  "kmipObjectCount": 0,5  "kmipRsaEndpoint": "string",6  "pciDssEnabled": true,7  "pciDssEnabledAt": "2024-01-01T12:00:00Z",8  "publicCA": "string",9  "publicRsaCA": "string",10  "region": "ap-south-mum",11  "restEndpoint": "string",12  "secretCount": 0,13  "secretVersionCount": 0,14  "serviceKeyCount": 0,15  "serviceKeyCountDetails": {16    "hsm": 0,17    "software": 018  },19  "swaggerEndpoint": "string"20}