CreateIngestKey

POST

https://orgs.ezghcloud.com/v1/organizations/{orgId}/projects/{projectId}/ingest-keys

View as Markdown

Authorization

apiKeyoptionalHTTP
oauthoptionalHTTP
sessionCookieoptionalAPI key in cookie

Path parameters

orgIdstringrequired
projectIdstringrequired

Header parameters

idempotency-keyoptionalstring

Request bodyJSONrequired

namestringrequired
allowedActionsarray ofstringrequired
maxLength: 128, pattern: ^[a-z]{2,32}(\.[a-z][A-Za-z]*){1,2}$

Returns

201

Success

JSON

ingestKeyobjectrequired
11 properties
- idstringrequired
- slugstringrequired
- namestringrequired
- resourceNamestringrequired
- organizationIdstringrequired
- projectIdstringrequired
- prefixstringrequired
- allowedActionsarray ofstringrequired
- createdByobjectrequired
  3 properties
  typeuseroroauthorapiKeyorbotrequired
  idstringrequired
  displayNamestringornullrequired
  2 variants
  One of the following:
  string
  null
- createdAtstringrequired
- revokedAtstringornullrequired
  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

AccessDenied | ForbiddenOrigin

JSON

One of the following:

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/projects/string/ingest-keys \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "name": "string", "allowedActions": [ "string" ] } '

{ "ingestKey": { "id": "string", "slug": "string", "name": "string", "resourceName": "string", "organizationId": "string", "projectId": "string", "prefix": "string", "allowedActions": [ "string" ], "createdBy": { "type": "user", "id": "string", "displayName": "string" }, "createdAt": "string", "revokedAt": "string" }, "token": "string" }