Skip to main content
Server path: /svix-applications | Type: Application | PCID required: Yes

Tools


svix_applications_v1_application_create

Create Application Parameters:
ParameterTypeRequiredDefaultDescription
get_if_existsbooleanNoGet an existing application, or create a new one if doesn’t exist. It’s two separate functions in the libs.
metadataobjectNoThe metadata value
namestringYesApplication name for human consumption.
rateLimitintegerNoDeprecated, use throttleRate instead.
throttleRateintegerNoMaximum messages per second to send to this application. Outgoing messages will be throttled to this rate.
uidstringNoOptional unique identifier for the application.

svix_applications_v1_application_delete

Delete Application Parameters:
ParameterTypeRequiredDefaultDescription
app_idstringYesThe Application’s ID or UID.

svix_applications_v1_application_get

Get Application Parameters:
ParameterTypeRequiredDefaultDescription
app_idstringYesThe Application’s ID or UID.

svix_applications_v1_application_list

List Applications Parameters:
ParameterTypeRequiredDefaultDescription
exclude_apps_with_no_endpointsbooleanNoExclude applications that have no endpoints. Default is false.
exclude_apps_with_disabled_endpointsbooleanNoExclude applications that have only disabled endpoints. Default is false.
exclude_apps_with_svix_play_endpointsbooleanNoExclude applications that only have Svix Play endpoints. Default is false.
limitintegerNoLimit the number of returned items
iteratorstringNoThe iterator returned from a prior invocation
orderstringNoThe sorting order of the returned items

svix_applications_v1_application_patch

Patch Application Parameters:
ParameterTypeRequiredDefaultDescription
app_idstringYesThe Application’s ID or UID.
metadataobjectNoThe metadata value
namestringNoThe name value
rateLimitintegerNoDeprecated, use throttleRate instead.
throttleRateintegerNoMaximum messages per second to send to this application. Outgoing messages will be throttled to this rate.
uidstringNoThe Application’s UID.

svix_applications_v1_application_update

Update Application Parameters:
ParameterTypeRequiredDefaultDescription
app_idstringYesThe Application’s ID or UID.
metadataobjectNoThe metadata value
namestringYesApplication name for human consumption.
rateLimitintegerNoDeprecated, use throttleRate instead.
throttleRateintegerNoMaximum messages per second to send to this application. Outgoing messages will be throttled to this rate.
uidstringNoOptional unique identifier for the application.

svix_applications_v1_authentication_app_portal_access

Get Consumer App Portal Access Parameters:
ParameterTypeRequiredDefaultDescription
app_idstringYesThe Application’s ID or UID.
applicationobjectNoThe application value
capabilitiesstring[]NoCustom 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.
expiryintegerNoHow long the token will be valid for, in seconds. Valid values are between 1 hour and 7 days. The default is 7 days.
featureFlagsstring[]NoThe set of feature flags the created token will have access to.
readOnlybooleanNoWhether the app portal should be in read-only mode.
sessionIdstringNoAn 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:
ParameterTypeRequiredDefaultDescription
app_idstringYesThe Application’s ID or UID.
expiryintegerNoHow many seconds until the old key is expired.
sessionIdsstring[]NoAn 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

Logout

svix_applications_v1_background_task_get

Get Background Task Parameters:
ParameterTypeRequiredDefaultDescription
task_idstringYesThe QueueBackgroundTask’s ID.

svix_applications_v1_background_task_list

List Background Tasks Parameters:
ParameterTypeRequiredDefaultDescription
statusstringNoFilter the response based on the status.
taskstringNoFilter the response based on the type.
limitintegerNoLimit the number of returned items
iteratorstringNoThe iterator returned from a prior invocation
orderstringNoThe sorting order of the returned items

svix_applications_v1_environment_export

Export Environment Configuration

svix_applications_v1_environment_import

Import Environment Configuration Parameters:
ParameterTypeRequiredDefaultDescription
connectorsobject[]NoThe connectors value
eventTypesobject[]NoEvent Types
settingsobjectNoThe settings value

svix_applications_v1_event_type_create

Create Event Type Parameters:
ParameterTypeRequiredDefaultDescription
archivedbooleanNoThe archived value
deprecatedbooleanNoThe deprecated value
descriptionstringYesThe description value
featureFlagstringNoDeprecated, use featureFlags instead.
featureFlagsstring[]NoFeature Flags
groupNamestringNoThe event type group’s name
namestringYesThe event type’s name
schemasobjectNoThe schema for the event type for a specific version as a JSON schema.

svix_applications_v1_event_type_delete

Delete Event Type Parameters:
ParameterTypeRequiredDefaultDescription
event_type_namestringYesThe event type’s name
expungebooleanNoBy default event types are archived when “deleted”. Passing this to true deletes them entirely.

svix_applications_v1_event_type_get

Get Event Type Parameters:
ParameterTypeRequiredDefaultDescription
event_type_namestringYesThe event type’s name

svix_applications_v1_event_type_import_openapi

Event Type Import From Openapi Parameters:
ParameterTypeRequiredDefaultDescription
dryRunbooleanNoIf true, return the event types that would be modified without actually modifying them.
replaceAllbooleanNoIf true, all existing event types that are not in the spec will be archived.
specobjectNoA pre-parsed JSON spec.
specRawstringNoA string, parsed by the server as YAML or JSON.

svix_applications_v1_event_type_list

List Event Types Parameters:
ParameterTypeRequiredDefaultDescription
limitintegerNoLimit the number of returned items
iteratorstringNoThe iterator returned from a prior invocation
orderstringNoThe sorting order of the returned items
include_archivedbooleanNoWhen true archived (deleted but not expunged) items are included in the response.
with_contentbooleanNoWhen true the full item (including the schema) is included in the response.

svix_applications_v1_event_type_patch

Patch Event Type Parameters:
ParameterTypeRequiredDefaultDescription
event_type_namestringYesThe event type’s name
archivedbooleanNoThe archived value
deprecatedbooleanNoThe deprecated value
descriptionstringNoThe description value
featureFlagstringNoDeprecated, use featureFlags instead.
featureFlagsstring[]NoFeature Flags
groupNamestringNoThe event type group’s name
schemasobjectNoThe schemas value

svix_applications_v1_event_type_update

Update Event Type Parameters:
ParameterTypeRequiredDefaultDescription
event_type_namestringYesThe event type’s name
archivedbooleanNoThe archived value
deprecatedbooleanNoThe deprecated value
descriptionstringYesThe description value
featureFlagstringNoDeprecated, use featureFlags instead.
featureFlagsstring[]NoFeature Flags
groupNamestringNoThe event type group’s name
schemasobjectNoThe schema for the event type for a specific version as a JSON schema.

svix_applications_v1_health_get

Health

svix_applications_v1_statistics_aggregate_app_stats

Aggregate App Stats Parameters:
ParameterTypeRequiredDefaultDescription
appIdsstring[]NoSpecific 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.
sincestringYesThe since value
untilstringYesThe until value

svix_applications_v1_statistics_aggregate_event_types

Aggregate Event Types