Sign in
Application

Create Application

Create a new application.

post/api/v1/app

Query parameters

get_if_existsboolean

Get an existing application, or create a new one if doesn't exist. It's two separate functions in the libs.

Get an existing application, or create a new one if doesn't exist. It's two separate functions in the libs.

Headers

idempotency-keystring

The request's idempotency key

Request body

metadataobject
namestring required

Application name for human consumption.

throttleRateinteger nullable

Maximum messages per second to send to this application.

Outgoing messages will be throttled to this rate.

uidstring nullable

Optional unique identifier for the application.

Example request

{
  "name": "My first application",
  "uid": "unique-identifier"
}

Response

createdAtstring date-time required
idstring required

The Application's ID.

metadataobject required
namestring required

Application name for human consumption.

throttleRateinteger nullable

Maximum messages per second to send to this application.

Outgoing messages will be throttled to this rate.

uidstring nullable

Optional unique identifier for the application.

updatedAtstring date-time required

Example response

{
  "id": "app_1srOrx2ZWZBpBUvZwXKQmoEYga2",
  "name": "My first application",
  "uid": "unique-identifier"
}

Changes

Changed in 1 of the 5 revisions of this API.3

  • dc130bd1b0743See the full diff
    • ●

      removed the request property rateLimit

      request-property-removed

    • ●

      removed the optional property rateLimit from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property rateLimit from the response with the 201 status

      response-optional-property-removed

    This revision also has 36 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog