API Keys

APIs to create and manage Feature Flag SDK API Keys

Creates an API key for the given Environment

Creates an API key for the given Environment

SecurityApiKey
Request
query Parameters
accountIdentifier
required
string

Account Identifier

Examples:
accountIdentifier=default
orgIdentifier
required
string

Organization Identifier

Examples:
orgIdentifier=default_org
environmentIdentifier
required
string

Environment Identifier

projectIdentifier
required
string

The Project identifier

Request Body schema: application/json
description
string
expiredAt
integer
identifier
required
string
name
required
string
type
required
string
Enum: "Server" "Client"
Responses
201

Created

400

Bad request

401

Unauthenticated

403

Unauthorized

409

The specified resource already exists

500

Internal server error

post/cf/admin/apikey
Request samples
application/json
{
  • "description": "This key is for server side production environment",
  • "expiredAt": 0,
  • "identifier": "production-environment",
  • "name": "production-env-key",
  • "type": "server"
}
Response samples
application/json
{
  • "apiKey": "b03af1cd-bd3f-472b-a4b0-c9c9c09c642e",
  • "identifier": "production",
  • "key": "3c940273c34e8a9b21",
  • "name": "Production Server Key",
  • "type": "server"
}

Deletes an API Key

Deletes an API key for the given identifier

SecurityApiKey
Request
path Parameters
identifier
required
string

Unique identifier for the object in the API.

query Parameters
projectIdentifier
required
string

The Project identifier

environmentIdentifier
required
string

Environment Identifier

accountIdentifier
required
string

Account Identifier

Examples:
accountIdentifier=default
orgIdentifier
required
string

Organization Identifier

Examples:
orgIdentifier=default_org
Responses
204

No content

401

Unauthenticated

403

Unauthorized

404

The specified resource was not found

500

Internal server error

delete/cf/admin/apikey/{identifier}
Request samples
Response samples
application/json
{
  • "code": 404,
  • "details": { },
  • "message": "Error retrieving projects, organization 'default_org' does not exist"
}

Returns API keys

Returns all the API Keys for the given identifier

SecurityApiKey
Request
path Parameters
identifier
required
string

Unique identifier for the object in the API.

query Parameters
projectIdentifier
required
string

The Project identifier

environmentIdentifier
required
string

Environment Identifier

accountIdentifier
required
string

Account Identifier

Examples:
accountIdentifier=default
orgIdentifier
required
string

Organization Identifier

Examples:
orgIdentifier=default_org
Responses
200

Created

401

Unauthenticated

403

Unauthorized

404

The specified resource was not found

500

Internal server error

get/cf/admin/apikey/{identifier}
Request samples
Response samples
application/json
{
  • "apiKey": "b03af1cd-bd3f-472b-a4b0-c9c9c09c642e",
  • "identifier": "production",
  • "key": "3c940273c34e8a9b21",
  • "name": "Production Server Key",
  • "type": "server"
}

Returns API Keys for an Environment

Returns all the API Keys for an Environment

SecurityApiKey
Request
query Parameters
accountIdentifier
required
string

Account Identifier

Examples:
accountIdentifier=default
orgIdentifier
required
string

Organization Identifier

Examples:
orgIdentifier=default_org
projectIdentifier
required
string

The Project identifier

environmentIdentifier
required
string

Environment Identifier

pageNumber
integer

PageNumber

pageSize
integer

PageSize

Responses
200

OK

401

Unauthenticated

403

Unauthorized

404

The specified resource was not found

500

Internal server error

get/cf/admin/apikey
Request samples
Response samples
application/json
{
  • "itemCount": 1,
  • "pageCount": 100,
  • "pageIndex": 0,
  • "pageSize": 1,
  • "version": 5,
  • "apiKeys": [
    ]
}

Updates an API Key

Updates an API key for the given identifier

SecurityApiKey
Request
path Parameters
identifier
required
string

Unique identifier for the object in the API.

query Parameters
projectIdentifier
required
string

The Project identifier

environmentIdentifier
required
string

Environment Identifier

accountIdentifier
required
string

Account Identifier

Examples:
accountIdentifier=default
orgIdentifier
required
string

Organization Identifier

Examples:
orgIdentifier=default_org
Request Body schema: application/json
description
string
expiredAt
integer
name
string
Responses
200

Updated

400

Bad request

401

Unauthenticated

403

Unauthorized

409

The specified resource already exists

500

Internal server error

put/cf/admin/apikey/{identifier}
Request samples
application/json
{
  • "description": "This key is for server side production environment",
  • "expiredAt": 0,
  • "name": "production-env-key"
}
Response samples
application/json
{
  • "code": 404,
  • "details": { },
  • "message": "Error retrieving projects, organization 'default_org' does not exist"
}