Jump to

• Request
• Response

Retrieve the list of all keys

get

https://cloud-native-SBC-IP/config/v1/license/keys

Retrieve the list of all keys

Request

There are no request parameters for this operation.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Retrieve the list of all keys

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object LicenseDetail

{
    "items":{
        "$ref":"#/components/schemas/LicenseDetail"
    },
    "type":"array"
}

Nested Schema : LicenseDetail

Type: object

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• end-time: string (date-time)
  Pattern: ^(-?(?:[1-9][0-9]*)?[0-9]{4})-(1[0-2]|0[1-9])-(3[01]|0[1-9]|[12][0-9])T(2[0-3]|[01][0-9]):([0-5][0-9]):([0-5][0-9])(\.[0-9]{3})?(Z)$

  license expiry date time, format is RFC3339 'YYYY-MM-DDTHH:MM:SSZ'

  Example: 2022-03-10T12:15:50
• features: array features
  features associated with license
• license-key: string
  license key
• provision-time: string (date-time)
  Pattern: ^(-?(?:[1-9][0-9]*)?[0-9]{4})-(1[0-2]|0[1-9])-(3[01]|0[1-9]|[12][0-9])T(2[0-3]|[01][0-9]):([0-5][0-9]):([0-5][0-9])(\.[0-9]{3})?(Z)$

  license provisioning date time, format is RFC3339 'YYYY-MM-DDTHH:MM:SSZ'

  Example: 2022-03-10T12:15:50
• start-time: string (date-time)
  Pattern: ^(-?(?:[1-9][0-9]*)?[0-9]{4})-(1[0-2]|0[1-9])-(3[01]|0[1-9]|[12][0-9])T(2[0-3]|[01][0-9]):([0-5][0-9]):([0-5][0-9])(\.[0-9]{3})?(Z)$

  license activation date time, format is RFC3339 'YYYY-MM-DDTHH:MM:SSZ'

  Example: 2022-03-10T12:15:50

{
    "properties":{
        "start-time":{
            "description":"license activation date time, format is RFC3339 'YYYY-MM-DDTHH:MM:SSZ'",
            "example":"2022-03-10T12:15:50",
            "format":"date-time",
            "pattern":"^(-?(?:[1-9][0-9]*)?[0-9]{4})-(1[0-2]|0[1-9])-(3[01]|0[1-9]|[12][0-9])T(2[0-3]|[01][0-9]):([0-5][0-9]):([0-5][0-9])(\\.[0-9]{3})?(Z)$",
            "type":"string"
        },
        "end-time":{
            "description":"license expiry date time, format is RFC3339 'YYYY-MM-DDTHH:MM:SSZ'",
            "example":"2022-03-10T12:15:50",
            "format":"date-time",
            "pattern":"^(-?(?:[1-9][0-9]*)?[0-9]{4})-(1[0-2]|0[1-9])-(3[01]|0[1-9]|[12][0-9])T(2[0-3]|[01][0-9]):([0-5][0-9]):([0-5][0-9])(\\.[0-9]{3})?(Z)$",
            "type":"string"
        },
        "provision-time":{
            "description":"license provisioning date time, format is RFC3339 'YYYY-MM-DDTHH:MM:SSZ'",
            "example":"2022-03-10T12:15:50",
            "format":"date-time",
            "pattern":"^(-?(?:[1-9][0-9]*)?[0-9]{4})-(1[0-2]|0[1-9])-(3[01]|0[1-9]|[12][0-9])T(2[0-3]|[01][0-9]):([0-5][0-9]):([0-5][0-9])(\\.[0-9]{3})?(Z)$",
            "type":"string"
        },
        "license-key":{
            "description":"license key",
            "type":"string"
        },
        "features":{
            "description":"features associated with license",
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : features

Type: array

features associated with license

Show Source

• Array of: string

{
    "description":"features associated with license",
    "items":{
        "type":"string"
    },
    "type":"array"
}

404 Response

Not Found

Body ()

Root Schema : ApiValidationError

Type: object

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• code: string
• errors: array errors
• message: string
• timestamp: string

{
    "properties":{
        "timestamp":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "message":{
            "type":"string"
        },
        "errors":{
            "items":{
                "$ref":"#/components/schemas/Errors"
            },
            "type":"array"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : errors

Type: array

Show Source

• Array of: object Errors

{
    "items":{
        "$ref":"#/components/schemas/Errors"
    },
    "type":"array"
}

Nested Schema : Errors

Type: object

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• attribute: string
• code: string
• message: string
• type: string
  Allowed Values: [ "error", "fatal", "warn" ]

{
    "properties":{
        "attribute":{
            "type":"string"
        },
        "type":{
            "$ref":"#/components/schemas/TypeEnum"
        },
        "message":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "type":"object"
}

Back to Top