/svix-applications | Type: Application | PCID required: Yes
Tools
svix_applications_v1_application_create
Create Application Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
get_if_exists | boolean | No | — | Get an existing application, or create a new one if doesn’t exist. It’s two separate functions in the libs. |
metadata | object | No | — | The metadata value |
name | string | Yes | — | Application name for human consumption. |
rateLimit | integer | No | — | Deprecated, use throttleRate instead. |
throttleRate | integer | No | — | Maximum messages per second to send to this application. Outgoing messages will be throttled to this rate. |
uid | string | No | — | Optional unique identifier for the application. |
svix_applications_v1_application_delete
Delete Application Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
app_id | string | Yes | — | The Application’s ID or UID. |
svix_applications_v1_application_get
Get Application Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
app_id | string | Yes | — | The Application’s ID or UID. |
svix_applications_v1_application_list
List Applications Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
exclude_apps_with_no_endpoints | boolean | No | — | Exclude applications that have no endpoints. Default is false. |
exclude_apps_with_disabled_endpoints | boolean | No | — | Exclude applications that have only disabled endpoints. Default is false. |
exclude_apps_with_svix_play_endpoints | boolean | No | — | Exclude applications that only have Svix Play endpoints. Default is false. |
limit | integer | No | — | Limit the number of returned items |
iterator | string | No | — | The iterator returned from a prior invocation |
order | string | No | — | The sorting order of the returned items |
svix_applications_v1_application_patch
Patch Application Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
app_id | string | Yes | — | The Application’s ID or UID. |
metadata | object | No | — | The metadata value |
name | string | No | — | The name value |
rateLimit | integer | No | — | Deprecated, use throttleRate instead. |
throttleRate | integer | No | — | Maximum messages per second to send to this application. Outgoing messages will be throttled to this rate. |
uid | string | No | — | The Application’s UID. |
svix_applications_v1_application_update
Update Application Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
app_id | string | Yes | — | The Application’s ID or UID. |
metadata | object | No | — | The metadata value |
name | string | Yes | — | Application name for human consumption. |
rateLimit | integer | No | — | Deprecated, use throttleRate instead. |
throttleRate | integer | No | — | Maximum messages per second to send to this application. Outgoing messages will be throttled to this rate. |
uid | string | No | — | Optional unique identifier for the application. |
svix_applications_v1_authentication_app_portal_access
Get Consumer App Portal Access Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
app_id | string | Yes | — | The Application’s ID or UID. |
application | object | No | — | The application value |
capabilities | string[] | No | — | Custom capabilities attached to the token, You can combine as many capabilities as necessary. The ViewBase capability is always required - ViewBase: Basic read only permissions, does not allow the user to see the endpoint secret. - ViewEndpointSecret: Allows user to view the endpoint secret. - ManageEndpointSecret: Allows user to rotate and view the endpoint secret. - ManageTransformations: Allows user to modify the endpoint transformations. - CreateAttempts: Allows user to replay missing messages and send example messages. - ManageEndpoint: Allows user to read/modify any field or configuration of an endpoint (including secrets) By default, the token will get all capabilities if the capabilities are not explicitly specified. |
expiry | integer | No | — | How long the token will be valid for, in seconds. Valid values are between 1 hour and 7 days. The default is 7 days. |
featureFlags | string[] | No | — | The set of feature flags the created token will have access to. |
readOnly | boolean | No | — | Whether the app portal should be in read-only mode. |
sessionId | string | No | — | An optional session ID to attach to the token. When expiring tokens with “Expire All”, you can include the session ID to only expire tokens that were created with that session ID. |
svix_applications_v1_authentication_expire_all
Expire All Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
app_id | string | Yes | — | The Application’s ID or UID. |
expiry | integer | No | — | How many seconds until the old key is expired. |
sessionIds | string[] | No | — | An optional list of session ids. If any session ids are specified, only Application tokens created with that session id will be expired. |
svix_applications_v1_authentication_logout
Logoutsvix_applications_v1_background_task_get
Get Background Task Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
task_id | string | Yes | — | The QueueBackgroundTask’s ID. |
svix_applications_v1_background_task_list
List Background Tasks Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
status | string | No | — | Filter the response based on the status. |
task | string | No | — | Filter the response based on the type. |
limit | integer | No | — | Limit the number of returned items |
iterator | string | No | — | The iterator returned from a prior invocation |
order | string | No | — | The sorting order of the returned items |
svix_applications_v1_environment_export
Export Environment Configurationsvix_applications_v1_environment_import
Import Environment Configuration Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
connectors | object[] | No | — | The connectors value |
eventTypes | object[] | No | — | Event Types |
settings | object | No | — | The settings value |
svix_applications_v1_event_type_create
Create Event Type Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
archived | boolean | No | — | The archived value |
deprecated | boolean | No | — | The deprecated value |
description | string | Yes | — | The description value |
featureFlag | string | No | — | Deprecated, use featureFlags instead. |
featureFlags | string[] | No | — | Feature Flags |
groupName | string | No | — | The event type group’s name |
name | string | Yes | — | The event type’s name |
schemas | object | No | — | The schema for the event type for a specific version as a JSON schema. |
svix_applications_v1_event_type_delete
Delete Event Type Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
event_type_name | string | Yes | — | The event type’s name |
expunge | boolean | No | — | By default event types are archived when “deleted”. Passing this to true deletes them entirely. |
svix_applications_v1_event_type_get
Get Event Type Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
event_type_name | string | Yes | — | The event type’s name |
svix_applications_v1_event_type_import_openapi
Event Type Import From Openapi Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
dryRun | boolean | No | — | If true, return the event types that would be modified without actually modifying them. |
replaceAll | boolean | No | — | If true, all existing event types that are not in the spec will be archived. |
spec | object | No | — | A pre-parsed JSON spec. |
specRaw | string | No | — | A string, parsed by the server as YAML or JSON. |
svix_applications_v1_event_type_list
List Event Types Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
limit | integer | No | — | Limit the number of returned items |
iterator | string | No | — | The iterator returned from a prior invocation |
order | string | No | — | The sorting order of the returned items |
include_archived | boolean | No | — | When true archived (deleted but not expunged) items are included in the response. |
with_content | boolean | No | — | When true the full item (including the schema) is included in the response. |
svix_applications_v1_event_type_patch
Patch Event Type Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
event_type_name | string | Yes | — | The event type’s name |
archived | boolean | No | — | The archived value |
deprecated | boolean | No | — | The deprecated value |
description | string | No | — | The description value |
featureFlag | string | No | — | Deprecated, use featureFlags instead. |
featureFlags | string[] | No | — | Feature Flags |
groupName | string | No | — | The event type group’s name |
schemas | object | No | — | The schemas value |
svix_applications_v1_event_type_update
Update Event Type Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
event_type_name | string | Yes | — | The event type’s name |
archived | boolean | No | — | The archived value |
deprecated | boolean | No | — | The deprecated value |
description | string | Yes | — | The description value |
featureFlag | string | No | — | Deprecated, use featureFlags instead. |
featureFlags | string[] | No | — | Feature Flags |
groupName | string | No | — | The event type group’s name |
schemas | object | No | — | The schema for the event type for a specific version as a JSON schema. |
svix_applications_v1_health_get
Healthsvix_applications_v1_statistics_aggregate_app_stats
Aggregate App Stats Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
appIds | string[] | No | — | Specific app IDs or UIDs to aggregate stats for. Note that if none of the given IDs or UIDs are resolved, a 422 response will be given. |
since | string | Yes | — | The since value |
until | string | Yes | — | The until value |

