actionPOSTv1.0.0
Create a DNS record
Creates a DNS record for a domain.
actionPOSTv1.0.0
Create a new secret
Allows to create a new secret.
actionPOSTv1.0.0
Create a Team
Create a new Team under your account. You need to send a POST request with the desired Team slug, and optionally the Team name.
actionPOSTv1.0.0
Create an Edge Config
Creates an Edge Config.
actionPOSTv1.0.0
Create one or more environment variables
Create one ore more environment variables for a project by passing its `key`, `value`, `type` and `target` and by specifying the project by either passing the project `id` or `name` in the URL.
actionPOSTv1.0.0
Creates a Configurable Log Drain
Creates a configurable log drain. This endpoint must be called with a team AccessToken (integration OAuth2 clients are not allowed)
actionPOSTv1.0.0
Creates a new Check
Creates a new check. This endpoint must be called with an OAuth2 or it will produce a 400 error.
actionPOSTv1.0.0
Creates a new Integration Log Drain
Creates an Integration log drain. This endpoint must be called with an OAuth2 client (integration), since log drains are tied to integrations. If it is called with a different token type it will produce a 400 error.
actionDELETEv1.0.0
Delete a Deployment
This API allows you to delete a deployment, either by supplying its `id` in the URL or the `url` of the deployment as a query parameter. You can obtain the ID, for example, by listing all deployments.
actionDELETEv1.0.0
Delete a Project
Delete a specific project by passing either the project `id` or `name` in the URL.
actionDELETEv1.0.0
Delete a secret
This deletes the user's secret defined in the URL.
actionDELETEv1.0.0
Delete a Team
Delete a team under your account. You need to send a `DELETE` request with the desired team `id`. An optional array of reasons for deletion may also be sent.
actionDELETEv1.0.0
Delete an Alias
Delete an Alias with the specified ID.
actionDELETEv1.0.0
Delete an Edge Config
Delete an Edge Config by id.
actionDELETEv1.0.0
Delete an integration configuration
Allows to remove the configuration with the `id` provided in the parameters. The configuration and all of its resources will be removed. This includes Webhooks, LogDrains and Project Env variables.
actionDELETEv1.0.0
Deletes a Configurable Log Drain
Deletes a Configurable Log Drain. This endpoint must be called with a team AccessToken (integration OAuth2 clients are not allowed). Only log drains owned by the authenticated team can be deleted.
actionDELETEv1.0.0
Deletes the Integration log drain with the provided `id`
Deletes the Integration log drain with the provided `id`. When using an OAuth2 Token, the log drain can be deleted only if the integration owns it.
actionGETv1.0.0
Find a project by id or name
Get the information for a specific project by passing either the project `id` or `name` in the URL.
actionGETv1.0.0
Get a deployment by ID or URL
Retrieves information for a deployment either by supplying its ID (`id` property) or Hostname (`url` property). Additional details will be included when the authenticated user is an owner of the deployment.
actionGETv1.0.0
Get a Domain's configuration
Get a Domain's configuration.
actionGETv1.0.0
Get a project domain
Get project domain by project id/name and domain name.
actionGETv1.0.0
Get a single check
Return a detailed response for a single check.
actionGETv1.0.0
Get a single secret
Retrieves the information for a specific secret by passing either the secret id or name in the URL.
actionGETv1.0.0
Get a Team
Get information for the Team specified by the `teamId` parameter.
actionGETv1.0.0
Get access request status
Check the status of a join request. It'll respond with a 404 if the request has been declined. If no `userId` path segment was provided, this endpoint will instead return the status of the authenticated user.
actionGETv1.0.0
Get an Alias
Retrieves an Alias for the given host name or alias ID.
actionGETv1.0.0
Get an Edge Config
Returns an Edge Config.
actionGETv1.0.0
Get an Edge Config item
Returns a specific Edge Config Item.
actionGETv1.0.0
Get cert by id
Get cert by id
actionGETv1.0.0
Get configurations for the authenticated user or team
Allows to retrieve all configurations for an authenticated integration. When the `project` view is used, configurations generated for the authorization flow will be filtered out of the results.
actionGETv1.0.0
Get Deployment File Contents
Allows to retrieve the content of a file by supplying the file identifier and the deployment unique identifier. The response body will contain the raw content of the file.
actionGETv1.0.0
Get Edge Config items
Returns all items of an Edge Config.
actionGETv1.0.0
Get Edge Configs
Returns all Edge Configs.
actionGETv1.0.0
Get Information for a Single Domain
Get information for a single domain in an account or team.
actionGETv1.0.0
Get status of Remote Caching for this principal
Check the status of Remote Caching for this principal. Returns a JSON-encoded status indicating if Remote Caching is enabled, disabled, or disabled due to usage limits.
actionGETv1.0.0
Get the User
Retrieves information related to the currently authenticated User.
actionGETv1.0.0
List aliases
Retrieves a list of aliases for the authenticated User or Team. When `domain` is provided, only aliases for that domain will be returned. When `projectId` is provided, it will only return the given project aliases.
actionGETv1.0.0
List all teams
Get a paginated list of all the Teams the authenticated User is a member of.
actionGETv1.0.0
List all the domains
Retrieves a list of domains registered for the authenticating user. By default it returns the last 20 domains if no limit is provided.
actionGETv1.0.0
List Deployment Aliases
Retrieves all Aliases for the Deployment with the given ID. The authenticated User must own the deployment.
actionGETv1.0.0
List Deployment Builds
Retrieves the list of builds given their deployment's unique identifier.
actionGETv1.0.0
List Deployment Files
Allows to retrieve the file structure of a deployment by supplying the deployment unique identifier.
actionGETv1.0.0
List existing DNS records
Retrieves a list of DNS records created for a domain name. By default it returns 20 records if no limit is provided. The rest can be retrieved using the pagination options.
actionGETv1.0.0
List git namespaces by provider
Lists git namespaces for a supported provider. Supported providers are `github`, `gitlab` and `bitbucket`. If the provider is not provided, it will try to obtain it from the user that authenticated the request.
actionGETv1.0.0
List git repositories linked to namespace by provider
Lists git repositories linked to a namespace `id` for a supported provider. A specific namespace `id` can be obtained via the `git-namespaces` endpoint. Supported providers are `github`, `gitlab` and `bitbucket`. If the provider or namespace is not provided, it will try to obtain it from the user that authenticated the request.
actionGETv1.0.0
List secrets
Retrieves the active Vercel secrets for the authenticated user. By default it returns 20 secrets. The rest can be retrieved using the pagination options. The body will contain an entry for each secret.
actionGETv1.0.0
List team members
Get a paginated list of team members for the provided team.
actionGETv1.0.0
List User Events
Retrieves a list of "events" generated by the User on Vercel. Events are generated when the User performs a particular action, such as logging in, creating a deployment, and joining a Team (just to name a few). When the `teamId` parameter is supplied, then the events that are returned will be in relation to the Team that was specified.
actionPOSTv1.0.0
Query information about an artifact
Query information about an array of artifacts.
actionPOSTv1.0.0
Register or transfer-in a new Domain
This endpoint is used for registering a new domain name with Vercel for the authenticating user, and also for initiating a domain transfer request from an external Registrar to Vercel.
actionDELETEv1.0.0
Remove a domain by name
Delete a previously registered domain name from Vercel. Deleting a domain will automatically remove any associated aliases.
actionGETv1.0.0
Retrieve a list of all checks
List all of the checks created for a deployment.
actionGETv1.0.0
Retrieve an integration configuration
Allows to retrieve a the configuration with the provided id in case it exists. The authenticated user or team must be the owner of the config in order to access it.
actionGETv1.0.0
Retrieve the decrypted value of an environment variable of a project by id
Retrieve the environment variable for a given project.
actionGETv1.0.0
Retrieve the environment variables of a project by id or name
Retrieve the environment variables for a given project by passing either the project `id` or `name` in the URL.
actionGETv1.0.0
Retrieves a Configurable Log Drain
Retrieves a Configurable Log Drain. This endpoint must be called with a team AccessToken (integration OAuth2 clients are not allowed). Only log drains owned by the authenticated team can be accessed.
actionGETv1.0.0
Retrieves a list of Configurable Log Drains
Retrieves a list of Configurable Log Drains. This endpoint must be called with a team AccessToken (integration OAuth2 clients are not allowed). Only log drains owned by the authenticated team can be accessed.
actionGETv1.0.0
Retrieves a list of Integration log drains
Retrieves a list of all Integration log drains that are defined for the authorized account. When using an OAuth2 token, the list is limited to log drains created by the authenticated integration.
Beyond the catalog
Any provider, on request.
01
Request it
Tell us which provider you need, and we will ship it in the registry.
02
Generate it
Point swirls add at an OpenAPI or GraphQL spec. Typed actions for any API you hold credentials for, today.
acme · integrations
terminal
~/acme $swirls add linear
✓ 12 typed actions · scopes and schemas included
~/acme $swirls add https://api.acme.dev/openapi.json
◆ Fetched spec · 38 operations
✓ 6 typed actions · generated from spec