API Keys

APIs to create and manage Feature Flag SDK API Keys

Returns API Keys for an Environment

Returns all the API Keys for an Environment

Securityx-api-key

Request

query Parameters

accountIdentifier required	string Account Identifier Examples: default accountIdentifier=default
orgIdentifier required	string Organization Identifier Examples: default orgIdentifier=default_org
projectIdentifier required	string The Project identifier
environmentIdentifier required	string Environment Identifier
pageNumber	integer PageNumber
pageSize	integer PageSize

Responses

200

401

Unauthenticated

403

Unauthorized

404

The specified resource was not found

500

Internal server error

get/cf/admin/apikey

Request samples

curl
Java
Go

Response samples

application/json

{"itemCount": 1,
"pageCount": 100,
"pageIndex": 0,
"pageSize": 1,
"version": 5,
"apiKeys": [{"apiKey": "b03af1cd-bd3f-472b-a4b0-c9c9c09c642e",
"applicationIds": [{"applicationId": "my-springboot-application",
"lastUsed": 1726744149
}
],
"identifier": "production",
"key": "3c940273c34e8a9b21",
"lastUsed": 1726744149,
"name": "Production Server Key",
"type": "server"
}
]
}

Creates an API key for the given Environment

Securityx-api-key

Request

query Parameters

accountIdentifier required	string Account Identifier Examples: default accountIdentifier=default
orgIdentifier required	string Organization Identifier Examples: default 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 (ApiKeyRequestType) The type of key depending on the SDK that is being used. 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

Payload
curl
Java
Go

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",
"applicationIds": [{"applicationId": "my-springboot-application",
"lastUsed": 1726744149
}
],
"identifier": "production",
"key": "3c940273c34e8a9b21",
"lastUsed": 1726744149,
"name": "Production Server Key",
"type": "server"
}

Deletes an API Key

Deletes an API key for the given identifier

Securityx-api-key

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: default accountIdentifier=default
orgIdentifier required	string Organization Identifier Examples: default 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

curl
Java
Go

Response samples

application/json

{"code": "404",
"details": { },
"message": "string"
}

Returns API keys

Returns all the API Keys for the given identifier

Securityx-api-key

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: default accountIdentifier=default
orgIdentifier required	string Organization Identifier Examples: default 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

curl
Java
Go

Response samples

application/json

{"apiKey": "b03af1cd-bd3f-472b-a4b0-c9c9c09c642e",
"applicationIds": [{"applicationId": "my-springboot-application",
"lastUsed": 1726744149
}
],
"identifier": "production",
"key": "3c940273c34e8a9b21",
"lastUsed": 1726744149,
"name": "Production Server Key",
"type": "server"
}

Updates an API Key

Updates an API key for the given identifier

Securityx-api-key

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: default accountIdentifier=default
orgIdentifier required	string Organization Identifier Examples: default 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

Payload
curl
Java
Go

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"
}

➔ Next to Feature Flags