List Keys

GET 
/projects/:projectId/providers/Aruba.Security/kms/:id/keys

List Keys

Request

Path Parameters

projectId stringrequired
id stringrequired

Query Parameters

filter string
sort string
projection string
offset int32
limit int32
api-version string
The requested API version
Default value: 1

Responses

200

OK

text/plain

Schema

Schema

totalint64
selfstringnullable
prevstringnullable
nextstringnullable
firststringnullable
laststringnullable

values

object[]

Array [

keyIdstringnullable

Kms key id

privateKeyIdstringnullable

Kms Private key id

namestringnullable

Kms key name

algorithmKeyAlgorithms (string)

Possible values: [Aes, Rsa]

creationSourceKeyCreationSource (string)

Possible values: [Cmp, Other]

typeKeyTypes (string)

Possible values: [Symmetric, Asymmetric]

statusKeyStatuses (string)

Possible values: [Active, InCreation, Deleting, Deleted, Failed]

]

Example (from schema)

{
  "total": 0,
  "self": "string",
  "prev": "string",
  "next": "string",
  "first": "string",
  "last": "string",
  "values": [
    {
      "keyId": "string",
      "privateKeyId": "string",
      "name": "string",
      "algorithm": "Aes",
      "creationSource": "Cmp",
      "type": "Symmetric",
      "status": "Active"
    }
  ]
}

application/json

Schema

Schema

totalint64
selfstringnullable
prevstringnullable
nextstringnullable
firststringnullable
laststringnullable

values

object[]

Array [

keyIdstringnullable

Kms key id

privateKeyIdstringnullable

Kms Private key id

namestringnullable

Kms key name

algorithmKeyAlgorithms (string)

Possible values: [Aes, Rsa]

creationSourceKeyCreationSource (string)

Possible values: [Cmp, Other]

typeKeyTypes (string)

Possible values: [Symmetric, Asymmetric]

statusKeyStatuses (string)

Possible values: [Active, InCreation, Deleting, Deleted, Failed]

]

Example (from schema)

{
  "total": 0,
  "self": "string",
  "prev": "string",
  "next": "string",
  "first": "string",
  "last": "string",
  "values": [
    {
      "keyId": "string",
      "privateKeyId": "string",
      "name": "string",
      "algorithm": "Aes",
      "creationSource": "Cmp",
      "type": "Symmetric",
      "status": "Active"
    }
  ]
}

text/json

Schema

Schema

totalint64
selfstringnullable
prevstringnullable
nextstringnullable
firststringnullable
laststringnullable

values

object[]

Array [

keyIdstringnullable

Kms key id

privateKeyIdstringnullable

Kms Private key id

namestringnullable

Kms key name

algorithmKeyAlgorithms (string)

Possible values: [Aes, Rsa]

creationSourceKeyCreationSource (string)

Possible values: [Cmp, Other]

typeKeyTypes (string)

Possible values: [Symmetric, Asymmetric]

statusKeyStatuses (string)

Possible values: [Active, InCreation, Deleting, Deleted, Failed]

]

Example (from schema)

{
  "total": 0,
  "self": "string",
  "prev": "string",
  "next": "string",
  "first": "string",
  "last": "string",
  "values": [
    {
      "keyId": "string",
      "privateKeyId": "string",
      "name": "string",
      "algorithm": "Aes",
      "creationSource": "Cmp",
      "type": "Symmetric",
      "status": "Active"
    }
  ]
}

404

Not Found

text/plain

Schema

Schema

typestringnullable
titlestringnullable
statusint32nullable
detailstringnullable
instancestringnullable
property name*any

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

application/json

Schema

Schema

typestringnullable
titlestringnullable
statusint32nullable
detailstringnullable
instancestringnullable
property name*any

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

text/json

Schema

Schema

typestringnullable
titlestringnullable
statusint32nullable
detailstringnullable
instancestringnullable
property name*any

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

500

Internal Server Error