Skip to content
Changelog

Report a bug

Northflank integration: operations for AI agents

Northflank connects to Type.com as an integration. This page lists the 856 operations documented for Claude and Codex in Type.com: 365 read, 335 write, 156 destructive.

About Northflank

Northflank vendor API references, subject to vendor permissions and account availability.

Categories: Developer Tools & IT

How to connect Northflank to Type.com

Access
Organization connection: one shared account for the workspace.

To add the connection, follow the steps in Space connections.

Documented operations

856 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.

856 operations listed.

  • Read

    Health check

    Returns api service status

    GET /v1/

  • Read

    List addon types

    Gets information about the available addon types

    GET /v1/addon-types

  • Read

    Get current authentication info

    Returns the current API, session or workload token’s identity, permissions and expiry. Workload tokens also report their effective project restrictions. No additional permissions are required.

    GET /v1/auth

  • Read

    List backup destinations

    Lists the backup destinations saved to this account. Does not display secrets.

    GET /v1/backup-destinations

  • Read

    List backup destinations

    Lists the backup destinations saved to this account. Does not display secrets.

    GET /v1/teams/{teamId}/backup-destinations

  • Read

    Get backup destination

    View a backup destination, including secrets.

    GET /v1/backup-destinations/{backupDestinationId}

  • Read

    Get backup destination

    View a backup destination, including secrets.

    GET /v1/teams/{teamId}/backup-destinations/{backupDestinationId}

  • Read

    List destinations backups

    Lists the backups associated with a backup destinations.

    GET /v1/backup-destinations/{backupDestinationId}/backups

  • Read

    List destinations backups

    Lists the backups associated with a backup destinations.

    GET /v1/teams/{teamId}/backup-destinations/{backupDestinationId}/backups

  • Read

    List team backups

    Lists backups across projects for the required addon or volume resource type, newest first. Filters are combined; comma-separated values match any listed value. Includes retained backups of deleted addons. Each request returns one resource type; filters specific to the other type are rejected. Cursor pagination is recommended; use the returned ObjectId cursor rather than a backup ID or UUID.

    GET /v1/backups

  • Read

    List team backups

    Lists backups across projects for the required addon or volume resource type, newest first. Filters are combined; comma-separated values match any listed value. Includes retained backups of deleted addons. Each request returns one resource type; filters specific to the other type are rejected. Cursor pagination is recommended; use the returned ObjectId cursor rather than a backup ID or UUID.

    GET /v1/teams/{teamId}/backups

  • Read

    Get credit balance

    Gets the credit available to the account, by origin.

    GET /v1/billing/credit-balance

  • Read

    Get credit balance

    Gets the credit available to the account, by origin.

    GET /v1/teams/{teamId}/billing/credit-balance

  • Read

    List invoices

    Lists finalized invoices.

    GET /v1/billing/invoices

  • Read

    List invoices

    Lists finalized invoices.

    GET /v1/teams/{teamId}/billing/invoices

  • Read

    Get invoice

    Gets details about a given invoice.

    GET /v1/billing/invoices/{invoiceId}

  • Read

    Get invoice

    Gets details about a given invoice.

    GET /v1/teams/{teamId}/billing/invoices/{invoiceId}

  • Read

    List usage

    Lists usage entries at hourly, daily, monthly, or total granularity.

    GET /v1/billing/usage

  • Read

    List usage

    Lists usage entries at hourly, daily, monthly, or total granularity.

    GET /v1/teams/{teamId}/billing/usage

  • Read

    Get usage

    Gets usage details for a given billing hour.

    GET /v1/billing/usage/{timestamp}

  • Read

    Get usage

    Gets usage details for a given billing hour.

    GET /v1/teams/{teamId}/billing/usage/{timestamp}

  • Read

    List providers

    Lists supported cloud providers

    GET /v1/cloud-providers

  • Read

    List clusters

    Lists clusters for the authenticated user or team.

    GET /v1/cloud-providers/clusters

  • Read

    List clusters

    Lists clusters for the authenticated user or team.

    GET /v1/teams/{teamId}/cloud-providers/clusters

  • Read

    Get cluster

    Get information about the given cluster

    GET /v1/cloud-providers/clusters/{clusterId}

  • Read

    Get cluster

    Get information about the given cluster

    GET /v1/teams/{teamId}/cloud-providers/clusters/{clusterId}

  • Read

    List cluster nodes

    Get a list of nodes for the given cluster

    GET /v1/cloud-providers/clusters/{clusterId}/nodes

  • Read

    List cluster nodes

    Get a list of nodes for the given cluster

    GET /v1/teams/{teamId}/cloud-providers/clusters/{clusterId}/nodes

  • Read

    List integrations

    Lists integrations for the authenticated user or team.

    GET /v1/cloud-providers/integrations

  • Read

    List integrations

    Lists integrations for the authenticated user or team.

    GET /v1/teams/{teamId}/cloud-providers/integrations

  • Read

    Get integration

    Get information about the given integration

    GET /v1/cloud-providers/integrations/{integrationId}

  • Read

    Get integration

    Get information about the given integration

    GET /v1/teams/{teamId}/cloud-providers/integrations/{integrationId}

  • Read

    Get workload identity provider status

    Checks whether the OIDC/workload identity provider resources have been installed on the given cloud provider integration account.

    GET /v1/cloud-providers/integrations/{integrationId}/workload-identity-provider

  • Read

    Get workload identity provider status

    Checks whether the OIDC/workload identity provider resources have been installed on the given cloud provider integration account.

    GET /v1/teams/{teamId}/cloud-providers/integrations/{integrationId}/workload-identity-provider

  • Read

    List provider node types

    Lists supported cloud provider node types

    GET /v1/cloud-providers/node-types

  • Read

    List provider permissions

    Lists required cloud provider permissions for the selected integration features

    GET /v1/cloud-providers/permissions

  • Read

    List provider regions

    Lists supported cloud provider regions

    GET /v1/cloud-providers/regions

  • Read

    List container snapshots

    Gets container snapshots belonging to the team.

    GET /v1/container-snapshots

  • Read

    List container snapshots

    Gets container snapshots belonging to the team.

    GET /v1/teams/{teamId}/container-snapshots

  • Read

    Get container snapshot

    Gets a container snapshot.

    GET /v1/container-snapshots/{snapshotId}

  • Read

    Get container snapshot

    Gets a container snapshot.

    GET /v1/teams/{teamId}/container-snapshots/{snapshotId}

  • Read

    List org directory groups

    Lists the Directory Sync directory groups for the authenticated org.

    GET /v1/directory-groups

  • Read

    List directory group members

    Lists the users who are members of the org via a specific Directory Sync group.

    GET /v1/directory-groups/{groupId}/members

  • Read

    Get DNS ID

    Returns the partially random string used when generating host names for the authenticated account.

    GET /v1/dns-id

  • Read

    Get DNS ID

    Returns the partially random string used when generating host names for the authenticated account.

    GET /v1/teams/{teamId}/dns-id

  • Read

    List domains

    Lists available domains

    GET /v1/domains

  • Read

    List domains

    Lists available domains

    GET /v1/teams/{teamId}/domains

  • Read

    Get domain

    Gets details about domain

    GET /v1/domains/{domain}

  • Read

    Get domain

    Gets details about domain

    GET /v1/teams/{teamId}/domains/{domain}

  • Read

    Get domain certificate

    Retrieve certificate data for a domain to verify its contents.

    GET /v1/domains/{domain}/certificate

  • Read

    Get domain certificate

    Retrieve certificate data for a domain to verify its contents.

    GET /v1/teams/{teamId}/domains/{domain}/certificate

  • Read

    Get subdomain

    Gets details about the given subdomain

    GET /v1/domains/{domain}/subdomains/{subdomain}

  • Read

    Get subdomain

    Gets details about the given subdomain

    GET /v1/teams/{teamId}/domains/{domain}/subdomains/{subdomain}

  • Read

    List subdomain paths

    List paths for a given subdomain.

    GET /v1/domains/{domain}/subdomains/{subdomain}/paths

  • Read

    List subdomain paths

    List paths for a given subdomain.

    GET /v1/teams/{teamId}/domains/{domain}/subdomains/{subdomain}/paths

  • Read

    Get subdomain path

    Get subdomain path details.

    GET /v1/domains/{domain}/subdomains/{subdomain}/paths/{subdomainPath}

  • Read

    Get subdomain path

    Get subdomain path details.

    GET /v1/teams/{teamId}/domains/{domain}/subdomains/{subdomain}/paths/{subdomainPath}

  • Read

    Verify subdomain

    Gets details about the given subdomain

    POST /v1/domains/{domain}/subdomains/{subdomain}/verify

  • Read

    Verify subdomain

    Gets details about the given subdomain

    POST /v1/teams/{teamId}/domains/{domain}/subdomains/{subdomain}/verify

  • Read

    List egress IPs

    Gets a list of egress IPs belonging to the team

    GET /v1/egress-ips

  • Read

    List egress IPs

    Gets a list of egress IPs belonging to the team

    GET /v1/teams/{teamId}/egress-ips

  • Read

    Get egress IP

    Gets information about the given egress IP

    GET /v1/egress-ips/{egressIpId}

  • Read

    Get egress IP

    Gets information about the given egress IP

    GET /v1/teams/{teamId}/egress-ips/{egressIpId}

  • Read

    List encryption configurations

    Lists customer-visible encryption configurations and the current encryption mode for the authenticated team or organization, including retained and legacy Vault configurations. Credentials and internal Northflank-managed configurations are never returned.

    GET /v1/encryption/configurations

  • Read

    List encryption configurations

    Lists customer-visible encryption configurations and the current encryption mode for the authenticated team or organization, including retained and legacy Vault configurations. Credentials and internal Northflank-managed configurations are never returned.

    GET /v1/teams/{teamId}/encryption/configurations

  • Read

    Get encryption configuration

    Gets safe settings and activation state for a customer-visible encryption configuration. Credentials and key-verification material are never returned.

    GET /v1/encryption/configurations/{encryptionConfigurationId}

  • Read

    Get encryption configuration

    Gets safe settings and activation state for a customer-visible encryption configuration. Credentials and key-verification material are never returned.

    GET /v1/teams/{teamId}/encryption/configurations/{encryptionConfigurationId}

  • Read

    Verify encryption configuration

    Checks stored KMS settings without changing the configuration. A completed check returns ok=false on KMS failure. Legacy Vault configurations return ok=true without a KMS check.

    POST /v1/encryption/configurations/{encryptionConfigurationId}/verify

  • Read

    Verify encryption configuration

    Checks stored KMS settings without changing the configuration. A completed check returns ok=false on KMS failure. Legacy Vault configurations return ok=true without a KMS check.

    POST /v1/teams/{teamId}/encryption/configurations/{encryptionConfigurationId}/verify

  • Read

    Get encryption configuration usage

    Returns wrapped-DEK counts for customer-visible configurations. Old keys must remain accessible while referenced. This does not count legacy non-envelope ciphertext.

    GET /v1/encryption/usage

  • Read

    Get encryption configuration usage

    Returns wrapped-DEK counts for customer-visible configurations. Old keys must remain accessible while referenced. This does not count legacy non-envelope ciphertext.

    GET /v1/teams/{teamId}/encryption/usage

  • Read

    List gradual rollout strategies

    Lists the gradual rollout strategies belonging to the team, newest first.

    GET /v1/gradual-rollout-strategies

  • Read

    List gradual rollout strategies

    Lists the gradual rollout strategies belonging to the team, newest first.

    GET /v1/teams/{teamId}/gradual-rollout-strategies

  • Read

    Get gradual rollout strategy

    Gets details of the given gradual rollout strategy.

    GET /v1/gradual-rollout-strategies/{gradualRolloutStrategyId}

  • Read

    Get gradual rollout strategy

    Gets details of the given gradual rollout strategy.

    GET /v1/teams/{teamId}/gradual-rollout-strategies/{gradualRolloutStrategyId}

  • Read

    List audit log sinks

    Gets a list of audit log sinks defined on this entity.

    GET /v1/integrations/audit-log-sinks

  • Read

    List audit log sinks

    Gets a list of audit log sinks defined on this entity.

    GET /v1/teams/{teamId}/integrations/audit-log-sinks

  • Read

    Get audit log sink details

    Gets details about a given audit log sink. Secrets are redacted.

    GET /v1/integrations/audit-log-sinks/{sinkId}

  • Read

    Get audit log sink details

    Gets details about a given audit log sink. Secrets are redacted.

    GET /v1/teams/{teamId}/integrations/audit-log-sinks/{sinkId}

  • Read

    List log sinks

    Gets a list of log sinks added to this account.

    GET /v1/integrations/log-sinks

  • Read

    List log sinks

    Gets a list of log sinks added to this account.

    GET /v1/teams/{teamId}/integrations/log-sinks

  • Read

    Get log sink details

    Gets details about a given log sink.

    GET /v1/integrations/log-sinks/{logSinkId}

  • Read

    Get log sink details

    Gets details about a given log sink.

    GET /v1/teams/{teamId}/integrations/log-sinks/{logSinkId}

  • Read

    List notification integrations

    Lists notification integrations for the authenticated user, team or org.

    GET /v1/integrations/notifications

  • Read

    List notification integrations

    Lists notification integrations for the authenticated user, team or org.

    GET /v1/teams/{teamId}/integrations/notifications

  • Read

    Get notification integration

    Get details about a notification integration.

    GET /v1/integrations/notifications/{notificationId}

  • Read

    Get notification integration

    Get details about a notification integration.

    GET /v1/teams/{teamId}/integrations/notifications/{notificationId}

  • Read

    List registries

    Lists the container registry credentials saved to this account. Does not display secrets.

    GET /v1/integrations/registries

  • Read

    List registries

    Lists the container registry credentials saved to this account. Does not display secrets.

    GET /v1/teams/{teamId}/integrations/registries

  • Read

    Get registry

    Views a set of registry credential data.

    GET /v1/integrations/registries/{credentialId}

  • Read

    Get registry

    Views a set of registry credential data.

    GET /v1/teams/{teamId}/integrations/registries/{credentialId}

  • Read

    List SSH identities

    Lists the SSH identities saved to this account. Does not display SSH public keys.

    GET /v1/integrations/ssh-identities

  • Read

    List SSH identities

    Lists the SSH identities saved to this account. Does not display SSH public keys.

    GET /v1/teams/{teamId}/integrations/ssh-identities

  • Read

    Get SSH identity

    Views SSH identity data including public keys.

    GET /v1/integrations/ssh-identities/{identityId}

  • Read

    Get SSH identity

    Views SSH identity data including public keys.

    GET /v1/teams/{teamId}/integrations/ssh-identities/{identityId}

  • Read

    List VCS providers

    Lists linked version control providers

    GET /v1/integrations/vcs

  • Read

    List VCS providers

    Lists linked version control providers

    GET /v1/teams/{teamId}/integrations/vcs

  • Read

    Check repository access

    Checks whether a git repository is publicly reachable or accessible via one of your linked version control accounts, before creating a resource that would clone it.

    POST /v1/integrations/vcs/repo-access

  • Read

    Check repository access

    Checks whether a git repository is publicly reachable or accessible via one of your linked version control accounts, before creating a resource that would clone it.

    POST /v1/teams/{teamId}/integrations/vcs/repo-access

  • Read

    List repositories

    Gets a list of repositories accessible to this account

    GET /v1/integrations/vcs/repos

  • Read

    List repositories

    Gets a list of repositories accessible to this account

    GET /v1/teams/{teamId}/integrations/vcs/repos

  • Read

    List branches

    Gets a list of branches for the repo

    GET /v1/integrations/vcs/repos/{vcsService}/{repositoryOwner}/{repositoryName}/branches

  • Read

    List branches

    Gets a list of branches for the repo

    GET /v1/teams/{teamId}/integrations/vcs/repos/{vcsService}/{repositoryOwner}/{repositoryName}/branches

  • Read

    List load balancers

    Gets a list of load balancers belonging to the team

    GET /v1/load-balancers

  • Read

    List load balancers

    Gets a list of load balancers belonging to the team

    GET /v1/teams/{teamId}/load-balancers

  • Read

    Get load balancer

    Gets information about the given load balancer

    GET /v1/load-balancers/{loadBalancerId}

  • Read

    Get load balancer

    Gets information about the given load balancer

    GET /v1/teams/{teamId}/load-balancers/{loadBalancerId}

  • Read

    Get logs for a resource

    Get logs for any Northflank resource, selected via query parameters: a service, job, or harness (`serviceId`/`jobId`/`harnessId` with `projectId`), an addon including its backups and restores (`addonId` with optional `backupId`/`restoreId`), an OpenTofu job (`opentofuJobId`), a container scan (`containerScanId` with `projectId`), or an unmanaged cluster pod (`clusterId` with `podName`). `logSource` selects between runtime, build, backup and restore logs.

    GET /v1/logs

  • Read

    Get logs for a resource

    Get logs for any Northflank resource, selected via query parameters: a service, job, or harness (`serviceId`/`jobId`/`harnessId` with `projectId`), an addon including its backups and restores (`addonId` with optional `backupId`/`restoreId`), an OpenTofu job (`opentofuJobId`), a container scan (`containerScanId` with `projectId`), or an unmanaged cluster pod (`clusterId` with `podName`). `logSource` selects between runtime, build, backup and restore logs.

    GET /v1/teams/{teamId}/logs

  • Read

    Get network policy

    Get details of a network policy.

    GET /v1/network-policies/{networkPolicyId}

  • Read

    Get network policy

    Get details of a network policy.

    GET /v1/teams/{teamId}/network-policies/{networkPolicyId}

  • Read

    Get OpenTofu job logs

    Get logs for an OpenTofu job

    GET /v1/opentofu-jobs/{opentofuJobId}/logs

  • Read

    Get OpenTofu job logs

    Get logs for an OpenTofu job

    GET /v1/teams/{teamId}/opentofu-jobs/{opentofuJobId}/logs

  • Read

    List org members

    Gets a list of members belonging to the authenticated org.

    GET /v1/org-members

  • Read

    List org roles

    Gets a list of platform roles for the authenticated org.

    GET /v1/org-roles

  • Read

    Get org role

    Gets details about a specific org platform role.

    GET /v1/org-roles/{roleId}

  • Read

    List org role members

    Gets a list of members assigned to a platform role in the authenticated org.

    GET /v1/org-roles/{roleId}/members

  • Read

    List plans

    Lists available billing plans

    GET /v1/plans

  • Read

    List projects

    Lists projects for the authenticated user or team.

    GET /v1/projects

  • Read

    List projects

    Lists projects for the authenticated user or team.

    GET /v1/teams/{teamId}/projects

  • Read

    Get project

    Get information about the given project.

    GET /v1/projects/{projectId}

  • Read

    Get project

    Get information about the given project.

    GET /v1/teams/{teamId}/projects/{projectId}

  • Read

    List addons

    Gets a list of addons belonging to the project

    GET /v1/projects/{projectId}/addons

  • Read

    List addons

    Gets a list of addons belonging to the project

    GET /v1/teams/{teamId}/projects/{projectId}/addons

  • Read

    Get addon

    Gets information about the given addon

    GET /v1/projects/{projectId}/addons/{addonId}

  • Read

    Get addon

    Gets information about the given addon

    GET /v1/teams/{teamId}/projects/{projectId}/addons/{addonId}

  • Read

    Get addon backup schedules

    Gets details about an addon's backup schedules

    GET /v1/projects/{projectId}/addons/{addonId}/backup-schedules

  • Read

    Get addon backup schedules

    Gets details about an addon's backup schedules

    GET /v1/teams/{teamId}/projects/{projectId}/addons/{addonId}/backup-schedules

  • Read

    List addon backups

    Returns a list of backups for the given addon.

    GET /v1/projects/{projectId}/addons/{addonId}/backups

  • Read

    List addon backups

    Returns a list of backups for the given addon.

    GET /v1/teams/{teamId}/projects/{projectId}/addons/{addonId}/backups

  • Read

    Get addon backup

    Gets details about a given backup.

    GET /v1/projects/{projectId}/addons/{addonId}/backups/{backupId}

  • Read

    Get addon backup

    Gets details about a given backup.

    GET /v1/teams/{teamId}/projects/{projectId}/addons/{addonId}/backups/{backupId}

  • Read

    Get addon backup logs

    Get logs for an addon backup

    GET /v1/projects/{projectId}/addons/{addonId}/backups/{backupId}/logs

  • Read

    Get addon backup logs

    Get logs for an addon backup

    GET /v1/teams/{teamId}/projects/{projectId}/addons/{addonId}/backups/{backupId}/logs

  • Read

    List addon backup restores

    Gets a list of restores for the given backup.

    GET /v1/projects/{projectId}/addons/{addonId}/backups/{backupId}/restores

  • Read

    List addon backup restores

    Gets a list of restores for the given backup.

    GET /v1/teams/{teamId}/projects/{projectId}/addons/{addonId}/backups/{backupId}/restores

  • Read

    Get addon restore logs

    Get logs for an addon restore

    GET /v1/projects/{projectId}/addons/{addonId}/backups/{backupId}/restores/{restoreId}/logs

  • Read

    Get addon restore logs

    Get logs for an addon restore

    GET /v1/teams/{teamId}/projects/{projectId}/addons/{addonId}/backups/{backupId}/restores/{restoreId}/logs

  • Read

    List addon containers

    Gets a list of containers for the given addon.

    GET /v1/projects/{projectId}/addons/{addonId}/containers

  • Read

    List addon containers

    Gets a list of containers for the given addon.

    GET /v1/teams/{teamId}/projects/{projectId}/addons/{addonId}/containers

  • Read

    Get addon credentials

    Returns the credentials for connecting to the given addon.

    GET /v1/projects/{projectId}/addons/{addonId}/credentials

  • Read

    Get addon credentials

    Returns the credentials for connecting to the given addon.

    GET /v1/teams/{teamId}/projects/{projectId}/addons/{addonId}/credentials

  • Read

    Get addon instance health

    Current instance health and up to 50 recently terminated instances. Current state is observed now, even when a historical window is requested. Probe output is excluded.

    GET /v1/projects/{projectId}/addons/{addonId}/health

  • Read

    Get addon instance health

    Current instance health and up to 50 recently terminated instances. Current state is observed now, even when a historical window is requested. Probe output is excluded.

    GET /v1/teams/{teamId}/projects/{projectId}/addons/{addonId}/health

  • Read

    Get addon infrastructure events

    Recorded workload and related BYOC node events in a bounded window. Requires the team infrastructure audit events permission. Node evidence is limited to this entity and observed workload nodes.

    GET /v1/projects/{projectId}/addons/{addonId}/health/events

  • Read

    Get addon infrastructure events

    Recorded workload and related BYOC node events in a bounded window. Requires the team infrastructure audit events permission. Node evidence is limited to this entity and observed workload nodes.

    GET /v1/teams/{teamId}/projects/{projectId}/addons/{addonId}/health/events

  • Read

    Get addon logs

    Get logs for an addon

    GET /v1/projects/{projectId}/addons/{addonId}/logs

  • Read

    Get addon logs

    Get logs for an addon

    GET /v1/teams/{teamId}/projects/{projectId}/addons/{addonId}/logs

  • Read

    Get addon metrics

    Get metrics for an addon

    GET /v1/projects/{projectId}/addons/{addonId}/metrics

  • Read

    Get addon metrics

    Get metrics for an addon

    GET /v1/teams/{teamId}/projects/{projectId}/addons/{addonId}/metrics

  • Read

    List addon restores

    Returns a list of restores for the given addon.

    GET /v1/projects/{projectId}/addons/{addonId}/restores

  • Read

    List addon restores

    Returns a list of restores for the given addon.

    GET /v1/teams/{teamId}/projects/{projectId}/addons/{addonId}/restores

  • Read

    Get addon version details

    Gets details about the current addon version including available upgrades and upgrade history.

    GET /v1/projects/{projectId}/addons/{addonId}/version

  • Read

    Get addon version details

    Gets details about the current addon version including available upgrades and upgrade history.

    GET /v1/teams/{teamId}/projects/{projectId}/addons/{addonId}/version

  • Read

    List container scans

    Lists container scans for the project, newest first.

    GET /v1/projects/{projectId}/container-scans

  • Read

    List container scans

    Lists container scans for the project, newest first.

    GET /v1/teams/{teamId}/projects/{projectId}/container-scans

  • Read

    Get container scan

    Gets the status and available results for a container scan.

    GET /v1/projects/{projectId}/container-scans/{containerScanId}

  • Read

    Get container scan

    Gets the status and available results for a container scan.

    GET /v1/teams/{teamId}/projects/{projectId}/container-scans/{containerScanId}

  • Read

    Get container scan logs

    Get logs for a container scan job

    GET /v1/projects/{projectId}/container-scans/{containerScanId}/logs

  • Read

    Get container scan logs

    Get logs for a container scan job

    GET /v1/teams/{teamId}/projects/{projectId}/container-scans/{containerScanId}/logs

  • Read

    List external addons

    Gets a list of external addons belonging to the project

    GET /v1/projects/{projectId}/external-addons

  • Read

    List external addons

    Gets a list of external addons belonging to the project

    GET /v1/teams/{teamId}/projects/{projectId}/external-addons

  • Read

    Get external addon

    Gets information about the given external addon

    GET /v1/projects/{projectId}/external-addons/{externalAddonId}

  • Read

    Get external addon

    Gets information about the given external addon

    GET /v1/teams/{teamId}/projects/{projectId}/external-addons/{externalAddonId}

  • Read

    List harnesses

    Gets a list of harnesses belonging to the project

    GET /v1/projects/{projectId}/harnesses

  • Read

    List harnesses

    Gets a list of harnesses belonging to the project

    GET /v1/teams/{teamId}/projects/{projectId}/harnesses

  • Read

    Get harness

    Gets information about the given harness

    GET /v1/projects/{projectId}/harnesses/{harnessId}

  • Read

    Get harness

    Gets information about the given harness

    GET /v1/teams/{teamId}/projects/{projectId}/harnesses/{harnessId}

  • Read

    Get harness logs

    Get logs for a harness

    GET /v1/projects/{projectId}/harnesses/{harnessId}/logs

  • Read

    Get harness logs

    Get logs for a harness

    GET /v1/teams/{teamId}/projects/{projectId}/harnesses/{harnessId}/logs

  • Read

    List images

    Lists build and imported image versions, including pending and failed imports

    GET /v1/projects/{projectId}/images

  • Read

    List images

    Lists build and imported image versions, including pending and failed imports

    GET /v1/teams/{teamId}/projects/{projectId}/images

  • Read

    Get image

    Gets a build or imported image version

    GET /v1/projects/{projectId}/images/{imageId}

  • Read

    Get image

    Gets a build or imported image version

    GET /v1/teams/{teamId}/projects/{projectId}/images/{imageId}

  • Read

    List jobs

    Gets a list of jobs belonging to the project

    GET /v1/projects/{projectId}/jobs

  • Read

    List jobs

    Gets a list of jobs belonging to the project

    GET /v1/teams/{teamId}/projects/{projectId}/jobs

  • Read

    Check repository access for jobs

    Check whether a repository is public or accessible through an existing Git connection in this project. Requires job creation permission and preserves workload project restrictions. Does not create a Git connection.

    POST /v1/projects/{projectId}/jobs/repo-access

  • Read

    Check repository access for jobs

    Check whether a repository is public or accessible through an existing Git connection in this project. Requires job creation permission and preserves workload project restrictions. Does not create a Git connection.

    POST /v1/teams/{teamId}/projects/{projectId}/jobs/repo-access

  • Read

    Get job

    Gets information about the given job

    GET /v1/projects/{projectId}/jobs/{jobId}

  • Read

    Get job

    Gets information about the given job

    GET /v1/teams/{teamId}/projects/{projectId}/jobs/{jobId}

  • Read

    Get job branches

    Gets information about the branches of the given job.

    GET /v1/projects/{projectId}/jobs/{jobId}/branches

  • Read

    Get job branches

    Gets information about the branches of the given job.

    GET /v1/teams/{teamId}/projects/{projectId}/jobs/{jobId}/branches

  • Read

    List job builds

    Lists builds for the given job.

    GET /v1/projects/{projectId}/jobs/{jobId}/build

  • Read

    List job builds

    Lists builds for the given job.

    GET /v1/teams/{teamId}/projects/{projectId}/jobs/{jobId}/build

  • Read

    Get job build arguments

    Gets the build arguments of the given job. If the API key does not have the permission 'Project > Secrets > General > Read', secrets inherited from secret groups will not be displayed.

    GET /v1/projects/{projectId}/jobs/{jobId}/build-arguments

  • Read

    Get job build arguments

    Gets the build arguments of the given job. If the API key does not have the permission 'Project > Secrets > General > Read', secrets inherited from secret groups will not be displayed.

    GET /v1/teams/{teamId}/projects/{projectId}/jobs/{jobId}/build-arguments

  • Read

    Get job build argument details

    Get details about the build arguments accessible by the given job. Also requires the permission 'Project > Secrets > General > Read'

    GET /v1/projects/{projectId}/jobs/{jobId}/build-arguments/details

  • Read

    Get job build argument details

    Get details about the build arguments accessible by the given job. Also requires the permission 'Project > Secrets > General > Read'

    GET /v1/teams/{teamId}/projects/{projectId}/jobs/{jobId}/build-arguments/details

  • Read

    Get job build logs

    Get logs for a job build

    GET /v1/projects/{projectId}/jobs/{jobId}/build-logs

  • Read

    Get job build logs

    Get logs for a job build

    GET /v1/teams/{teamId}/projects/{projectId}/jobs/{jobId}/build-logs

  • Read

    Get job build metrics

    Get metrics for a job build

    GET /v1/projects/{projectId}/jobs/{jobId}/build-metrics

  • Read

    Get job build metrics

    Get metrics for a job build

    GET /v1/teams/{teamId}/projects/{projectId}/jobs/{jobId}/build-metrics

  • Read

    Get job build

    Gets information about a build for the job

    GET /v1/projects/{projectId}/jobs/{jobId}/build/{buildId}

  • Read

    Get job build

    Gets information about a build for the job

    GET /v1/teams/{teamId}/projects/{projectId}/jobs/{jobId}/build/{buildId}

  • Read

    List job containers

    Gets a list of containers for the given job.

    GET /v1/projects/{projectId}/jobs/{jobId}/containers

  • Read

    List job containers

    Gets a list of containers for the given job.

    GET /v1/teams/{teamId}/projects/{projectId}/jobs/{jobId}/containers

  • Read

    Get job deployment

    Gets information about the deployment of the given job.

    GET /v1/projects/{projectId}/jobs/{jobId}/deployment

  • Read

    Get job deployment

    Gets information about the deployment of the given job.

    GET /v1/teams/{teamId}/projects/{projectId}/jobs/{jobId}/deployment

  • Read

    Get job instance health

    Current instance health and up to 50 recently terminated instances. Current state is observed now, even when a historical window is requested. Probe output is excluded.

    GET /v1/projects/{projectId}/jobs/{jobId}/health

  • Read

    Get job instance health

    Current instance health and up to 50 recently terminated instances. Current state is observed now, even when a historical window is requested. Probe output is excluded.

    GET /v1/teams/{teamId}/projects/{projectId}/jobs/{jobId}/health

  • Read

    Get job health checks

    Lists the health checks for the given job.

    GET /v1/projects/{projectId}/jobs/{jobId}/health-checks

  • Read

    Get job health checks

    Lists the health checks for the given job.

    GET /v1/teams/{teamId}/projects/{projectId}/jobs/{jobId}/health-checks

  • Read

    Get job infrastructure events

    Recorded workload and related BYOC node events in a bounded window. Requires the team infrastructure audit events permission. Node evidence is limited to this entity and observed workload nodes.

    GET /v1/projects/{projectId}/jobs/{jobId}/health/events

  • Read

    Get job infrastructure events

    Recorded workload and related BYOC node events in a bounded window. Requires the team infrastructure audit events permission. Node evidence is limited to this entity and observed workload nodes.

    GET /v1/teams/{teamId}/projects/{projectId}/jobs/{jobId}/health/events

  • Read

    Get job logs

    Get logs for a job

    GET /v1/projects/{projectId}/jobs/{jobId}/logs

  • Read

    Get job logs

    Get logs for a job

    GET /v1/teams/{teamId}/projects/{projectId}/jobs/{jobId}/logs

  • Read

    Get job metrics

    Get metrics for a job

    GET /v1/projects/{projectId}/jobs/{jobId}/metrics

  • Read

    Get job metrics

    Get metrics for a job

    GET /v1/teams/{teamId}/projects/{projectId}/jobs/{jobId}/metrics

  • Read

    Get job pull requests

    Gets information about the pull-requests of the given job.

    GET /v1/projects/{projectId}/jobs/{jobId}/pull-requests

  • Read

    Get job pull requests

    Gets information about the pull-requests of the given job.

    GET /v1/teams/{teamId}/projects/{projectId}/jobs/{jobId}/pull-requests

  • Read

    Get job runs

    Fetches run history for the given job

    GET /v1/projects/{projectId}/jobs/{jobId}/runs

  • Read

    Get job runs

    Fetches run history for the given job

    GET /v1/teams/{teamId}/projects/{projectId}/jobs/{jobId}/runs

  • Read

    Get run details

    Returns data about the given job run

    GET /v1/projects/{projectId}/jobs/{jobId}/runs/{runId}

  • Read

    Get run details

    Returns data about the given job run

    GET /v1/teams/{teamId}/projects/{projectId}/jobs/{jobId}/runs/{runId}

  • Read

    Get job runtime environment

    Returns the runtime environment for the given job. If the API key does not have the permission 'Project > Secrets > General > Read', secrets inherited from secret groups will not be displayed.

    GET /v1/projects/{projectId}/jobs/{jobId}/runtime-environment

  • Read

    Get job runtime environment

    Returns the runtime environment for the given job. If the API key does not have the permission 'Project > Secrets > General > Read', secrets inherited from secret groups will not be displayed.

    GET /v1/teams/{teamId}/projects/{projectId}/jobs/{jobId}/runtime-environment

  • Read

    Get job runtime environment details

    Get details about the runtime environment accessible by the given job. Also requires the permission 'Project > Secrets > General > Read'

    GET /v1/projects/{projectId}/jobs/{jobId}/runtime-environment/details

  • Read

    Get job runtime environment details

    Get details about the runtime environment accessible by the given job. Also requires the permission 'Project > Secrets > General > Read'

    GET /v1/teams/{teamId}/projects/{projectId}/jobs/{jobId}/runtime-environment/details

  • Read

    List AI models

    Lists all AI models for a project

    GET /v1/projects/{projectId}/llm-model-deployments

  • Read

    List AI models

    Lists all AI models for a project

    GET /v1/teams/{teamId}/projects/{projectId}/llm-model-deployments

  • Read

    Get AI model

    Gets details about an AI model

    GET /v1/projects/{projectId}/llm-model-deployments/{llmModelDeploymentId}

  • Read

    Get AI model

    Gets details about an AI model

    GET /v1/teams/{teamId}/projects/{projectId}/llm-model-deployments/{llmModelDeploymentId}

  • Read

    List pipelines

    Lists all pipelines for a project

    GET /v1/projects/{projectId}/pipelines

  • Read

    List pipelines

    Lists all pipelines for a project

    GET /v1/teams/{teamId}/projects/{projectId}/pipelines

  • Read

    Get pipeline

    Get details about a pipeline

    GET /v1/projects/{projectId}/pipelines/{pipelineId}

  • Read

    Get pipeline

    Get details about a pipeline

    GET /v1/teams/{teamId}/projects/{projectId}/pipelines/{pipelineId}

  • Read

    Get preview template

    Get information about the given preview template.

    GET /v1/projects/{projectId}/pipelines/{pipelineId}/preview-envs

  • Read

    Get preview template

    Get information about the given preview template.

    GET /v1/teams/{teamId}/projects/{projectId}/pipelines/{pipelineId}/preview-envs

  • Read

    List preview environments

    Get a list of active preview environments for a template

    GET /v1/projects/{projectId}/pipelines/{pipelineId}/preview-envs/previews

  • Read

    List preview environments

    Get a list of active preview environments for a template

    GET /v1/teams/{teamId}/projects/{projectId}/pipelines/{pipelineId}/preview-envs/previews

  • Read

    List preview template runs

    Get a list of preview template runs

    GET /v1/projects/{projectId}/pipelines/{pipelineId}/preview-envs/runs

  • Read

    List preview template runs

    Get a list of preview template runs

    GET /v1/teams/{teamId}/projects/{projectId}/pipelines/{pipelineId}/preview-envs/runs

  • Read

    Get preview template run

    Get information about the given preview template run.

    GET /v1/projects/{projectId}/pipelines/{pipelineId}/preview-envs/runs/{templateRunId}

  • Read

    Get preview template run

    Get information about the given preview template run.

    GET /v1/teams/{teamId}/projects/{projectId}/pipelines/{pipelineId}/preview-envs/runs/{templateRunId}

  • Read

    Get release flow

    Gets details about a release flow

    GET /v1/projects/{projectId}/pipelines/{pipelineId}/release-flows/{stage}

  • Read

    Get release flow

    Gets details about a release flow

    GET /v1/teams/{teamId}/projects/{projectId}/pipelines/{pipelineId}/release-flows/{stage}

  • Read

    List release flow runs

    Lists runs of a release flow

    GET /v1/projects/{projectId}/pipelines/{pipelineId}/release-flows/{stage}/runs

  • Read

    List release flow runs

    Lists runs of a release flow

    GET /v1/teams/{teamId}/projects/{projectId}/pipelines/{pipelineId}/release-flows/{stage}/runs

  • Read

    Get release flow run details

    Get information about the given release flow run

    GET /v1/projects/{projectId}/pipelines/{pipelineId}/release-flows/{stage}/runs/{runId}

  • Read

    Get release flow run details

    Get information about the given release flow run

    GET /v1/teams/{teamId}/projects/{projectId}/pipelines/{pipelineId}/release-flows/{stage}/runs/{runId}

  • Read

    List preview blueprints

    Lists all preview blueprints for a project

    GET /v1/projects/{projectId}/preview-blueprints

  • Read

    List preview blueprints

    Lists all preview blueprints for a project

    GET /v1/teams/{teamId}/projects/{projectId}/preview-blueprints

  • Read

    Get preview blueprint

    Gets details about a preview blueprint

    GET /v1/projects/{projectId}/preview-blueprints/{previewBlueprintId}

  • Read

    Get preview blueprint

    Gets details about a preview blueprint

    GET /v1/teams/{teamId}/projects/{projectId}/preview-blueprints/{previewBlueprintId}

  • Read

    List preview environments

    Get a list of active previews for a preview blueprint.

    GET /v1/projects/{projectId}/preview-blueprints/{previewBlueprintId}/previews

  • Read

    List preview environments

    Get a list of active previews for a preview blueprint.

    GET /v1/teams/{teamId}/projects/{projectId}/preview-blueprints/{previewBlueprintId}/previews

  • Read

    List preview blueprint runs

    Lists runs of a previewBlueprint

    GET /v1/projects/{projectId}/preview-blueprints/{previewBlueprintId}/runs

  • Read

    List preview blueprint runs

    Lists runs of a previewBlueprint

    GET /v1/teams/{teamId}/projects/{projectId}/preview-blueprints/{previewBlueprintId}/runs

  • Read

    Get preview blueprint run details

    Get information about the given preview blueprint run

    GET /v1/projects/{projectId}/preview-blueprints/{previewBlueprintId}/runs/{runId}

  • Read

    Get preview blueprint run details

    Get information about the given preview blueprint run

    GET /v1/teams/{teamId}/projects/{projectId}/preview-blueprints/{previewBlueprintId}/runs/{runId}

  • Read

    List project secrets

    Gets a list of project secrets belonging to the project

    GET /v1/projects/{projectId}/secrets

  • Read

    List project secrets

    Gets a list of project secrets belonging to the project

    GET /v1/teams/{teamId}/projects/{projectId}/secrets

  • Read

    Get project secret

    View a project secret including its contents

    GET /v1/projects/{projectId}/secrets/{secretId}

  • Read

    Get project secret

    View a project secret including its contents

    GET /v1/teams/{teamId}/projects/{projectId}/secrets/{secretId}

  • Read

    Get project secret addon link details

    Get details about a given addon link.

    GET /v1/projects/{projectId}/secrets/{secretId}/addons/{addonId}

  • Read

    Get project secret addon link details

    Get details about a given addon link.

    GET /v1/teams/{teamId}/projects/{projectId}/secrets/{secretId}/addons/{addonId}

  • Read

    Get project secret details

    View a project secret with details about its linked addons

    GET /v1/projects/{projectId}/secrets/{secretId}/details

  • Read

    Get project secret details

    View a project secret with details about its linked addons

    GET /v1/teams/{teamId}/projects/{projectId}/secrets/{secretId}/details

  • Read

    List services

    Gets a list of services belonging to the project

    GET /v1/projects/{projectId}/services

  • Read

    List services

    Gets a list of services belonging to the project

    GET /v1/teams/{teamId}/projects/{projectId}/services

  • Read

    Check repository access for services

    Check whether a repository is public or accessible through an existing Git connection in this project. Requires service creation permission and preserves workload project restrictions. Does not create a Git connection.

    POST /v1/projects/{projectId}/services/repo-access

  • Read

    Check repository access for services

    Check whether a repository is public or accessible through an existing Git connection in this project. Requires service creation permission and preserves workload project restrictions. Does not create a Git connection.

    POST /v1/teams/{teamId}/projects/{projectId}/services/repo-access

  • Read

    Get service

    Gets information about the given service.

    GET /v1/projects/{projectId}/services/{serviceId}

  • Read

    Get service

    Gets information about the given service.

    GET /v1/teams/{teamId}/projects/{projectId}/services/{serviceId}

  • Read

    Get service branches

    Gets information about the branches of the given service.

    GET /v1/projects/{projectId}/services/{serviceId}/branches

  • Read

    Get service branches

    Gets information about the branches of the given service.

    GET /v1/teams/{teamId}/projects/{projectId}/services/{serviceId}/branches

  • Read

    List service builds

    Lists the builds for the service

    GET /v1/projects/{projectId}/services/{serviceId}/build

  • Read

    List service builds

    Lists the builds for the service

    GET /v1/teams/{teamId}/projects/{projectId}/services/{serviceId}/build

  • Read

    Get service build arguments

    Gets the build arguments of the given service. If the API key does not have the permission 'Project > Secrets > General > Read', secrets inherited from secret groups will not be displayed.

    GET /v1/projects/{projectId}/services/{serviceId}/build-arguments

  • Read

    Get service build arguments

    Gets the build arguments of the given service. If the API key does not have the permission 'Project > Secrets > General > Read', secrets inherited from secret groups will not be displayed.

    GET /v1/teams/{teamId}/projects/{projectId}/services/{serviceId}/build-arguments

  • Read

    Get service build arguments details

    Get details about the build arguments accessible by the given service. Also requires the permission 'Project > Secrets > General > Read'

    GET /v1/projects/{projectId}/services/{serviceId}/build-arguments/details

  • Read

    Get service build arguments details

    Get details about the build arguments accessible by the given service. Also requires the permission 'Project > Secrets > General > Read'

    GET /v1/teams/{teamId}/projects/{projectId}/services/{serviceId}/build-arguments/details

  • Read

    Get service build logs

    Get logs for a service build

    GET /v1/projects/{projectId}/services/{serviceId}/build-logs

  • Read

    Get service build logs

    Get logs for a service build

    GET /v1/teams/{teamId}/projects/{projectId}/services/{serviceId}/build-logs

  • Read

    Get service build metrics

    Get metrics for a service build

    GET /v1/projects/{projectId}/services/{serviceId}/build-metrics

  • Read

    Get service build metrics

    Get metrics for a service build

    GET /v1/teams/{teamId}/projects/{projectId}/services/{serviceId}/build-metrics

  • Read

    Get service build

    Gets information about a build for the service

    GET /v1/projects/{projectId}/services/{serviceId}/build/{buildId}

  • Read

    Get service build

    Gets information about a build for the service

    GET /v1/teams/{teamId}/projects/{projectId}/services/{serviceId}/build/{buildId}

  • Read

    List service containers

    Gets a list of containers for the given service.

    GET /v1/projects/{projectId}/services/{serviceId}/containers

  • Read

    List service containers

    Gets a list of containers for the given service.

    GET /v1/teams/{teamId}/projects/{projectId}/services/{serviceId}/containers

  • Read

    Get service deployment

    Gets information about the deployment of the given service.

    GET /v1/projects/{projectId}/services/{serviceId}/deployment

  • Read

    Get service deployment

    Gets information about the deployment of the given service.

    GET /v1/teams/{teamId}/projects/{projectId}/services/{serviceId}/deployment

  • Read

    List service deployments

    Lists the deployments of the given service, newest first. For services using a gradual rollout strategy each deployment also reports the release type it was created as.

    GET /v1/projects/{projectId}/services/{serviceId}/deployments

  • Read

    List service deployments

    Lists the deployments of the given service, newest first. For services using a gradual rollout strategy each deployment also reports the release type it was created as.

    GET /v1/teams/{teamId}/projects/{projectId}/services/{serviceId}/deployments

  • Read

    Get service instance health

    Current instance health and up to 50 recently terminated instances. Current state is observed now, even when a historical window is requested. Probe output is excluded.

    GET /v1/projects/{projectId}/services/{serviceId}/health

  • Read

    Get service instance health

    Current instance health and up to 50 recently terminated instances. Current state is observed now, even when a historical window is requested. Probe output is excluded.

    GET /v1/teams/{teamId}/projects/{projectId}/services/{serviceId}/health

  • Read

    Get service health checks

    Lists the health checks for the given service.

    GET /v1/projects/{projectId}/services/{serviceId}/health-checks

  • Read

    Get service health checks

    Lists the health checks for the given service.

    GET /v1/teams/{teamId}/projects/{projectId}/services/{serviceId}/health-checks

  • Read

    Get service infrastructure events

    Recorded workload and related BYOC node events in a bounded window. Requires the team infrastructure audit events permission. Node evidence is limited to this entity and observed workload nodes.

    GET /v1/projects/{projectId}/services/{serviceId}/health/events

  • Read

    Get service infrastructure events

    Recorded workload and related BYOC node events in a bounded window. Requires the team infrastructure audit events permission. Node evidence is limited to this entity and observed workload nodes.

    GET /v1/teams/{teamId}/projects/{projectId}/services/{serviceId}/health/events

  • Read

    Get service logs

    Get logs for a service

    GET /v1/projects/{projectId}/services/{serviceId}/logs

  • Read

    Get service logs

    Get logs for a service

    GET /v1/teams/{teamId}/projects/{projectId}/services/{serviceId}/logs

  • Read

    Get service metrics

    Get metrics for a service

    GET /v1/projects/{projectId}/services/{serviceId}/metrics

  • Read

    Get service metrics

    Get metrics for a service

    GET /v1/teams/{teamId}/projects/{projectId}/services/{serviceId}/metrics

  • Read

    Get service per-replica volumes

    Lists the per-replica statefulSet volumes for the given service.

    GET /v1/projects/{projectId}/services/{serviceId}/per-replica-volumes

  • Read

    Get service per-replica volumes

    Lists the per-replica statefulSet volumes for the given service.

    GET /v1/teams/{teamId}/projects/{projectId}/services/{serviceId}/per-replica-volumes

  • Read

    Get service ports

    Lists the ports for the given service.

    GET /v1/projects/{projectId}/services/{serviceId}/ports

  • Read

    Get service ports

    Lists the ports for the given service.

    GET /v1/teams/{teamId}/projects/{projectId}/services/{serviceId}/ports

  • Read

    Get service pull requests

    Gets information about the pull-requests of the given service.

    GET /v1/projects/{projectId}/services/{serviceId}/pull-requests

  • Read

    Get service pull requests

    Gets information about the pull-requests of the given service.

    GET /v1/teams/{teamId}/projects/{projectId}/services/{serviceId}/pull-requests

  • Read

    Get service rollout

    Gets the active gradual rollout of the given service, including the traffic configuration, the stable and canary deployments, and previous traffic configurations.

    GET /v1/projects/{projectId}/services/{serviceId}/rollout

  • Read

    Get service rollout

    Gets the active gradual rollout of the given service, including the traffic configuration, the stable and canary deployments, and previous traffic configurations.

    GET /v1/teams/{teamId}/projects/{projectId}/services/{serviceId}/rollout

  • Read

    Get service runtime environment

    Gets the runtime environment of the given service. If the API key does not have the permission 'Project > Secrets > General > Read', secrets inherited from secret groups will not be displayed.

    GET /v1/projects/{projectId}/services/{serviceId}/runtime-environment

  • Read

    Get service runtime environment

    Gets the runtime environment of the given service. If the API key does not have the permission 'Project > Secrets > General > Read', secrets inherited from secret groups will not be displayed.

    GET /v1/teams/{teamId}/projects/{projectId}/services/{serviceId}/runtime-environment

  • Read

    Get service runtime environment details

    Get details about the runtime environment accessible by the given service. Also requires the permission 'Project > Secrets > General > Read'

    GET /v1/projects/{projectId}/services/{serviceId}/runtime-environment/details

  • Read

    Get service runtime environment details

    Get details about the runtime environment accessible by the given service. Also requires the permission 'Project > Secrets > General > Read'

    GET /v1/teams/{teamId}/projects/{projectId}/services/{serviceId}/runtime-environment/details

  • Read

    List volumes

    Gets a list of volumes belonging to the project

    GET /v1/projects/{projectId}/volumes

  • Read

    List volumes

    Gets a list of volumes belonging to the project

    GET /v1/teams/{teamId}/projects/{projectId}/volumes

  • Read

    Get volume

    Retrieve a volume

    GET /v1/projects/{projectId}/volumes/{volumeId}

  • Read

    Get volume

    Retrieve a volume

    GET /v1/teams/{teamId}/projects/{projectId}/volumes/{volumeId}

  • Read

    Get volume backup schedules

    Gets details about a volume's backup schedules

    GET /v1/projects/{projectId}/volumes/{volumeId}/backup-schedules

  • Read

    Get volume backup schedules

    Gets details about a volume's backup schedules

    GET /v1/teams/{teamId}/projects/{projectId}/volumes/{volumeId}/backup-schedules

  • Read

    Get volume backups

    Get list of backups associated with a volume

    GET /v1/projects/{projectId}/volumes/{volumeId}/backups

  • Read

    Get volume backups

    Get list of backups associated with a volume

    GET /v1/teams/{teamId}/projects/{projectId}/volumes/{volumeId}/backups

  • Read

    Get volume backup details

    Get details for a specific volume backup

    GET /v1/projects/{projectId}/volumes/{volumeId}/backups/{backupId}

  • Read

    Get volume backup details

    Get details for a specific volume backup

    GET /v1/teams/{teamId}/projects/{projectId}/volumes/{volumeId}/backups/{backupId}

  • Read

    List workflows

    Lists all workflows for a project

    GET /v1/projects/{projectId}/workflows

  • Read

    List workflows

    Lists all workflows for a project

    GET /v1/teams/{teamId}/projects/{projectId}/workflows

  • Read

    Get workflow

    Gets details about a workflow

    GET /v1/projects/{projectId}/workflows/{workflowId}

  • Read

    Get workflow

    Gets details about a workflow

    GET /v1/teams/{teamId}/projects/{projectId}/workflows/{workflowId}

  • Read

    List workflow runs

    Lists runs of a workflow

    GET /v1/projects/{projectId}/workflows/{workflowId}/runs

  • Read

    List workflow runs

    Lists runs of a workflow

    GET /v1/teams/{teamId}/projects/{projectId}/workflows/{workflowId}/runs

  • Read

    Get workflow run details

    Get information about the given workflow run

    GET /v1/projects/{projectId}/workflows/{workflowId}/runs/{runId}

  • Read

    Get workflow run details

    Get information about the given workflow run

    GET /v1/teams/{teamId}/projects/{projectId}/workflows/{workflowId}/runs/{runId}

  • Read

    List regions

    Lists available project regions

    GET /v1/regions

  • Read

    List global secrets

    Gets a list of global secrets

    GET /v1/secrets

  • Read

    List global secrets

    Gets a list of global secrets

    GET /v1/teams/{teamId}/secrets

  • Read

    Get global secret

    Get a global secret including its contents

    GET /v1/secrets/{secretId}

  • Read

    Get global secret

    Get a global secret including its contents

    GET /v1/teams/{teamId}/secrets/{secretId}

  • Read

    List security policies

    Lists policies for the team or organization in creation order. Pagination count is the number of policies on this page. Authentication values are redacted.

    GET /v1/security-policies

  • Read

    List security policies

    Lists policies for the team or organization in creation order. Pagination count is the number of policies on this page. Authentication values are redacted.

    GET /v1/teams/{teamId}/security-policies

  • Read

    Preview team security policy

    Evaluates a team policy as enabled without saving it. Organization REST preview is not available; organization tokens must select a team through the team-scoped path. Service details are limited to readable projects. Aggregate counts may include inaccessible services; outcome counts sample at most 2,000 matches and compilationErrorCount describes the returned page. Body page/perPage paginate services; pagination.count is the total visible match count. Authentication values are redacted. Existing policies may retain passwords using empty strings.

    POST /v1/security-policies/preview

  • Read

    Preview team security policy

    Evaluates a team policy as enabled without saving it. Organization REST preview is not available; organization tokens must select a team through the team-scoped path. Service details are limited to readable projects. Aggregate counts may include inaccessible services; outcome counts sample at most 2,000 matches and compilationErrorCount describes the returned page. Body page/perPage paginate services; pagination.count is the total visible match count. Authentication values are redacted. Existing policies may retain passwords using empty strings.

    POST /v1/teams/{teamId}/security-policies/preview

  • Read

    Get security policy

    Gets policy details with passwords and authentication header values redacted.

    GET /v1/security-policies/{securityPolicyId}

  • Read

    Get security policy

    Gets policy details with passwords and authentication header values redacted.

    GET /v1/teams/{teamId}/security-policies/{securityPolicyId}

  • Read

    Get security policy spec

    Gets editable name, description and complete spec, including Basic Auth passwords and authentication header values. Requires readSpec permission.

    GET /v1/security-policies/{securityPolicyId}/spec

  • Read

    Get security policy spec

    Gets editable name, description and complete spec, including Basic Auth passwords and authentication header values. Requires readSpec permission.

    GET /v1/teams/{teamId}/security-policies/{securityPolicyId}/spec

  • Read

    List tags

    List the resource tags for this entity.

    GET /v1/tags

  • Read

    List tags

    List the resource tags for this entity.

    GET /v1/teams/{teamId}/tags

  • Read

    Get tag

    View details for a given resource tag.

    GET /v1/tags/{resourceTagId}

  • Read

    Get tag

    View details for a given resource tag.

    GET /v1/teams/{teamId}/tags/{resourceTagId}

  • Read

    List teams

    Gets a list of teams belonging to the authenticated org.

    GET /v1/teams

  • Read

    Get team

    Gets information about a team belonging to the authenticated org.

    GET /v1/teams/{teamId}

  • Read

    List team members

    Gets a list of members belonging to a team.

    GET /v1/teams/{teamId}/members

  • Read

    List team roles

    Gets a list of platform roles for a team.

    GET /v1/teams/{teamId}/roles

  • Read

    Get team role

    Gets details about a specific platform role.

    GET /v1/teams/{teamId}/roles/{roleId}

  • Read

    List team role members

    Gets a list of members assigned to a platform role in a team.

    GET /v1/teams/{teamId}/roles/{roleId}/members

  • Read

    List templates

    Get a list of templates

    GET /v1/templates

  • Read

    List templates

    Get a list of templates

    GET /v1/teams/{teamId}/templates

  • Read

    Get template

    Get information about the given template.

    GET /v1/templates/{templateId}

  • Read

    Get template

    Get information about the given template.

    GET /v1/teams/{teamId}/templates/{templateId}

  • Read

    List template runs

    Get a list of template runs

    GET /v1/templates/{templateId}/runs

  • Read

    List template runs

    Get a list of template runs

    GET /v1/teams/{teamId}/templates/{templateId}/runs

  • Read

    Get template run

    Get information about the given template run.

    GET /v1/templates/{templateId}/runs/{templateRunId}

  • Read

    Get template run

    Get information about the given template run.

    GET /v1/teams/{teamId}/templates/{templateId}/runs/{templateRunId}

  • Read

    List API tokens

    Lists API tokens belonging to the authenticated org or team, newest first. Only active tokens are returned unless the `all` query parameter is set.

    GET /v1/tokens

  • Read

    List API tokens

    Lists API tokens belonging to the authenticated org or team, newest first. Only active tokens are returned unless the `all` query parameter is set.

    GET /v1/teams/{teamId}/tokens

  • Read

    List workload identities

    Lists the workload identities saved to this account.

    GET /v1/workload-identities

  • Read

    List workload identities

    Lists the workload identities saved to this account.

    GET /v1/teams/{teamId}/workload-identities

  • Read

    Get workload identity

    Retrieves a workload identity by ID.

    GET /v1/workload-identities/{workloadIdentityId}

  • Read

    Get workload identity

    Retrieves a workload identity by ID.

    GET /v1/teams/{teamId}/workload-identities/{workloadIdentityId}

  • Write

    Add backup destination

    Adds a new backup destination to this account.

    POST /v1/backup-destinations

  • Write

    Add backup destination

    Adds a new backup destination to this account.

    POST /v1/teams/{teamId}/backup-destinations

  • Write

    Patch backup destination

    Updates a backup destination.

    PATCH /v1/backup-destinations/{backupDestinationId}

  • Write

    Patch backup destination

    Updates a backup destination.

    PATCH /v1/teams/{teamId}/backup-destinations/{backupDestinationId}

  • Write

    Create cluster

    Creates a new cluster.

    POST /v1/cloud-providers/clusters

  • Write

    Put cluster

    Creates or update a cluster.

    PUT /v1/cloud-providers/clusters

  • Write

    Create cluster

    Creates a new cluster.

    POST /v1/teams/{teamId}/cloud-providers/clusters

  • Write

    Put cluster

    Creates or update a cluster.

    PUT /v1/teams/{teamId}/cloud-providers/clusters

  • Write

    Patch cluster

    Updates a cluster.

    PATCH /v1/cloud-providers/clusters/{clusterId}

  • Write

    Patch cluster

    Updates a cluster.

    PATCH /v1/teams/{teamId}/cloud-providers/clusters/{clusterId}

  • Write

    Cordon cluster node

    Cordon a node on the cluster to prevent new pods from scheduling on it.

    POST /v1/cloud-providers/clusters/{clusterId}/nodes/{nodeId}/cordon

  • Write

    Cordon cluster node

    Cordon a node on the cluster to prevent new pods from scheduling on it.

    POST /v1/teams/{teamId}/cloud-providers/clusters/{clusterId}/nodes/{nodeId}/cordon

  • Write

    Uncordon cluster node

    Uncordon a node on the cluster if it was previously cordoned.

    POST /v1/cloud-providers/clusters/{clusterId}/nodes/{nodeId}/uncordon

  • Write

    Uncordon cluster node

    Uncordon a node on the cluster if it was previously cordoned.

    POST /v1/teams/{teamId}/cloud-providers/clusters/{clusterId}/nodes/{nodeId}/uncordon

  • Write

    Create integration

    Creates a new integration.

    POST /v1/cloud-providers/integrations

  • Write

    Put integration

    Creates or updates a integration.

    PUT /v1/cloud-providers/integrations

  • Write

    Create integration

    Creates a new integration.

    POST /v1/teams/{teamId}/cloud-providers/integrations

  • Write

    Put integration

    Creates or updates a integration.

    PUT /v1/teams/{teamId}/cloud-providers/integrations

  • Write

    Patch integration

    Updates a integration.

    PATCH /v1/cloud-providers/integrations/{integrationId}

  • Write

    Patch integration

    Updates a integration.

    PATCH /v1/teams/{teamId}/cloud-providers/integrations/{integrationId}

  • Write

    Install workload identity provider

    Triggers installation of the OIDC provider or workload identity pool resources on the given cloud provider integration account. This is required once per cloud account before creating managed workload identities.

    POST /v1/cloud-providers/integrations/{integrationId}/workload-identity-provider/install

  • Write

    Install workload identity provider

    Triggers installation of the OIDC provider or workload identity pool resources on the given cloud provider integration account. This is required once per cloud account before creating managed workload identities.

    POST /v1/teams/{teamId}/cloud-providers/integrations/{integrationId}/workload-identity-provider/install

  • Write

    Create new domain

    Registers a new domain

    POST /v1/domains

  • Write

    Create new domain

    Registers a new domain

    POST /v1/teams/{teamId}/domains

  • Write

    Update domain

    Update domain options such as minimum TLS protocol version

    PATCH /v1/domains/{domain}

  • Write

    Update domain

    Update domain options such as minimum TLS protocol version

    PATCH /v1/teams/{teamId}/domains/{domain}

  • Write

    Import domain certificate

    Import a certificate for the domain

    POST /v1/domains/{domain}/import

  • Write

    Import domain certificate

    Import a certificate for the domain

    POST /v1/teams/{teamId}/domains/{domain}/import

  • Write

    Add subdomain

    Adds a new subdomain to the domain.

    POST /v1/domains/{domain}/subdomains

  • Write

    Put subdomain

    Updates subdomain to the domain.

    PUT /v1/domains/{domain}/subdomains

  • Write

    Add subdomain

    Adds a new subdomain to the domain.

    POST /v1/teams/{teamId}/domains/{domain}/subdomains

  • Write

    Put subdomain

    Updates subdomain to the domain.

    PUT /v1/teams/{teamId}/domains/{domain}/subdomains

  • Write

    Assign service to subdomain

    Assigns a service port to the given subdomain

    POST /v1/domains/{domain}/subdomains/{subdomain}/assign

  • Write

    Assign service to subdomain

    Assigns a service port to the given subdomain

    POST /v1/teams/{teamId}/domains/{domain}/subdomains/{subdomain}/assign

  • Write

    Enable CDN on a subdomain

    Enables a CDN integration on the given subdomain

    POST /v1/domains/{domain}/subdomains/{subdomain}/cdn/enable

  • Write

    Enable CDN on a subdomain

    Enables a CDN integration on the given subdomain

    POST /v1/teams/{teamId}/domains/{domain}/subdomains/{subdomain}/cdn/enable

  • Write

    Import subdomain certificate

    Import a certificate for a subdomain of a domain using individual certificates.

    POST /v1/domains/{domain}/subdomains/{subdomain}/certificate/import

  • Write

    Import subdomain certificate

    Import a certificate for a subdomain of a domain using individual certificates.

    POST /v1/teams/{teamId}/domains/{domain}/subdomains/{subdomain}/certificate/import

  • Write

    Update geo routing configuration

    Updates the geo routing configuration for a geo-routed subdomain.

    PATCH /v1/domains/{domain}/subdomains/{subdomain}/geo-routing

  • Write

    Update geo routing configuration

    Updates the geo routing configuration for a geo-routed subdomain.

    PATCH /v1/teams/{teamId}/domains/{domain}/subdomains/{subdomain}/geo-routing

  • Write

    Add subdomain path

    Adds a new path to the subdomain.

    POST /v1/domains/{domain}/subdomains/{subdomain}/paths

  • Write

    Add subdomain path

    Adds a new path to the subdomain.

    POST /v1/teams/{teamId}/domains/{domain}/subdomains/{subdomain}/paths

  • Write

    Update subdomain path

    Update a subdomain path.

    POST /v1/domains/{domain}/subdomains/{subdomain}/paths/{subdomainPath}

  • Write

    Update subdomain path

    Update a subdomain path.

    POST /v1/teams/{teamId}/domains/{domain}/subdomains/{subdomain}/paths/{subdomainPath}

  • Write

    Assign subdomain path

    Assign a subdomain path to a port.

    POST /v1/domains/{domain}/subdomains/{subdomain}/paths/{subdomainPath}/assign

  • Write

    Assign subdomain path

    Assign a subdomain path to a port.

    POST /v1/teams/{teamId}/domains/{domain}/subdomains/{subdomain}/paths/{subdomainPath}/assign

  • Write

    Verify domain

    Attempts to verify the domain

    POST /v1/domains/{domain}/verify

  • Write

    Verify domain

    Attempts to verify the domain

    POST /v1/teams/{teamId}/domains/{domain}/verify

  • Write

    Create egress IP

    Creates a new egress IP

    POST /v1/egress-ips

  • Write

    Put egress IP

    Creates or updates an egress IP

    PUT /v1/egress-ips

  • Write

    Create egress IP

    Creates a new egress IP

    POST /v1/teams/{teamId}/egress-ips

  • Write

    Put egress IP

    Creates or updates an egress IP

    PUT /v1/teams/{teamId}/egress-ips

  • Write

    Patch egress IP

    Updates an egress IP

    PATCH /v1/egress-ips/{egressIpId}

  • Write

    Patch egress IP

    Updates an egress IP

    PATCH /v1/teams/{teamId}/egress-ips/{egressIpId}

  • Write

    Create encryption configuration

    Creates an inactive configuration after validating KMS access. GCP cross-project creation defers that check and returns a generated service-account email: grant it KMS access before activation. Requires customer-managed keys to be enabled.

    POST /v1/encryption/configurations

  • Write

    Create encryption configuration

    Creates an inactive configuration after validating KMS access. GCP cross-project creation defers that check and returns a generated service-account email: grant it KMS access before activation. Requires customer-managed keys to be enabled.

    POST /v1/teams/{teamId}/encryption/configurations

  • Write

    Activate encryption configuration

    Revalidates KMS access and atomically selects this configuration for new encryption. Other configurations are retained for decryption. Repeated activation revalidates the selected configuration. Requires customer-managed keys to be enabled.

    POST /v1/encryption/configurations/{encryptionConfigurationId}/activate

  • Write

    Activate encryption configuration

    Revalidates KMS access and atomically selects this configuration for new encryption. Other configurations are retained for decryption. Repeated activation revalidates the selected configuration. Requires customer-managed keys to be enabled.

    POST /v1/teams/{teamId}/encryption/configurations/{encryptionConfigurationId}/activate

  • Write

    Deactivate encryption configuration

    Switches new encryption to Northflank-managed envelope encryption. Retains the old configuration for decryption and does not migrate existing data. Only the active configuration can be deactivated; repeated requests fail once it is inactive. Requires customer-managed keys to be enabled.

    POST /v1/encryption/configurations/{encryptionConfigurationId}/deactivate

  • Write

    Deactivate encryption configuration

    Switches new encryption to Northflank-managed envelope encryption. Retains the old configuration for decryption and does not migrate existing data. Only the active configuration can be deactivated; repeated requests fail once it is inactive. Requires customer-managed keys to be enabled.

    POST /v1/teams/{teamId}/encryption/configurations/{encryptionConfigurationId}/deactivate

  • Write

    Enable Northflank-managed envelope encryption

    Opts into Northflank-managed envelope encryption for new writes without supplying a customer KMS configuration. Repeated requests are a no-op once enabled. Existing data is unchanged; DEKs created after opt-in can later be migrated to a customer KMS. If a customer configuration is active, deactivate it to switch to Northflank-managed envelope encryption; no separate opt-in request is needed. Requires customer-managed keys to be enabled.

    POST /v1/encryption/northflank-managed/activate

  • Write

    Enable Northflank-managed envelope encryption

    Opts into Northflank-managed envelope encryption for new writes without supplying a customer KMS configuration. Repeated requests are a no-op once enabled. Existing data is unchanged; DEKs created after opt-in can later be migrated to a customer KMS. If a customer configuration is active, deactivate it to switch to Northflank-managed envelope encryption; no separate opt-in request is needed. Requires customer-managed keys to be enabled.

    POST /v1/teams/{teamId}/encryption/northflank-managed/activate

  • Write

    Create gradual rollout strategy

    Creates a new gradual rollout strategy.

    POST /v1/gradual-rollout-strategies

  • Write

    Create or update gradual rollout strategy

    Creates or updates a gradual rollout strategy.

    PUT /v1/gradual-rollout-strategies

  • Write

    Create gradual rollout strategy

    Creates a new gradual rollout strategy.

    POST /v1/teams/{teamId}/gradual-rollout-strategies

  • Write

    Create or update gradual rollout strategy

    Creates or updates a gradual rollout strategy.

    PUT /v1/teams/{teamId}/gradual-rollout-strategies

  • Write

    Update gradual rollout strategy

    Updates a gradual rollout strategy.

    PATCH /v1/gradual-rollout-strategies/{gradualRolloutStrategyId}

  • Write

    Update gradual rollout strategy

    Updates a gradual rollout strategy.

    PATCH /v1/teams/{teamId}/gradual-rollout-strategies/{gradualRolloutStrategyId}

  • Write

    Create audit log sink

    Creates a new audit log sink.

    POST /v1/integrations/audit-log-sinks

  • Write

    Create audit log sink

    Creates a new audit log sink.

    POST /v1/teams/{teamId}/integrations/audit-log-sinks

  • Write

    Patch audit log sink

    Partially updates an audit log sink. Fields not included in the payload retain their existing values.

    PATCH /v1/integrations/audit-log-sinks/{sinkId}

  • Write

    Patch audit log sink

    Partially updates an audit log sink. Fields not included in the payload retain their existing values.

    PATCH /v1/teams/{teamId}/integrations/audit-log-sinks/{sinkId}

  • Write

    Resume audit log sink

    Resumes exports for a paused audit log sink.

    POST /v1/integrations/audit-log-sinks/{sinkId}/resume

  • Write

    Resume audit log sink

    Resumes exports for a paused audit log sink.

    POST /v1/teams/{teamId}/integrations/audit-log-sinks/{sinkId}/resume

  • Write

    Create log sink

    Creates a new log sink.

    POST /v1/integrations/log-sinks

  • Write

    Create log sink

    Creates a new log sink.

    POST /v1/teams/{teamId}/integrations/log-sinks

  • Write

    Resume log sink

    Resumes a paused log sink.

    POST /v1/integrations/log-sinks/{logSinkId}/resume

  • Write

    Resume log sink

    Resumes a paused log sink.

    POST /v1/teams/{teamId}/integrations/log-sinks/{logSinkId}/resume

  • Write

    Update log sink

    Updates the settings for a log sink.

    POST /v1/integrations/log-sinks/{logSinkId}/settings

  • Write

    Update log sink

    Updates the settings for a log sink.

    POST /v1/teams/{teamId}/integrations/log-sinks/{logSinkId}/settings

  • Write

    Create notification integration

    Create a new notification integration.

    POST /v1/integrations/notifications

  • Write

    Create notification integration

    Create a new notification integration.

    POST /v1/teams/{teamId}/integrations/notifications

  • Write

    Update notification integration

    Updates a notification integration

    POST /v1/integrations/notifications/{notificationId}

  • Write

    Update notification integration

    Updates a notification integration

    POST /v1/teams/{teamId}/integrations/notifications/{notificationId}

  • Write

    Add registry

    Adds a new set of container registry credentials to this account.

    POST /v1/integrations/registries

  • Write

    Add registry

    Adds a new set of container registry credentials to this account.

    POST /v1/teams/{teamId}/integrations/registries

  • Write

    Update registry

    Updates a set of registry credential data.

    PATCH /v1/integrations/registries/{credentialId}

  • Write

    Update registry

    Updates a set of registry credential data.

    PATCH /v1/teams/{teamId}/integrations/registries/{credentialId}

  • Write

    Add SSH identity

    Adds a new SSH identity to this account.

    POST /v1/integrations/ssh-identities

  • Write

    Add SSH identity

    Adds a new SSH identity to this account.

    POST /v1/teams/{teamId}/integrations/ssh-identities

  • Write

    Create or update SSH identity

    Creates or updates SSH identity data.

    PUT /v1/integrations/ssh-identities/{identityId}

  • Write

    Update SSH identity

    Updates SSH identity data.

    PATCH /v1/integrations/ssh-identities/{identityId}

  • Write

    Create or update SSH identity

    Creates or updates SSH identity data.

    PUT /v1/teams/{teamId}/integrations/ssh-identities/{identityId}

  • Write

    Update SSH identity

    Updates SSH identity data.

    PATCH /v1/teams/{teamId}/integrations/ssh-identities/{identityId}

  • Write

    Generate VCS token

    Generate a token for a specific VCS link.

    POST /v1/integrations/vcs/custom/{customVCSId}/token/{vcsLinkId}

  • Write

    Generate VCS token

    Generate a token for a specific VCS link.

    POST /v1/teams/{teamId}/integrations/vcs/custom/{customVCSId}/token/{vcsLinkId}

  • Write

    Create VCS link session

    Starts a CLI-driven flow to link a version control account. Returns a URL to open in a browser to authorize the link, and a session id to poll for completion.

    POST /v1/integrations/vcs/link-sessions

  • Write

    Create VCS link session

    Starts a CLI-driven flow to link a version control account. Returns a URL to open in a browser to authorize the link, and a session id to poll for completion.

    POST /v1/teams/{teamId}/integrations/vcs/link-sessions

  • Write

    Create load balancer

    Creates a new load balancer

    POST /v1/load-balancers

  • Write

    Put load balancer

    Creates or updates a load balancer

    PUT /v1/load-balancers

  • Write

    Create load balancer

    Creates a new load balancer

    POST /v1/teams/{teamId}/load-balancers

  • Write

    Put load balancer

    Creates or updates a load balancer

    PUT /v1/teams/{teamId}/load-balancers

  • Write

    Patch load balancer

    Updates a load balancer

    PATCH /v1/load-balancers/{loadBalancerId}

  • Write

    Patch load balancer

    Updates a load balancer

    PATCH /v1/teams/{teamId}/load-balancers/{loadBalancerId}

  • Write

    Create network policy

    Creates a new network policy for this account.

    POST /v1/network-policies

  • Write

    Create network policy

    Creates a new network policy for this account.

    POST /v1/teams/{teamId}/network-policies

  • Write

    Update network policy

    Updates an existing network policy.

    PATCH /v1/network-policies/{networkPolicyId}

  • Write

    Update network policy

    Updates an existing network policy.

    PATCH /v1/teams/{teamId}/network-policies/{networkPolicyId}

  • Write

    Create org role

    Creates a new platform role for the authenticated org.

    POST /v1/org-roles

  • Write

    Create or update org role

    Creates role or updates all user-editable fields on a platform role for the authenticated org.

    PUT /v1/org-roles

  • Write

    Update org role

    Partially updates a platform role for the authenticated org.

    PATCH /v1/org-roles/{roleId}

  • Write

    Add member to org role

    Adds a user to a platform role in the authenticated org.

    POST /v1/org-roles/{roleId}/members

  • Write

    Create project

    Creates a new project.

    POST /v1/projects

  • Write

    Create or update project

    Creates or updates a project.

    PUT /v1/projects

  • Write

    Create project

    Creates a new project.

    POST /v1/teams/{teamId}/projects

  • Write

    Create or update project

    Creates or updates a project.

    PUT /v1/teams/{teamId}/projects

  • Write

    Update project

    Updates a project.

    PATCH /v1/projects/{projectId}

  • Write

    Update project

    Updates a project.

    PATCH /v1/teams/{teamId}/projects/{projectId}

  • Write

    Create addon

    Creates a new addon

    POST /v1/projects/{projectId}/addons

  • Write

    Put addon

    Creates or updates an addon

    PUT /v1/projects/{projectId}/addons

  • Write

    Create addon

    Creates a new addon

    POST /v1/teams/{teamId}/projects/{projectId}/addons

  • Write

    Put addon

    Creates or updates an addon

    PUT /v1/teams/{teamId}/projects/{projectId}/addons

  • Write

    Patch addon

    Updates an addon

    PATCH /v1/projects/{projectId}/addons/{addonId}

  • Write

    Patch addon

    Updates an addon

    PATCH /v1/teams/{teamId}/projects/{projectId}/addons/{addonId}

  • Write

    Create addon backup schedule

    Create a new backup schedule for an addon.

    POST /v1/projects/{projectId}/addons/{addonId}/backup-schedules

  • Write

    Create addon backup schedule

    Create a new backup schedule for an addon.

    POST /v1/teams/{teamId}/projects/{projectId}/addons/{addonId}/backup-schedules

  • Write

    Backup addon

    Initiates a backup for the given addon

    POST /v1/projects/{projectId}/addons/{addonId}/backups

  • Write

    Backup addon

    Initiates a backup for the given addon

    POST /v1/teams/{teamId}/projects/{projectId}/addons/{addonId}/backups

  • Write

    Restore addon backup

    Restores the given addon to the given backup state.

    POST /v1/projects/{projectId}/addons/{addonId}/backups/{backupId}/restore

  • Write

    Restore addon backup

    Restores the given addon to the given backup state.

    POST /v1/teams/{teamId}/projects/{projectId}/addons/{addonId}/backups/{backupId}/restore

  • Write

    Retain backup

    Flags a temporary backup generated by a backup schedule to be retained indefinitely rather than being deleted after the expiry date.

    POST /v1/projects/{projectId}/addons/{addonId}/backups/{backupId}/retain

  • Write

    Retain backup

    Flags a temporary backup generated by a backup schedule to be retained indefinitely rather than being deleted after the expiry date.

    POST /v1/teams/{teamId}/projects/{projectId}/addons/{addonId}/backups/{backupId}/retain

  • Write

    Import addon backup

    Imports a database from an external archive or existing live database.

    POST /v1/projects/{projectId}/addons/{addonId}/import

  • Write

    Import addon backup

    Imports a database from an external archive or existing live database.

    POST /v1/teams/{teamId}/projects/{projectId}/addons/{addonId}/import

  • Write

    Update addon network settings

    Updates the network settings for the addon.

    POST /v1/projects/{projectId}/addons/{addonId}/network-settings

  • Write

    Update addon network settings

    Updates the network settings for the addon.

    POST /v1/teams/{teamId}/projects/{projectId}/addons/{addonId}/network-settings

  • Write

    Resume addon

    Resume the given addon if it is paused.

    POST /v1/projects/{projectId}/addons/{addonId}/resume

  • Write

    Resume addon

    Resume the given addon if it is paused.

    POST /v1/teams/{teamId}/projects/{projectId}/addons/{addonId}/resume

  • Write

    Scale addon resources

    Modifies the allocated resources for the given addon.

    POST /v1/projects/{projectId}/addons/{addonId}/scale

  • Write

    Scale addon resources

    Modifies the allocated resources for the given addon.

    POST /v1/teams/{teamId}/projects/{projectId}/addons/{addonId}/scale

  • Write

    Rotate addon secrets

    Starts a secret rotation for the given addon. New credentials are created with the same permissions; the old credentials remain valid until the rotation is finalised.

    POST /v1/projects/{projectId}/addons/{addonId}/secret-rotation

  • Write

    Rotate addon secrets

    Starts a secret rotation for the given addon. New credentials are created with the same permissions; the old credentials remain valid until the rotation is finalised.

    POST /v1/teams/{teamId}/projects/{projectId}/addons/{addonId}/secret-rotation

  • Write

    Finalise addon secret rotation

    Finalises an in-progress secret rotation for the given addon. The old credentials are permanently removed.

    POST /v1/projects/{projectId}/addons/{addonId}/secret-rotation/finalise

  • Write

    Finalise addon secret rotation

    Finalises an in-progress secret rotation for the given addon. The old credentials are permanently removed.

    POST /v1/teams/{teamId}/projects/{projectId}/addons/{addonId}/secret-rotation/finalise

  • Write

    Update addon security rules

    Updates the security rules for the addon.

    POST /v1/projects/{projectId}/addons/{addonId}/security

  • Write

    Update addon security rules

    Updates the security rules for the addon.

    POST /v1/teams/{teamId}/projects/{projectId}/addons/{addonId}/security

  • Write

    Upgrade addon version

    Upgrades the addon to a new version.

    POST /v1/projects/{projectId}/addons/{addonId}/version

  • Write

    Upgrade addon version

    Upgrades the addon to a new version.

    POST /v1/teams/{teamId}/projects/{projectId}/addons/{addonId}/version

  • Write

    Create external addon

    Creates a new external addon (third-party cloud resource provisioned via OpenTofu)

    POST /v1/projects/{projectId}/external-addons

  • Write

    Create external addon

    Creates a new external addon (third-party cloud resource provisioned via OpenTofu)

    POST /v1/teams/{teamId}/projects/{projectId}/external-addons

  • Write

    Update external addon

    Updates configuration for an external addon

    PATCH /v1/projects/{projectId}/external-addons/{externalAddonId}

  • Write

    Update external addon

    Updates configuration for an external addon

    PATCH /v1/teams/{teamId}/projects/{projectId}/external-addons/{externalAddonId}

  • Write

    Create harness

    Creates a new harness

    POST /v1/projects/{projectId}/harnesses

  • Write

    Put harness

    Creates or updates a harness

    PUT /v1/projects/{projectId}/harnesses

  • Write

    Create harness

    Creates a new harness

    POST /v1/teams/{teamId}/projects/{projectId}/harnesses

  • Write

    Put harness

    Creates or updates a harness

    PUT /v1/teams/{teamId}/projects/{projectId}/harnesses

  • Write

    Patch harness

    Updates a harness

    PATCH /v1/projects/{projectId}/harnesses/{harnessId}

  • Write

    Patch harness

    Updates a harness

    PATCH /v1/teams/{teamId}/projects/{projectId}/harnesses/{harnessId}

  • Write

    Resume harness

    Resumes the given harness, restoring its deployment.

    POST /v1/projects/{projectId}/harnesses/{harnessId}/resume

  • Write

    Resume harness

    Resumes the given harness, restoring its deployment.

    POST /v1/teams/{teamId}/projects/{projectId}/harnesses/{harnessId}/resume

  • Write

    Prepare image upload

    Reserves a named image tag and returns five-minute direct-upload credentials. Supply the image ID to refresh the same reservation.

    POST /v1/projects/{projectId}/images/upload-credentials

  • Write

    Prepare image upload

    Reserves a named image tag and returns five-minute direct-upload credentials. Supply the image ID to refresh the same reservation.

    POST /v1/teams/{teamId}/projects/{projectId}/images/upload-credentials

  • Write

    Initialize project

    Assigns a region or cluster to a pending project.

    POST /v1/projects/{projectId}/initialize

  • Write

    Initialize project

    Assigns a region or cluster to a pending project.

    POST /v1/teams/{teamId}/projects/{projectId}/initialize

  • Write

    Create job

    Creates a new job (manual or cron based on settings.cron presence)

    POST /v1/projects/{projectId}/jobs

  • Write

    Put job

    Creates or updates a job (manual or cron based on settings.cron presence)

    PUT /v1/projects/{projectId}/jobs

  • Write

    Create job

    Creates a new job (manual or cron based on settings.cron presence)

    POST /v1/teams/{teamId}/projects/{projectId}/jobs

  • Write

    Put job

    Creates or updates a job (manual or cron based on settings.cron presence)

    PUT /v1/teams/{teamId}/projects/{projectId}/jobs

  • Write

    Create cron job

    Creates a new cron job

    POST /v1/projects/{projectId}/jobs/cron

  • Write

    Put cron job

    Creates or updates a cron job

    PUT /v1/projects/{projectId}/jobs/cron

  • Write

    Create cron job

    Creates a new cron job

    POST /v1/teams/{teamId}/projects/{projectId}/jobs/cron

  • Write

    Put cron job

    Creates or updates a cron job

    PUT /v1/teams/{teamId}/projects/{projectId}/jobs/cron

  • Write

    Patch cron job

    Updates a cron job

    PATCH /v1/projects/{projectId}/jobs/cron/{jobId}

  • Write

    Patch cron job

    Updates a cron job

    PATCH /v1/teams/{teamId}/projects/{projectId}/jobs/cron/{jobId}

  • Write

    Create manual job

    Creates a new manual job that only runs when initiated via the UI, CLI, API or JS client.

    POST /v1/projects/{projectId}/jobs/manual

  • Write

    Put manual job

    Creates or updates a new manual job that only runs when initiated via the UI, CLI, API or JS client.

    PUT /v1/projects/{projectId}/jobs/manual

  • Write

    Create manual job

    Creates a new manual job that only runs when initiated via the UI, CLI, API or JS client.

    POST /v1/teams/{teamId}/projects/{projectId}/jobs/manual

  • Write

    Put manual job

    Creates or updates a new manual job that only runs when initiated via the UI, CLI, API or JS client.

    PUT /v1/teams/{teamId}/projects/{projectId}/jobs/manual

  • Write

    Patch manual job

    Updates a new manual job that only runs when initiated via the UI, CLI, API or JS client.

    PATCH /v1/projects/{projectId}/jobs/manual/{jobId}

  • Write

    Patch manual job

    Updates a new manual job that only runs when initiated via the UI, CLI, API or JS client.

    PATCH /v1/teams/{teamId}/projects/{projectId}/jobs/manual/{jobId}

  • Write

    Patch job

    Updates a job (manual or cron based on current type and settings.cron)

    PATCH /v1/projects/{projectId}/jobs/{jobId}

  • Write

    Patch job

    Updates a job (manual or cron based on current type and settings.cron)

    PATCH /v1/teams/{teamId}/projects/{projectId}/jobs/{jobId}

  • Write

    Start job build

    Start a new build for the given job. Given a commit sha, it will build that commit.

    POST /v1/projects/{projectId}/jobs/{jobId}/build

  • Write

    Start job build

    Start a new build for the given job. Given a commit sha, it will build that commit.

    POST /v1/teams/{teamId}/projects/{projectId}/jobs/{jobId}/build

  • Write

    Edit job build arguments

    Sets build arguments for the given job.

    POST /v1/projects/{projectId}/jobs/{jobId}/build-arguments

  • Write

    Edit job build arguments

    Sets build arguments for the given job.

    POST /v1/teams/{teamId}/projects/{projectId}/jobs/{jobId}/build-arguments

  • Write

    Update job build options

    Updates the build options for a given job.

    POST /v1/projects/{projectId}/jobs/{jobId}/build-options

  • Write

    Update job build options

    Updates the build options for a given job.

    POST /v1/teams/{teamId}/projects/{projectId}/jobs/{jobId}/build-options

  • Write

    Update job build source

    Updates the version control source for a given job.

    POST /v1/projects/{projectId}/jobs/{jobId}/build-source

  • Write

    Update job build source

    Updates the version control source for a given job.

    POST /v1/teams/{teamId}/projects/{projectId}/jobs/{jobId}/build-source

  • Write

    Update job deployment

    Updates the deployment settings of the given job.

    POST /v1/projects/{projectId}/jobs/{jobId}/deployment

  • Write

    Update job deployment

    Updates the deployment settings of the given job.

    POST /v1/teams/{teamId}/projects/{projectId}/jobs/{jobId}/deployment

  • Write

    Update job health checks

    Updates health checks for the given job.

    POST /v1/projects/{projectId}/jobs/{jobId}/health-checks

  • Write

    Update job health checks

    Updates health checks for the given job.

    POST /v1/teams/{teamId}/projects/{projectId}/jobs/{jobId}/health-checks

  • Write

    Resume job

    Resumes the given job. Optionally takes several arguments to override resumed settings.

    POST /v1/projects/{projectId}/jobs/{jobId}/resume

  • Write

    Resume job

    Resumes the given job. Optionally takes several arguments to override resumed settings.

    POST /v1/teams/{teamId}/projects/{projectId}/jobs/{jobId}/resume

  • Write

    Run job

    Starts a new job run for the given job

    POST /v1/projects/{projectId}/jobs/{jobId}/runs

  • Write

    Run job

    Starts a new job run for the given job

    POST /v1/teams/{teamId}/projects/{projectId}/jobs/{jobId}/runs

  • Write

    Edit job runtime environment

    Sets the runtime environment for the given job.

    POST /v1/projects/{projectId}/jobs/{jobId}/runtime-environment

  • Write

    Edit job runtime environment

    Sets the runtime environment for the given job.

    POST /v1/teams/{teamId}/projects/{projectId}/jobs/{jobId}/runtime-environment

  • Write

    Scale job

    Modifies the scaling settings for the given job.

    POST /v1/projects/{projectId}/jobs/{jobId}/scale

  • Write

    Scale job

    Modifies the scaling settings for the given job.

    POST /v1/teams/{teamId}/projects/{projectId}/jobs/{jobId}/scale

  • Write

    Update job settings

    Updates settings for the job

    POST /v1/projects/{projectId}/jobs/{jobId}/settings

  • Write

    Update job settings

    Updates settings for the job

    POST /v1/teams/{teamId}/projects/{projectId}/jobs/{jobId}/settings

  • Write

    Suspend job

    Modify cron job to toggle suspending of its schedule.

    POST /v1/projects/{projectId}/jobs/{jobId}/suspend

  • Write

    Suspend job

    Modify cron job to toggle suspending of its schedule.

    POST /v1/teams/{teamId}/projects/{projectId}/jobs/{jobId}/suspend

  • Write

    Create AI model

    Create an AI model

    POST /v1/projects/{projectId}/llm-model-deployments

  • Write

    Create AI model

    Create an AI model

    POST /v1/teams/{teamId}/projects/{projectId}/llm-model-deployments

  • Write

    Update AI model

    Updates an AI model

    POST /v1/projects/{projectId}/llm-model-deployments/{llmModelDeploymentId}

  • Write

    Update AI model

    Updates an AI model

    POST /v1/teams/{teamId}/projects/{projectId}/llm-model-deployments/{llmModelDeploymentId}

  • Write

    Update preview template

    Update a given preview template.

    POST /v1/projects/{projectId}/pipelines/{pipelineId}/preview-envs

  • Write

    Update preview template

    Update a given preview template.

    POST /v1/teams/{teamId}/projects/{projectId}/pipelines/{pipelineId}/preview-envs

  • Write

    Run preview environment

    Run the given preview template.

    POST /v1/projects/{projectId}/pipelines/{pipelineId}/preview-envs/runs

  • Write

    Run preview environment

    Run the given preview template.

    POST /v1/teams/{teamId}/projects/{projectId}/pipelines/{pipelineId}/preview-envs/runs

  • Write

    Update release flow

    Updates a release flow

    POST /v1/projects/{projectId}/pipelines/{pipelineId}/release-flows/{stage}

  • Write

    Update release flow

    Updates a release flow

    POST /v1/teams/{teamId}/projects/{projectId}/pipelines/{pipelineId}/release-flows/{stage}

  • Write

    Run release flow

    Runs a given release flow with given arguments. This endpoint can be used as part of a CI pipeline to automatically trigger a release process.

    POST /v1/projects/{projectId}/pipelines/{pipelineId}/release-flows/{stage}/runs

  • Write

    Run release flow

    Runs a given release flow with given arguments. This endpoint can be used as part of a CI pipeline to automatically trigger a release process.

    POST /v1/teams/{teamId}/projects/{projectId}/pipelines/{pipelineId}/release-flows/{stage}/runs

  • Write

    Create preview blueprint

    Create a preview blueprint

    POST /v1/projects/{projectId}/preview-blueprints

  • Write

    Create preview blueprint

    Create a preview blueprint

    POST /v1/teams/{teamId}/projects/{projectId}/preview-blueprints

  • Write

    Update preview blueprint

    Updates a preview blueprint

    POST /v1/projects/{projectId}/preview-blueprints/{previewBlueprintId}

  • Write

    Update preview blueprint

    Updates a preview blueprint

    POST /v1/teams/{teamId}/projects/{projectId}/preview-blueprints/{previewBlueprintId}

  • Write

    Resume preview environment

    Resume a preview environment generated by a preview blueprint.

    POST /v1/projects/{projectId}/preview-blueprints/{previewBlueprintId}/previews/{previewId}/resume

  • Write

    Resume preview environment

    Resume a preview environment generated by a preview blueprint.

    POST /v1/teams/{teamId}/projects/{projectId}/preview-blueprints/{previewBlueprintId}/previews/{previewId}/resume

  • Write

    Run preview blueprint

    Runs a given preview blueprint with given arguments. This endpoint can be used as part of a CI pipeline to automatically create a preview environment.

    POST /v1/projects/{projectId}/preview-blueprints/{previewBlueprintId}/runs

  • Write

    Run preview blueprint

    Runs a given preview blueprint with given arguments. This endpoint can be used as part of a CI pipeline to automatically create a preview environment.

    POST /v1/teams/{teamId}/projects/{projectId}/preview-blueprints/{previewBlueprintId}/runs

  • Write

    Create project secret

    Creates a project secret with the specified payload

    POST /v1/projects/{projectId}/secrets

  • Write

    Put project secret

    Creates or updates a project secret with the specified payload

    PUT /v1/projects/{projectId}/secrets

  • Write

    Create project secret

    Creates a project secret with the specified payload

    POST /v1/teams/{teamId}/projects/{projectId}/secrets

  • Write

    Put project secret

    Creates or updates a project secret with the specified payload

    PUT /v1/teams/{teamId}/projects/{projectId}/secrets

  • Write

    Patch project secret

    Updates a project secret with the specified payload

    PATCH /v1/projects/{projectId}/secrets/{secretId}

  • Write

    Update project secret

    Update a project secret

    POST /v1/projects/{projectId}/secrets/{secretId}

  • Write

    Patch project secret

    Updates a project secret with the specified payload

    PATCH /v1/teams/{teamId}/projects/{projectId}/secrets/{secretId}

  • Write

    Update project secret

    Update a project secret

    POST /v1/teams/{teamId}/projects/{projectId}/secrets/{secretId}

  • Write

    Update project secret addon link

    Link an addon to a project secret or edit the settings of the linked addon.

    POST /v1/projects/{projectId}/secrets/{secretId}/addons/{addonId}

  • Write

    Update project secret addon link

    Link an addon to a project secret or edit the settings of the linked addon.

    POST /v1/teams/{teamId}/projects/{projectId}/secrets/{secretId}/addons/{addonId}

  • Write

    Create build service

    Creates a new build service.

    POST /v1/projects/{projectId}/services/build

  • Write

    Put build service

    Creates or updates a build service.

    PUT /v1/projects/{projectId}/services/build

  • Write

    Create build service

    Creates a new build service.

    POST /v1/teams/{teamId}/projects/{projectId}/services/build

  • Write

    Put build service

    Creates or updates a build service.

    PUT /v1/teams/{teamId}/projects/{projectId}/services/build

  • Write

    Patch build service

    Updates a build service.

    PATCH /v1/projects/{projectId}/services/build/{serviceId}

  • Write

    Patch build service

    Updates a build service.

    PATCH /v1/teams/{teamId}/projects/{projectId}/services/build/{serviceId}

  • Write

    Create combined service

    Creates a new combined service.

    POST /v1/projects/{projectId}/services/combined

  • Write

    Put combined service

    Creates or updates a combined service.

    PUT /v1/projects/{projectId}/services/combined

  • Write

    Create combined service

    Creates a new combined service.

    POST /v1/teams/{teamId}/projects/{projectId}/services/combined

  • Write

    Put combined service

    Creates or updates a combined service.

    PUT /v1/teams/{teamId}/projects/{projectId}/services/combined

  • Write

    Patch combined service

    Updates a combined service.

    PATCH /v1/projects/{projectId}/services/combined/{serviceId}

  • Write

    Patch combined service

    Updates a combined service.

    PATCH /v1/teams/{teamId}/projects/{projectId}/services/combined/{serviceId}

  • Write

    Create deployment service

    Creates a new deployment service.

    POST /v1/projects/{projectId}/services/deployment

  • Write

    Put deployment service

    Creates or updates a deployment service.

    PUT /v1/projects/{projectId}/services/deployment

  • Write

    Create deployment service

    Creates a new deployment service.

    POST /v1/teams/{teamId}/projects/{projectId}/services/deployment

  • Write

    Put deployment service

    Creates or updates a deployment service.

    PUT /v1/teams/{teamId}/projects/{projectId}/services/deployment

  • Write

    Patch deployment service

    Updates a deployment service.

    PATCH /v1/projects/{projectId}/services/deployment/{serviceId}

  • Write

    Patch deployment service

    Updates a deployment service.

    PATCH /v1/teams/{teamId}/projects/{projectId}/services/deployment/{serviceId}

  • Write

    Start service build

    Start a new build for the given combined or build service. Git build services require a branch or pull request. Bundle build services require a bundle URL and accept an optional branch and revision.

    POST /v1/projects/{projectId}/services/{serviceId}/build

  • Write

    Start service build

    Start a new build for the given combined or build service. Git build services require a branch or pull request. Bundle build services require a bundle URL and accept an optional branch and revision.

    POST /v1/teams/{teamId}/projects/{projectId}/services/{serviceId}/build

  • Write

    Edit service build arguments

    Sets the build arguments for the given service.

    POST /v1/projects/{projectId}/services/{serviceId}/build-arguments

  • Write

    Edit service build arguments

    Sets the build arguments for the given service.

    POST /v1/teams/{teamId}/projects/{projectId}/services/{serviceId}/build-arguments

  • Write

    Update service build options

    Updates the build options for a given service.

    POST /v1/projects/{projectId}/services/{serviceId}/build-options

  • Write

    Update service build options

    Updates the build options for a given service.

    POST /v1/teams/{teamId}/projects/{projectId}/services/{serviceId}/build-options

  • Write

    Update service build source

    Updates the version control source for a given build or combined service.

    POST /v1/projects/{projectId}/services/{serviceId}/build-source

  • Write

    Update service build source

    Updates the version control source for a given build or combined service.

    POST /v1/teams/{teamId}/projects/{projectId}/services/{serviceId}/build-source

  • Write

    Update service deployment

    Updates the deployment settings of the given service.

    POST /v1/projects/{projectId}/services/{serviceId}/deployment

  • Write

    Update service deployment

    Updates the deployment settings of the given service.

    POST /v1/teams/{teamId}/projects/{projectId}/services/{serviceId}/deployment

  • Write

    Update service health checks

    Updates health checks for the given service.

    POST /v1/projects/{projectId}/services/{serviceId}/health-checks

  • Write

    Update service health checks

    Updates health checks for the given service.

    POST /v1/teams/{teamId}/projects/{projectId}/services/{serviceId}/health-checks

  • Write

    Update service ports

    Updates the list of ports for the given service.

    POST /v1/projects/{projectId}/services/{serviceId}/ports

  • Write

    Update service ports

    Updates the list of ports for the given service.

    POST /v1/teams/{teamId}/projects/{projectId}/services/{serviceId}/ports

  • Write

    Resume service

    Resumes the given service. Optionally takes several arguments to override resumed settings.

    POST /v1/projects/{projectId}/services/{serviceId}/resume

  • Write

    Resume service

    Resumes the given service. Optionally takes several arguments to override resumed settings.

    POST /v1/teams/{teamId}/projects/{projectId}/services/{serviceId}/resume

  • Write

    Update service rollout configuration

    Updates the traffic split of the active gradual rollout. Only percentage based rollouts can be reconfigured. Setting the canary to 100% promotes the rollout.

    POST /v1/projects/{projectId}/services/{serviceId}/rollout/configuration

  • Write

    Update service rollout configuration

    Updates the traffic split of the active gradual rollout. Only percentage based rollouts can be reconfigured. Setting the canary to 100% promotes the rollout.

    POST /v1/teams/{teamId}/projects/{projectId}/services/{serviceId}/rollout/configuration

  • Write

    Promote service rollout

    Promotes the canary deployment of the active gradual rollout to stable, routing all traffic to it. This is idempotent: promoting an already promoted rollout succeeds without changing anything.

    POST /v1/projects/{projectId}/services/{serviceId}/rollout/promote

  • Write

    Promote service rollout

    Promotes the canary deployment of the active gradual rollout to stable, routing all traffic to it. This is idempotent: promoting an already promoted rollout succeeds without changing anything.

    POST /v1/teams/{teamId}/projects/{projectId}/services/{serviceId}/rollout/promote

  • Write

    Roll back service rollout

    Ends the active gradual rollout and redeploys the service from a previous deployment. Use the list service deployments endpoint to find the deployment to roll back to.

    POST /v1/projects/{projectId}/services/{serviceId}/rollout/rollback

  • Write

    Roll back service rollout

    Ends the active gradual rollout and redeploys the service from a previous deployment. Use the list service deployments endpoint to find the deployment to roll back to.

    POST /v1/teams/{teamId}/projects/{projectId}/services/{serviceId}/rollout/rollback

  • Write

    Edit service runtime environment

    Sets the runtime environment for the given service.

    POST /v1/projects/{projectId}/services/{serviceId}/runtime-environment

  • Write

    Edit service runtime environment

    Sets the runtime environment for the given service.

    POST /v1/teams/{teamId}/projects/{projectId}/services/{serviceId}/runtime-environment

  • Write

    Scale service

    Modifies the scaling settings for the given service.

    POST /v1/projects/{projectId}/services/{serviceId}/scale

  • Write

    Scale service

    Modifies the scaling settings for the given service.

    POST /v1/teams/{teamId}/projects/{projectId}/services/{serviceId}/scale

  • Write

    Create container snapshot

    Schedules a snapshot of a running deployment service pod. When no pod is provided, the service must have exactly one eligible pod. Repeated requests for an active pod return the existing snapshot.

    POST /v1/projects/{projectId}/services/{serviceId}/snapshots

  • Write

    Create container snapshot

    Schedules a snapshot of a running deployment service pod. When no pod is provided, the service must have exactly one eligible pod. Repeated requests for an active pod return the existing snapshot.

    POST /v1/teams/{teamId}/projects/{projectId}/services/{serviceId}/snapshots

  • Write

    Create volume

    Creates a volume with the specified payload

    POST /v1/projects/{projectId}/volumes

  • Write

    Create volume

    Creates a volume with the specified payload

    POST /v1/teams/{teamId}/projects/{projectId}/volumes

  • Write

    Update volume

    Update volume mounts and storage size

    POST /v1/projects/{projectId}/volumes/{volumeId}

  • Write

    Update volume

    Update volume mounts and storage size

    POST /v1/teams/{teamId}/projects/{projectId}/volumes/{volumeId}

  • Write

    Attach volume

    Attach a volume

    POST /v1/projects/{projectId}/volumes/{volumeId}/attach

  • Write

    Attach volume

    Attach a volume

    POST /v1/teams/{teamId}/projects/{projectId}/volumes/{volumeId}/attach

  • Write

    Create volume backup schedule

    Create a new snapshot backup schedule for a volume.

    POST /v1/projects/{projectId}/volumes/{volumeId}/backup-schedules

  • Write

    Create volume backup schedule

    Create a new snapshot backup schedule for a volume.

    POST /v1/teams/{teamId}/projects/{projectId}/volumes/{volumeId}/backup-schedules

  • Write

    Backup volume

    Initiates a backup for a given volume

    POST /v1/projects/{projectId}/volumes/{volumeId}/backups

  • Write

    Backup volume

    Initiates a backup for a given volume

    POST /v1/teams/{teamId}/projects/{projectId}/volumes/{volumeId}/backups

  • Write

    Create workflow

    Create a workflow

    POST /v1/projects/{projectId}/workflows

  • Write

    Create workflow

    Create a workflow

    POST /v1/teams/{teamId}/projects/{projectId}/workflows

  • Write

    Update workflow

    Updates a workflow

    POST /v1/projects/{projectId}/workflows/{workflowId}

  • Write

    Update workflow

    Updates a workflow

    POST /v1/teams/{teamId}/projects/{projectId}/workflows/{workflowId}

  • Write

    Run workflow

    Runs a given workflow with given arguments. This endpoint can be used as part of a CI pipeline to automatically trigger a release process.

    POST /v1/projects/{projectId}/workflows/{workflowId}/runs

  • Write

    Run workflow

    Runs a given workflow with given arguments. This endpoint can be used as part of a CI pipeline to automatically trigger a release process.

    POST /v1/teams/{teamId}/projects/{projectId}/workflows/{workflowId}/runs

  • Write

    Create global secret

    Creates a global secret with the specified payload

    POST /v1/secrets

  • Write

    Put global secret

    Creates or updates a global secret with the specified payload

    PUT /v1/secrets

  • Write

    Create global secret

    Creates a global secret with the specified payload

    POST /v1/teams/{teamId}/secrets

  • Write

    Put global secret

    Creates or updates a global secret with the specified payload

    PUT /v1/teams/{teamId}/secrets

  • Write

    Patch global secret

    Updates a global secret with the specified payload

    PATCH /v1/secrets/{secretId}

  • Write

    Patch global secret

    Updates a global secret with the specified payload

    PATCH /v1/teams/{teamId}/secrets/{secretId}

  • Write

    Trigger global secret dependents

    Runs the templates configured under the global secret’s dependents (when enabled).

    POST /v1/secrets/{secretId}/trigger-dependents

  • Write

    Trigger global secret dependents

    Runs the templates configured under the global secret’s dependents (when enabled).

    POST /v1/teams/{teamId}/secrets/{secretId}/trigger-dependents

  • Write

    Create security policy

    Creates a policy for the team or organization. Specify spec.enabled explicitly. Organization warning acknowledgements contain only code, winningDefaultPolicyId and shadowedEnforcedPolicyIds from the current 409 warnings.

    POST /v1/security-policies

  • Write

    Create security policy

    Creates a policy for the team or organization. Specify spec.enabled explicitly. Organization warning acknowledgements contain only code, winningDefaultPolicyId and shadowedEnforcedPolicyIds from the current 409 warnings.

    POST /v1/teams/{teamId}/security-policies

  • Write

    Add tag

    Add a new resource tag for this entity.

    POST /v1/tags

  • Write

    Put tag

    Update or create a resource tag.

    PUT /v1/tags

  • Write

    Add tag

    Add a new resource tag for this entity.

    POST /v1/teams/{teamId}/tags

  • Write

    Put tag

    Update or create a resource tag.

    PUT /v1/teams/{teamId}/tags

  • Write

    Update tag

    Patch a resource tag.

    PATCH /v1/tags/{resourceTagId}

  • Write

    Update tag

    Patch a resource tag.

    PATCH /v1/teams/{teamId}/tags/{resourceTagId}

  • Write

    Create team

    Creates a new team belonging to the authenticated org.

    POST /v1/teams

  • Write

    Update team

    Updates the description of a team belonging to the authenticated org.

    PATCH /v1/teams/{teamId}

  • Write

    Invite team member

    Invites a user to a team.

    POST /v1/teams/{teamId}/members

  • Write

    Create team role

    Creates a new platform role for a team.

    POST /v1/teams/{teamId}/roles

  • Write

    Create or update role

    Creates role or updates all user-editable fields on a platform role.

    PUT /v1/teams/{teamId}/roles

  • Write

    Update team role

    Updates a platform role for a team.

    PATCH /v1/teams/{teamId}/roles/{roleId}

  • Write

    Add member to team role

    Adds a user to a platform role in a team.

    POST /v1/teams/{teamId}/roles/{roleId}/members

  • Write

    Create template

    Create a template

    POST /v1/templates

  • Write

    Create template

    Create a template

    POST /v1/teams/{teamId}/templates

  • Write

    Update template

    Update a template

    POST /v1/templates/{templateId}

  • Write

    Update template

    Update a template

    POST /v1/teams/{teamId}/templates/{templateId}

  • Write

    Import OpenTofu state

    Moves state from another OpenTofu node in the same team to a node in this template. The state will be removed from the source node as such running the source node again may recreate resources.

    POST /v1/templates/{templateId}/opentofu/import-state

  • Write

    Import OpenTofu state

    Moves state from another OpenTofu node in the same team to a node in this template. The state will be removed from the source node as such running the source node again may recreate resources.

    POST /v1/teams/{teamId}/templates/{templateId}/opentofu/import-state

  • Write

    Run template

    Run a template

    POST /v1/templates/{templateId}/runs

  • Write

    Run template

    Run a template

    POST /v1/teams/{teamId}/templates/{templateId}/runs

  • Write

    Create workload identity

    Creates a new workload identity on this account. For managed roles using automatic provider setup, installation of the cloud resources is triggered automatically unless `noInstall=true` is passed.

    POST /v1/workload-identities

  • Write

    Create workload identity

    Creates a new workload identity on this account. For managed roles using automatic provider setup, installation of the cloud resources is triggered automatically unless `noInstall=true` is passed.

    POST /v1/teams/{teamId}/workload-identities

  • Write

    Update workload identity

    Updates a workload identity. For managed roles using automatic provider setup, installation of the cloud resources is triggered automatically unless `noInstall=true` is passed.

    PATCH /v1/workload-identities/{workloadIdentityId}

  • Write

    Update workload identity

    Updates a workload identity. For managed roles using automatic provider setup, installation of the cloud resources is triggered automatically unless `noInstall=true` is passed.

    PATCH /v1/teams/{teamId}/workload-identities/{workloadIdentityId}

  • Write

    Install workload identity

    Triggers installation of the managed cloud resources (IAM role/policy) for a workload identity. For identities using an existing role, this validates and records the role details.

    POST /v1/workload-identities/{workloadIdentityId}/install

  • Write

    Install workload identity

    Triggers installation of the managed cloud resources (IAM role/policy) for a workload identity. For identities using an existing role, this validates and records the role details.

    POST /v1/teams/{teamId}/workload-identities/{workloadIdentityId}/install

  • Destructive

    Delete backup destination

    Delete a backup destination.

    DELETE /v1/backup-destinations/{backupDestinationId}

  • Destructive

    Delete backup destination

    Delete a backup destination.

    DELETE /v1/teams/{teamId}/backup-destinations/{backupDestinationId}

  • Destructive

    Delete cluster

    Delete the given cluster. Fails if the cluster has associated projects. The first request tears down the cluster resources; once the cluster state is `deleted`, call this endpoint again to remove the cluster.

    DELETE /v1/cloud-providers/clusters/{clusterId}

  • Destructive

    Delete cluster

    Delete the given cluster. Fails if the cluster has associated projects. The first request tears down the cluster resources; once the cluster state is `deleted`, call this endpoint again to remove the cluster.

    DELETE /v1/teams/{teamId}/cloud-providers/clusters/{clusterId}

  • Destructive

    Drain cluster node

    Drain a node by evicting all running pods.

    POST /v1/cloud-providers/clusters/{clusterId}/nodes/{nodeId}/drain

  • Destructive

    Drain cluster node

    Drain a node by evicting all running pods.

    POST /v1/teams/{teamId}/cloud-providers/clusters/{clusterId}/nodes/{nodeId}/drain

  • Destructive

    Delete integration

    Delete the given integration. Fails if the integration is associated with existing clusters.

    DELETE /v1/cloud-providers/integrations/{integrationId}

  • Destructive

    Delete integration

    Delete the given integration. Fails if the integration is associated with existing clusters.

    DELETE /v1/teams/{teamId}/cloud-providers/integrations/{integrationId}

  • Destructive

    Delete container snapshot

    Soft-deletes an unreferenced terminal container snapshot.

    DELETE /v1/container-snapshots/{snapshotId}

  • Destructive

    Delete container snapshot

    Soft-deletes an unreferenced terminal container snapshot.

    DELETE /v1/teams/{teamId}/container-snapshots/{snapshotId}

  • Destructive

    Delete domain

    Deletes a domain and each of its registered subdomains.

    DELETE /v1/domains/{domain}

  • Destructive

    Delete domain

    Deletes a domain and each of its registered subdomains.

    DELETE /v1/teams/{teamId}/domains/{domain}

  • Destructive

    Delete subdomain

    Removes a subdomain from a domain.

    DELETE /v1/domains/{domain}/subdomains/{subdomain}

  • Destructive

    Delete subdomain

    Removes a subdomain from a domain.

    DELETE /v1/teams/{teamId}/domains/{domain}/subdomains/{subdomain}

  • Destructive

    Unassign subdomain

    Removes a subdomain from its assigned service

    DELETE /v1/domains/{domain}/subdomains/{subdomain}/assign

  • Destructive

    Unassign subdomain

    Removes a subdomain from its assigned service

    DELETE /v1/teams/{teamId}/domains/{domain}/subdomains/{subdomain}/assign

  • Destructive

    Remove CDN from a subdomain

    Removes the CDN integration from the given subdomain

    POST /v1/domains/{domain}/subdomains/{subdomain}/cdn/disable

  • Destructive

    Remove CDN from a subdomain

    Removes the CDN integration from the given subdomain

    POST /v1/teams/{teamId}/domains/{domain}/subdomains/{subdomain}/cdn/disable

  • Destructive

    Purge CDN cache for a subdomain

    Purges the CDN cache for the given subdomain

    POST /v1/domains/{domain}/subdomains/{subdomain}/cdn/purge

  • Destructive

    Purge CDN cache for a subdomain

    Purges the CDN cache for the given subdomain

    POST /v1/teams/{teamId}/domains/{domain}/subdomains/{subdomain}/cdn/purge

  • Destructive

    Delete subdomain path

    Delete a path.

    DELETE /v1/domains/{domain}/subdomains/{subdomain}/paths/{subdomainPath}

  • Destructive

    Delete subdomain path

    Delete a path.

    DELETE /v1/teams/{teamId}/domains/{domain}/subdomains/{subdomain}/paths/{subdomainPath}

  • Destructive

    Unassign subdomain path

    Unassign a subdomain path to a port.

    DELETE /v1/domains/{domain}/subdomains/{subdomain}/paths/{subdomainPath}/assign

  • Destructive

    Unassign subdomain path

    Unassign a subdomain path to a port.

    DELETE /v1/teams/{teamId}/domains/{domain}/subdomains/{subdomain}/paths/{subdomainPath}/assign

  • Destructive

    Delete egress IP

    Deletes the given egress IP.

    DELETE /v1/egress-ips/{egressIpId}

  • Destructive

    Delete egress IP

    Deletes the given egress IP.

    DELETE /v1/teams/{teamId}/egress-ips/{egressIpId}

  • Destructive

    Update encryption configuration options

    Replaces all DEK rotation and cache overrides. Omitted values revert to platform defaults; send options={} to reset all overrides. Values must satisfy platform bounds. Requires customer-managed keys to be enabled.

    PUT /v1/encryption/configurations/{encryptionConfigurationId}/options

  • Destructive

    Update encryption configuration options

    Replaces all DEK rotation and cache overrides. Omitted values revert to platform defaults; send options={} to reset all overrides. Values must satisfy platform bounds. Requires customer-managed keys to be enabled.

    PUT /v1/teams/{teamId}/encryption/configurations/{encryptionConfigurationId}/options

  • Destructive

    Update encryption configuration settings

    Replaces key coordinates and credentials after validating them. The provider cannot change. Previously activated configurations must still reach the same key; unused configurations may change keys. DEK options are preserved and must be updated through the options endpoint. Requires customer-managed keys to be enabled.

    PUT /v1/encryption/configurations/{encryptionConfigurationId}/settings

  • Destructive

    Update encryption configuration settings

    Replaces key coordinates and credentials after validating them. The provider cannot change. Previously activated configurations must still reach the same key; unused configurations may change keys. DEK options are preserved and must be updated through the options endpoint. Requires customer-managed keys to be enabled.

    PUT /v1/teams/{teamId}/encryption/configurations/{encryptionConfigurationId}/settings

  • Destructive

    Delete gradual rollout strategy

    Deletes a gradual rollout strategy. Any services still using it are detached first, which redeploys them without the rollout. Because that redeploys services, this also requires service update permission. Fails if a rollout is in progress on any of those services.

    DELETE /v1/gradual-rollout-strategies/{gradualRolloutStrategyId}

  • Destructive

    Delete gradual rollout strategy

    Deletes a gradual rollout strategy. Any services still using it are detached first, which redeploys them without the rollout. Because that redeploys services, this also requires service update permission. Fails if a rollout is in progress on any of those services.

    DELETE /v1/teams/{teamId}/gradual-rollout-strategies/{gradualRolloutStrategyId}

  • Destructive

    Put audit log sink

    Creates or fully replaces an audit log sink.

    PUT /v1/integrations/audit-log-sinks/{sinkId}

  • Destructive

    Delete audit log sink

    Soft-deletes the audit log sink.

    DELETE /v1/integrations/audit-log-sinks/{sinkId}

  • Destructive

    Put audit log sink

    Creates or fully replaces an audit log sink.

    PUT /v1/teams/{teamId}/integrations/audit-log-sinks/{sinkId}

  • Destructive

    Delete audit log sink

    Soft-deletes the audit log sink.

    DELETE /v1/teams/{teamId}/integrations/audit-log-sinks/{sinkId}

  • Destructive

    Pause audit log sink

    Pauses exports for the audit log sink.

    POST /v1/integrations/audit-log-sinks/{sinkId}/pause

  • Destructive

    Pause audit log sink

    Pauses exports for the audit log sink.

    POST /v1/teams/{teamId}/integrations/audit-log-sinks/{sinkId}/pause

  • Destructive

    Delete log sink

    Deletes a log sink.

    DELETE /v1/integrations/log-sinks/{logSinkId}

  • Destructive

    Delete log sink

    Deletes a log sink.

    DELETE /v1/teams/{teamId}/integrations/log-sinks/{logSinkId}

  • Destructive

    Pause log sink

    Pauses a given log sink.

    POST /v1/integrations/log-sinks/{logSinkId}/pause

  • Destructive

    Pause log sink

    Pauses a given log sink.

    POST /v1/teams/{teamId}/integrations/log-sinks/{logSinkId}/pause

  • Destructive

    Delete notification integration

    Deletes a notification integration

    DELETE /v1/integrations/notifications/{notificationId}

  • Destructive

    Delete notification integration

    Deletes a notification integration

    DELETE /v1/teams/{teamId}/integrations/notifications/{notificationId}

  • Destructive

    Delete registry

    Deletes a set of registry credential data.

    DELETE /v1/integrations/registries/{credentialId}

  • Destructive

    Delete registry

    Deletes a set of registry credential data.

    DELETE /v1/teams/{teamId}/integrations/registries/{credentialId}

  • Destructive

    Delete SSH identity

    Deletes an SSH identity.

    DELETE /v1/integrations/ssh-identities/{identityId}

  • Destructive

    Delete SSH identity

    Deletes an SSH identity.

    DELETE /v1/teams/{teamId}/integrations/ssh-identities/{identityId}

  • Destructive

    Delete load balancer

    Deletes the given load balancer.

    DELETE /v1/load-balancers/{loadBalancerId}

  • Destructive

    Delete load balancer

    Deletes the given load balancer.

    DELETE /v1/teams/{teamId}/load-balancers/{loadBalancerId}

  • Destructive

    Delete network policy

    Deletes a network policy and removes all associated CNPs from the cluster.

    DELETE /v1/network-policies/{networkPolicyId}

  • Destructive

    Delete network policy

    Deletes a network policy and removes all associated CNPs from the cluster.

    DELETE /v1/teams/{teamId}/network-policies/{networkPolicyId}

  • Destructive

    Delete org role

    Deletes a platform role from the authenticated org.

    DELETE /v1/org-roles/{roleId}

  • Destructive

    Remove member from org role

    Removes a user from a platform role in the authenticated org.

    DELETE /v1/org-roles/{roleId}/members/{memberId}

  • Destructive

    Delete project

    Delete the given project. Fails if the project isn't empty.

    DELETE /v1/projects/{projectId}

  • Destructive

    Delete project

    Delete the given project. Fails if the project isn't empty.

    DELETE /v1/teams/{teamId}/projects/{projectId}

  • Destructive

    Delete addon

    Deletes the given addon.

    DELETE /v1/projects/{projectId}/addons/{addonId}

  • Destructive

    Delete addon

    Deletes the given addon.

    DELETE /v1/teams/{teamId}/projects/{projectId}/addons/{addonId}

  • Destructive

    Delete addon backup schedule

    Deletes a backup schedule for an addon.

    DELETE /v1/projects/{projectId}/addons/{addonId}/backup-schedules/{scheduleId}

  • Destructive

    Delete addon backup schedule

    Deletes a backup schedule for an addon.

    DELETE /v1/teams/{teamId}/projects/{projectId}/addons/{addonId}/backup-schedules/{scheduleId}

  • Destructive

    Delete addon backup

    Deletes a given backup

    DELETE /v1/projects/{projectId}/addons/{addonId}/backups/{backupId}

  • Destructive

    Delete addon backup

    Deletes a given backup

    DELETE /v1/teams/{teamId}/projects/{projectId}/addons/{addonId}/backups/{backupId}

  • Destructive

    Abort backup

    Aborts the in progress backup.

    POST /v1/projects/{projectId}/addons/{addonId}/backups/{backupId}/abort

  • Destructive

    Abort backup

    Aborts the in progress backup.

    POST /v1/teams/{teamId}/projects/{projectId}/addons/{addonId}/backups/{backupId}/abort

  • Destructive

    Abort backup restore

    Aborts an in-progress backup restore.

    POST /v1/projects/{projectId}/addons/{addonId}/backups/{backupId}/abort-restore

  • Destructive

    Abort backup restore

    Aborts an in-progress backup restore.

    POST /v1/teams/{teamId}/projects/{projectId}/addons/{addonId}/backups/{backupId}/abort-restore

  • Destructive

    Pause addon

    Pause the given addon.

    POST /v1/projects/{projectId}/addons/{addonId}/pause

  • Destructive

    Pause addon

    Pause the given addon.

    POST /v1/teams/{teamId}/projects/{projectId}/addons/{addonId}/pause

  • Destructive

    Reset addon

    Reset the given addon.

    POST /v1/projects/{projectId}/addons/{addonId}/reset

  • Destructive

    Reset addon

    Reset the given addon.

    POST /v1/teams/{teamId}/projects/{projectId}/addons/{addonId}/reset

  • Destructive

    Restart addon

    Restart the given addon.

    POST /v1/projects/{projectId}/addons/{addonId}/restart

  • Destructive

    Restart addon

    Restart the given addon.

    POST /v1/teams/{teamId}/projects/{projectId}/addons/{addonId}/restart

  • Destructive

    Delete external addon

    Deletes an external addon and destroys the associated cloud resource

    DELETE /v1/projects/{projectId}/external-addons/{externalAddonId}

  • Destructive

    Delete external addon

    Deletes an external addon and destroys the associated cloud resource

    DELETE /v1/teams/{teamId}/projects/{projectId}/external-addons/{externalAddonId}

  • Destructive

    Delete harness

    Deletes the given harness.

    DELETE /v1/projects/{projectId}/harnesses/{harnessId}

  • Destructive

    Delete harness

    Deletes the given harness.

    DELETE /v1/teams/{teamId}/projects/{projectId}/harnesses/{harnessId}

  • Destructive

    Pause harness

    Pauses the given harness, scaling its deployment to zero.

    POST /v1/projects/{projectId}/harnesses/{harnessId}/pause

  • Destructive

    Pause harness

    Pauses the given harness, scaling its deployment to zero.

    POST /v1/teams/{teamId}/projects/{projectId}/harnesses/{harnessId}/pause

  • Destructive

    Restart harness

    Restarts the given harness.

    POST /v1/projects/{projectId}/harnesses/{harnessId}/restart

  • Destructive

    Restart harness

    Restarts the given harness.

    POST /v1/teams/{teamId}/projects/{projectId}/harnesses/{harnessId}/restart

  • Destructive

    Delete job

    Deletes the given job.

    DELETE /v1/projects/{projectId}/jobs/{jobId}

  • Destructive

    Delete job

    Deletes the given job.

    DELETE /v1/teams/{teamId}/projects/{projectId}/jobs/{jobId}

  • Destructive

    Abort job build

    Aborts the given job build

    DELETE /v1/projects/{projectId}/jobs/{jobId}/build/{buildId}

  • Destructive

    Abort job build

    Aborts the given job build

    DELETE /v1/teams/{teamId}/projects/{projectId}/jobs/{jobId}/build/{buildId}

  • Destructive

    Pause job

    Pause the given job.

    POST /v1/projects/{projectId}/jobs/{jobId}/pause

  • Destructive

    Pause job

    Pause the given job.

    POST /v1/teams/{teamId}/projects/{projectId}/jobs/{jobId}/pause

  • Destructive

    Abort job run

    Aborts the given job run

    DELETE /v1/projects/{projectId}/jobs/{jobId}/runs/{runId}

  • Destructive

    Abort job run

    Aborts the given job run

    DELETE /v1/teams/{teamId}/projects/{projectId}/jobs/{jobId}/runs/{runId}

  • Destructive

    Delete AI model

    Delete an AI model

    DELETE /v1/projects/{projectId}/llm-model-deployments/{llmModelDeploymentId}

  • Destructive

    Delete AI model

    Delete an AI model

    DELETE /v1/teams/{teamId}/projects/{projectId}/llm-model-deployments/{llmModelDeploymentId}

  • Destructive

    Delete preview environment

    Delete a preview environment generated by a preview template.

    DELETE /v1/projects/{projectId}/pipelines/{pipelineId}/preview-envs/previews/{previewId}

  • Destructive

    Delete preview environment

    Delete a preview environment generated by a preview template.

    DELETE /v1/teams/{teamId}/projects/{projectId}/pipelines/{pipelineId}/preview-envs/previews/{previewId}

  • Destructive

    Abort release flow run

    Abort the given release flow run

    POST /v1/projects/{projectId}/pipelines/{pipelineId}/release-flows/{stage}/runs/{runId}/abort

  • Destructive

    Abort release flow run

    Abort the given release flow run

    POST /v1/teams/{teamId}/projects/{projectId}/pipelines/{pipelineId}/release-flows/{stage}/runs/{runId}/abort

  • Destructive

    Delete preview blueprint

    Delete a preview blueprint

    DELETE /v1/projects/{projectId}/preview-blueprints/{previewBlueprintId}

  • Destructive

    Delete preview blueprint

    Delete a preview blueprint

    DELETE /v1/teams/{teamId}/projects/{projectId}/preview-blueprints/{previewBlueprintId}

  • Destructive

    Delete preview environment

    Delete a preview environment generated by a preview blueprint.

    DELETE /v1/projects/{projectId}/preview-blueprints/{previewBlueprintId}/previews/{previewId}

  • Destructive

    Delete preview environment

    Delete a preview environment generated by a preview blueprint.

    DELETE /v1/teams/{teamId}/projects/{projectId}/preview-blueprints/{previewBlueprintId}/previews/{previewId}

  • Destructive

    Pause preview environment

    Pause a preview environment generated by a preview blueprint.

    POST /v1/projects/{projectId}/preview-blueprints/{previewBlueprintId}/previews/{previewId}/pause

  • Destructive

    Pause preview environment

    Pause a preview environment generated by a preview blueprint.

    POST /v1/teams/{teamId}/projects/{projectId}/preview-blueprints/{previewBlueprintId}/previews/{previewId}/pause

  • Destructive

    Reset preview environment expiry

    Reset the expiry of a preview environment generated by a preview blueprint.

    POST /v1/projects/{projectId}/preview-blueprints/{previewBlueprintId}/previews/{previewId}/reset

  • Destructive

    Reset preview environment expiry

    Reset the expiry of a preview environment generated by a preview blueprint.

    POST /v1/teams/{teamId}/projects/{projectId}/preview-blueprints/{previewBlueprintId}/previews/{previewId}/reset

  • Destructive

    Abort preview blueprint run

    Abort the given preview blueprint run

    POST /v1/projects/{projectId}/preview-blueprints/{previewBlueprintId}/runs/{runId}/abort

  • Destructive

    Abort preview blueprint run

    Abort the given preview blueprint run

    POST /v1/teams/{teamId}/projects/{projectId}/preview-blueprints/{previewBlueprintId}/runs/{runId}/abort

  • Destructive

    Delete project secret

    Delete a project secret

    DELETE /v1/projects/{projectId}/secrets/{secretId}

  • Destructive

    Delete project secret

    Delete a project secret

    DELETE /v1/teams/{teamId}/projects/{projectId}/secrets/{secretId}

  • Destructive

    Unlink addon from project secret

    Unlinks an addon from the project secret.

    DELETE /v1/projects/{projectId}/secrets/{secretId}/addons/{addonId}

  • Destructive

    Unlink addon from project secret

    Unlinks an addon from the project secret.

    DELETE /v1/teams/{teamId}/projects/{projectId}/secrets/{secretId}/addons/{addonId}

  • Destructive

    Delete service

    Deletes the given service.

    DELETE /v1/projects/{projectId}/services/{serviceId}

  • Destructive

    Delete service

    Deletes the given service.

    DELETE /v1/teams/{teamId}/projects/{projectId}/services/{serviceId}

  • Destructive

    Clear the build cache of a service

    Clears the build cache of a given combined or build service.

    DELETE /v1/projects/{projectId}/services/{serviceId}/build-cache

  • Destructive

    Clear the build cache of a service

    Clears the build cache of a given combined or build service.

    DELETE /v1/teams/{teamId}/projects/{projectId}/services/{serviceId}/build-cache

  • Destructive

    Abort service build

    Aborts the given service build

    DELETE /v1/projects/{projectId}/services/{serviceId}/build/{buildId}

  • Destructive

    Abort service build

    Aborts the given service build

    DELETE /v1/teams/{teamId}/projects/{projectId}/services/{serviceId}/build/{buildId}

  • Destructive

    Pause service

    Pause the given service.

    POST /v1/projects/{projectId}/services/{serviceId}/pause

  • Destructive

    Pause service

    Pause the given service.

    POST /v1/teams/{teamId}/projects/{projectId}/services/{serviceId}/pause

  • Destructive

    Delete service per-replica volume group

    Fully deletes a removed per-replica statefulSet volume for the given service: all of its orphaned PVCs and the volume definition. The volume must first be removed from the service.

    DELETE /v1/projects/{projectId}/services/{serviceId}/per-replica-volumes/volume/{volumeId}

  • Destructive

    Delete service per-replica volume group

    Fully deletes a removed per-replica statefulSet volume for the given service: all of its orphaned PVCs and the volume definition. The volume must first be removed from the service.

    DELETE /v1/teams/{teamId}/projects/{projectId}/services/{serviceId}/per-replica-volumes/volume/{volumeId}

  • Destructive

    Delete service per-replica volume PVC

    Deletes one orphaned per-replica statefulSet volume PVC — a scaled-down ordinal, or a replica of a removed volume. Replicas still bound to a running instance are refused with 409.

    DELETE /v1/projects/{projectId}/services/{serviceId}/per-replica-volumes/volume/{volumeId}/replica/{ordinal}

  • Destructive

    Delete service per-replica volume PVC

    Deletes one orphaned per-replica statefulSet volume PVC — a scaled-down ordinal, or a replica of a removed volume. Replicas still bound to a running instance are refused with 409.

    DELETE /v1/teams/{teamId}/projects/{projectId}/services/{serviceId}/per-replica-volumes/volume/{volumeId}/replica/{ordinal}

  • Destructive

    Restart service

    Restarts the given service.

    POST /v1/projects/{projectId}/services/{serviceId}/restart

  • Destructive

    Restart service

    Restarts the given service.

    POST /v1/teams/{teamId}/projects/{projectId}/services/{serviceId}/restart

  • Destructive

    Delete volume

    Deletes this volume and its associated data.

    DELETE /v1/projects/{projectId}/volumes/{volumeId}

  • Destructive

    Delete volume

    Deletes this volume and its associated data.

    DELETE /v1/teams/{teamId}/projects/{projectId}/volumes/{volumeId}

  • Destructive

    Delete volume backup schedule

    Deletes a snapshot backup schedule for a volume.

    DELETE /v1/projects/{projectId}/volumes/{volumeId}/backup-schedules/{scheduleId}

  • Destructive

    Delete volume backup schedule

    Deletes a snapshot backup schedule for a volume.

    DELETE /v1/teams/{teamId}/projects/{projectId}/volumes/{volumeId}/backup-schedules/{scheduleId}

  • Destructive

    Delete volume backup

    Delete the volume backup

    DELETE /v1/projects/{projectId}/volumes/{volumeId}/backups/{backupId}

  • Destructive

    Delete volume backup

    Delete the volume backup

    DELETE /v1/teams/{teamId}/projects/{projectId}/volumes/{volumeId}/backups/{backupId}

  • Destructive

    Detach volume

    Detach a volume

    POST /v1/projects/{projectId}/volumes/{volumeId}/detach

  • Destructive

    Detach volume

    Detach a volume

    POST /v1/teams/{teamId}/projects/{projectId}/volumes/{volumeId}/detach

  • Destructive

    Abort workflow run

    Abort the given workflow run

    POST /v1/projects/{projectId}/workflows/{workflowId}/runs/{runId}/abort

  • Destructive

    Abort workflow run

    Abort the given workflow run

    POST /v1/teams/{teamId}/projects/{projectId}/workflows/{workflowId}/runs/{runId}/abort

  • Destructive

    Delete global secret

    Delete a global secret

    DELETE /v1/secrets/{secretId}

  • Destructive

    Delete global secret

    Delete a global secret

    DELETE /v1/teams/{teamId}/secrets/{secretId}

  • Destructive

    Put security policy

    Creates or replaces a policy identified by its name-derived ID. Requires both create and update permissions, including when creating. Supply the complete spec and all authentication values. Omitted optional configuration is reset; deleting policies cannot be replaced. Organization warning acknowledgements contain only code, winningDefaultPolicyId and shadowedEnforcedPolicyIds from current 409 warnings.

    PUT /v1/security-policies

  • Destructive

    Put security policy

    Creates or replaces a policy identified by its name-derived ID. Requires both create and update permissions, including when creating. Supply the complete spec and all authentication values. Omitted optional configuration is reset; deleting policies cannot be replaced. Organization warning acknowledgements contain only code, winningDefaultPolicyId and shadowedEnforcedPolicyIds from current 409 warnings.

    PUT /v1/teams/{teamId}/security-policies

  • Destructive

    Patch security policy

    Updates metadata or replaces the complete spec. The ID is unchanged by name edits. Empty passwords retain existing credentials for the same username; header values must be supplied. Read the complete configuration from /spec before editing a redacted policy. Organization warning acknowledgements contain only code, winningDefaultPolicyId and shadowedEnforcedPolicyIds from current 409 warnings.

    PATCH /v1/security-policies/{securityPolicyId}

  • Destructive

    Delete security policy

    Requests asynchronous removal of the policy and its applied controls. Deleting and deletion_error policies remain visible until removal completes. Repeated requests preserve the existing deletion request.

    DELETE /v1/security-policies/{securityPolicyId}

  • Destructive

    Patch security policy

    Updates metadata or replaces the complete spec. The ID is unchanged by name edits. Empty passwords retain existing credentials for the same username; header values must be supplied. Read the complete configuration from /spec before editing a redacted policy. Organization warning acknowledgements contain only code, winningDefaultPolicyId and shadowedEnforcedPolicyIds from current 409 warnings.

    PATCH /v1/teams/{teamId}/security-policies/{securityPolicyId}

  • Destructive

    Delete security policy

    Requests asynchronous removal of the policy and its applied controls. Deleting and deletion_error policies remain visible until removal completes. Repeated requests preserve the existing deletion request.

    DELETE /v1/teams/{teamId}/security-policies/{securityPolicyId}

  • Destructive

    Delete tag

    Delete a resource tag.

    DELETE /v1/tags/{resourceTagId}

  • Destructive

    Delete tag

    Delete a resource tag.

    DELETE /v1/teams/{teamId}/tags/{resourceTagId}

  • Destructive

    Delete team

    Deletes a team belonging to the authenticated org.

    DELETE /v1/teams/{teamId}

  • Destructive

    Remove team member

    Removes a member from a team.

    DELETE /v1/teams/{teamId}/members/{memberId}

  • Destructive

    Delete team role

    Deletes a platform role from a team.

    DELETE /v1/teams/{teamId}/roles/{roleId}

  • Destructive

    Remove member from team role

    Removes a user from a platform role in a team.

    DELETE /v1/teams/{teamId}/roles/{roleId}/members/{memberId}

  • Destructive

    Delete template

    Delete a template

    DELETE /v1/templates/{templateId}

  • Destructive

    Delete template

    Delete a template

    DELETE /v1/teams/{teamId}/templates/{templateId}

  • Destructive

    Abort template run

    Abort the given template run.

    POST /v1/templates/{templateId}/runs/{templateRunId}/abort

  • Destructive

    Abort template run

    Abort the given template run.

    POST /v1/teams/{teamId}/templates/{templateId}/runs/{templateRunId}/abort

  • Destructive

    Rotate a key on an API token

    Creates a new key for an API token and sets all other keys to expire.

    POST /v1/tokens/{tokenId}/keys

  • Destructive

    Rotate a key on an API token

    Creates a new key for an API token and sets all other keys to expire.

    POST /v1/teams/{teamId}/tokens/{tokenId}/keys

  • Destructive

    Delete a key from an API token

    Removes a key from an API token.

    DELETE /v1/tokens/{tokenId}/keys/{keyId}

  • Destructive

    Delete a key from an API token

    Removes a key from an API token.

    DELETE /v1/teams/{teamId}/tokens/{tokenId}/keys/{keyId}

  • Destructive

    Delete workload identity

    Deletes a workload identity.

    DELETE /v1/workload-identities/{workloadIdentityId}

  • Destructive

    Delete workload identity

    Deletes a workload identity.

    DELETE /v1/teams/{teamId}/workload-identities/{workloadIdentityId}

See How connections work for access and permissions, or browse all integrations.

Reference date: October 29, 2026. Northflank API docs.