Returns the specified API key

GET 
/v1/apiKeys/:uid

Returns the specified API key

Request

Path Parameters

uid stringrequired

Specify API key uid

Responses

200

(empty)

application/json

Schema

Schema

metadata

object

ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

annotations

object

Annotations are system generated key value metadata for the resource. As an input certain annotations like description can be set.

property name*string

creationTimestampdate-time

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

deletionTimestampdate-time

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

labels

object

Labels are key value data to organize and categorize resources. Providing spectro__tag as value for a label is considered as a kubernetes compliant tag

property name*string

lastModifiedTimestampdate-time

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

namestring

Name of the resource.

uidstring

UID is the unique identifier generated for the resource. This is not an input field for any request.

spec

object

API key specification

expirydate-time

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

keystring

Deprecated: API key field will be no longer available

user

object

API key user information

firstNamestring

First name of user

lastNamestring

Last name of user

uidstring

User uid

status

object

API key status

isActiveboolean

API key active state

Example (from schema)

{
  "metadata": {
    "annotations": {},
    "creationTimestamp": "2024-04-16T17:48:59.956Z",
    "deletionTimestamp": "2024-04-16T17:48:59.956Z",
    "labels": {},
    "lastModifiedTimestamp": "2024-04-16T17:48:59.956Z",
    "name": "string",
    "uid": "string"
  },
  "spec": {
    "expiry": "2024-04-16T17:48:59.956Z",
    "key": "string",
    "user": {
      "firstName": "string",
      "lastName": "string",
      "uid": "string"
    }
  },
  "status": {
    "isActive": true
  }
}

Loading...