CliQr is now part of Cisco Learn More About Cisco

Create API Key

Details

API Details
NameCreate API Key
Description

The API key is also referred to as the management key or access key is required to use CloudCenter APIs.

  • Users can generate/regenerate an API key
  • Tenant administrator can generate/regenerate the API key for any user within their tenant

CloudCenter validates the user name and password of API clients making HTTPS Request.

MethodPOST
URIv1/users/userId/keys
CloudCenter ReleaseIntroduced in CloudCenter 3.x.
NotesFor additional context on <PORT> usage in the following example(s), see Base URI Format.
ESB Headeraction: create.users.userId.keys

Example

curl -k -X POST -H "Accept: application/json" -H "Content-Type: application/json" -u cloudcenteradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/v1/users/18/keys"

Request Body

Response

Request Attributes

apiKey
  • Description: Identifies the API access key. See API Management Key for additional details.
  • Type: API key data type

    generate
    • Description: Identifies if an apiKey is generated:
      • true = An API key is generated
      • false = An API key is not generated
    • Type: Boolean

Response Attributes

apiKey
  • Description: Identifies the API access key. See API Management Key for additional details.
  • Type: API key data type

    key
sshKeys (click for additional details)
sftpKeys (click for additional details)