CreateApiKey

POST

https://orgs.ezghcloud.com/v1/organizations/{orgId}/api-keys

View as Markdown

Authorization

apiKeyoptionalHTTP
sessionCookieoptionalAPI key in cookie
oauthoptionalHTTP

Path parameters

orgIdstringrequired

Header parameters

idempotency-keyoptionalstring

Request bodyJSONrequired

namestringrequired
botIdoptionalstring
format: uuid, pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$
expiresInDaysoptionalinteger
maximum: 365, minimum: 1

Returns

201

Success

JSON

apiKeyobjectrequired
9 properties
- idstringrequired
- organizationIdstringrequired
- namestringrequired
- prefixstringrequired
- ownerobjectrequired
  2 properties
  typeuserorbotrequired
  idstringrequired
- createdBystringrequired
- createdAtstringrequired
- lastUsedAtstringornullrequired
  2 variants
  One of the following:
  string
  null
- expiresAtstringornullrequired
  2 variants
  One of the following:
  string
  null
tokenstringrequired

400

InvalidRequest

JSON

errorobjectrequired
3 properties
- codeinvalid_requestrequired
- messagestringrequired
- issuesoptionalarray ofobject
  2 properties
  pathstringrequired
  messagestringrequired

401

Unauthenticated

JSON

errorobjectrequired
2 properties
- codeunauthenticatedrequired
- messagestringrequired

403

Forbidden | AccessDenied | ForbiddenOrigin

JSON

One of the following:

ForbiddenEncoded
View ForbiddenEncoded schema →
1 properties
- errorobjectrequired
  2 properties
  codeforbiddenrequired
  messagestringrequired
AccessDeniedEncoded
View AccessDeniedEncoded schema →
1 properties
- errorobjectrequired
  2 properties
  codeaccess_deniedrequired
  messagestringrequired
ForbiddenOriginEncoded
View ForbiddenOriginEncoded schema →
1 properties
- errorobjectrequired
  2 properties
  codeforbidden_originrequired
  messagestringrequired

404

NotFound

JSON

errorobjectrequired
2 properties
- codenot_foundrequired
- messagestringrequired

409

IdempotencyConflict | IdempotencyInProgress

JSON

One of the following:

IdempotencyConflictEncoded
View IdempotencyConflictEncoded schema →
1 properties
- errorobjectrequired
  2 properties
  codeidempotency_conflictrequired
  messagestringrequired
IdempotencyInProgressEncoded
View IdempotencyInProgressEncoded schema →
1 properties
- errorobjectrequired
  2 properties
  codeidempotency_in_progressrequired
  messagestringrequired

429

TooManyRequests

JSON

errorobjectrequired
2 properties
- codetoo_many_requestsrequired
- messagestringrequired

500

InternalError

JSON

errorobjectrequired
2 properties
- codeinternal_errorrequired
- messagestringrequired

503

Unavailable

JSON

errorobjectrequired
2 properties
- codeunavailablerequired
- messagestringrequired

curl --request POST \ --url https://orgs.ezghcloud.com/v1/organizations/string/api-keys \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "name": "string", "botId": "58ed41f0-04bf-402f-9853-7143ef7dd5ce", "expiresInDays": 1 } '

{ "apiKey": { "id": "string", "organizationId": "string", "name": "string", "prefix": "string", "owner": { "type": "user", "id": "string" }, "createdBy": "string", "createdAt": "string", "lastUsedAt": "string", "expiresAt": "string" }, "token": "string" }