Northflank integrationNorthflank logo

Northflank integration for AI agents.

Northflank integration for AI agents with secure authentication and server-side credential injection. Open Connector runs the OAuth, seals the token in an encrypted vault, and serves Northflank tools to your agent over MCP or a typed API — credentials injected server-side, every call audited, nothing leaving your infrastructure. Open source (AGPL-3.0) and self-hostable.

What your agents can do

Real Northflank actions, managed and audited.

Your user connects Northflank once; your agent can then run AI agents, services, databases, and GPUs in secure microVMs. One governed path from commit to production, on our cloud or your own — scoped to the OAuth permissions you grant and the tool allowlist you configure. Every action is least-privilege and written to a tamper-evident audit trail.

  1. 1

    Your user grants Northflank access once (OAuth) — the token lands in the vault.

  2. 2

    Your agent calls a tool over MCP or the typed API; Open Connector injects the credential server-side.

  3. 3

    Every routed call appends a hash-chained audit record — nothing leaves your infra.

Tools & triggers

Supported Northflank tools.

724 tools are generated from the published Northflank catalog. Descriptions are plain text; each action remains subject to its configured authentication and tool allowlist.

Showing 724 tools. All published catalog entries are included in this page's server-rendered HTML.

Delete backup destination
Delete a backup destination.
Backup Destinations
Delete cluster
Delete the given cluster. Fails if the cluster has associated projects.
Cloud Providersorg
Delete integration
Delete the given integration. Fails if the integration is associated with existing clusters.
Cloud Providersorg
Delete domain
Deletes a domain and each of its registered subdomains.
Domains
Delete subdomain
Removes a subdomain from a domain.
Domains
Unassign subdomain
Removes a subdomain from its assigned service
Domains
Delete subdomain path
Delete a path.
Domains
Unassign subdomain path
Unassign a subdomain path to a port.
Domains
Delete egress IP
Deletes the given egress IP.
Egress IPs
Delete gradual rollout strategy
Deletes a gradual rollout strategy.
Rollout Strategies
Delete log sink
Deletes a log sink.
Integrations
Delete notification integration
Deletes a notification integration
Integrations
Delete registry
Deletes a set of registry credential data.
Integrations
Delete SSH identity
Deletes an SSH identity.
Integrations
Delete load balancer
Deletes the given load balancer.
Load Balancers
Remove team member
Removes a member from a team.
Team Membersteam
Delete network policy
Deletes a network policy and removes all associated CNPs from the cluster.
Network Policies
Delete org role
Deletes a platform role from the authenticated org.
Org Rolesorg
Remove member from org role
Removes a user from a platform role in the authenticated org.
Org Rolesorg
Delete addon
Deletes the given addon.
Addonsproject
Delete addon backup schedule
Deletes a backup schedule for an addon.
Addonsproject
Delete addon backup
Deletes a given backup
Addonsproject
Delete external addon
Deletes an external addon and destroys the associated cloud resource
External Addonsproject
Delete harness
Deletes the given harness.
Harnessesproject
Delete job
Deletes the given job.
Jobsproject
Abort job build
Aborts the given job build
Jobsproject
Abort job run
Aborts the given job run
Jobsproject
Delete AI model
Delete an AI model
AI Modelsproject
Delete preview environment
Delete a preview environment generated by a preview template.
Pipelinesproject
Delete preview blueprint
Delete a preview blueprint
Preview Blueprintsproject
Delete preview environment
Delete a preview environment generated by a preview blueprint.
Preview Blueprintsproject
Delete project
Delete the given project. Fails if the project isn't empty.
Projects
Delete project secret
Delete a project secret
Secretsproject
Unlink addon from project secret
Unlinks an addon from the project secret.
Secretsproject
Delete service
Deletes the given service.
Servicesproject
Abort service build
Aborts the given service build
Servicesproject
Clear the build cache of a service
Clears the build cache of a given combined or build service.
Servicesproject
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.
Servicesproject
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.
Servicesproject
Delete volume
Deletes this volume and its associated data.
Volumesproject
Delete volume backup
Delete the volume backup
Volumesproject
Delete team role
Deletes a platform role from a team.
Team Rolesteam
Remove member from team role
Removes a user from a platform role in a team.
Team Rolesteam
Delete global secret
Delete a global secret
Secrets
Delete tag
Delete a resource tag.
Tags
Delete template
Delete a template
Templates
Delete backup destination
Delete a backup destination.
Backup Destinationsteam
Delete cluster
Delete the given cluster. Fails if the cluster has associated projects.
Cloud Providersteam
Delete integration
Delete the given integration. Fails if the integration is associated with existing clusters.
Cloud Providersteam
Delete domain
Deletes a domain and each of its registered subdomains.
Domainsteam
Delete subdomain
Removes a subdomain from a domain.
Domainsteam
Unassign subdomain
Removes a subdomain from its assigned service
Domainsteam
Delete subdomain path
Delete a path.
Domainsteam
Unassign subdomain path
Unassign a subdomain path to a port.
Domainsteam
Delete egress IP
Deletes the given egress IP.
Egress IPsteam
Delete gradual rollout strategy
Deletes a gradual rollout strategy.
Rollout Strategiesteam
Delete log sink
Deletes a log sink.
Integrationsteam
Delete notification integration
Deletes a notification integration
Integrationsteam
Delete registry
Deletes a set of registry credential data.
Integrationsteam
Delete SSH identity
Deletes an SSH identity.
Integrationsteam
Delete load balancer
Deletes the given load balancer.
Load Balancersteam
Delete network policy
Deletes a network policy and removes all associated CNPs from the cluster.
Network Policiesteam
Delete project
Delete the given project. Fails if the project isn't empty.
Projectsteam
Delete addon
Deletes the given addon.
Addonsproject
Delete addon backup schedule
Deletes a backup schedule for an addon.
Addonsproject
Delete addon backup
Deletes a given backup
Addonsproject
Delete external addon
Deletes an external addon and destroys the associated cloud resource
External Addonsproject
Delete harness
Deletes the given harness.
Harnessesproject
Delete job
Deletes the given job.
Jobsproject
Abort job build
Aborts the given job build
Jobsproject
Abort job run
Aborts the given job run
Jobsproject
Delete AI model
Delete an AI model
AI Modelsproject
Delete preview environment
Delete a preview environment generated by a preview template.
Pipelinesproject
Delete preview blueprint
Delete a preview blueprint
Preview Blueprintsproject
Delete preview environment
Delete a preview environment generated by a preview blueprint.
Preview Blueprintsproject
Delete project secret
Delete a project secret
Secretsproject
Unlink addon from project secret
Unlinks an addon from the project secret.
Secretsproject
Delete service
Deletes the given service.
Servicesproject
Abort service build
Aborts the given service build
Servicesproject
Clear the build cache of a service
Clears the build cache of a given combined or build service.
Servicesproject
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.
Servicesproject
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.
Servicesproject
Delete volume
Deletes this volume and its associated data.
Volumesproject
Delete volume backup
Delete the volume backup
Volumesproject
Delete global secret
Delete a global secret
Secretsteam
Delete tag
Delete a resource tag.
Tagsteam
Delete template
Delete a template
Templatesteam
Delete workload identity
Deletes a workload identity.
Integrationsteam
Delete workload identity
Deletes a workload identity.
Integrations
Health check
Returns api service status
Miscellaneous
List addon types
Gets information about the available addon types
Addons
Get current authentication info
Returns details about the authentication material used in this request.
Auth
List backup destinations
Lists the backup destinations saved to this account. Does not display secrets.
Backup Destinations
Get backup destination
View a backup destination, including secrets.
Backup Destinations
List destinations backups
Lists the backups associated with a backup destinations.
Backup Destinations
List invoices
Lists finalized invoices.
Billingorg
Get invoice
Gets details about a given invoice.
Billingorg
List usage
Lists hourly usage entries.
Billingorg
Get usage
Gets usage details for a given billing hour.
Billingorg
List providers
Lists supported cloud providers
Cloud Providers
List clusters
Lists clusters for the authenticated user or team.
Cloud Providersorg
Get cluster
Get information about the given cluster
Cloud Providersorg
List cluster nodes
Get a list of nodes for the given cluster
Cloud Providersorg
List integrations
Lists integrations for the authenticated user or team.
Cloud Providersorg
Get integration
Get information about the given integration
Cloud Providersorg
Get workload identity provider status
Checks whether the OIDC/workload identity provider resources have been installed on the given cloud provider integration account.
Integrations
List provider node types
Lists supported cloud provider node types
Cloud Providersteamorg
List provider regions
Lists supported cloud provider regions
Cloud Providersteamorg
List org directory groups
Lists the Directory Sync directory groups for the authenticated org.
Org Rolesorg
List directory group members
Lists the users who are members of the org via a specific Directory Sync group.
Org Rolesorg
Get DNS ID
Returns the partially random string used when generating host names for the authenticated account.
Miscellaneous
List domains
Lists available domains
Domains
Get domain
Gets details about domain
Domains
Get domain certificate
Retrieve certificate data for a domain to verify its contents.
Domains
Get subdomain
Gets details about the given subdomain
Domains
List subdomain paths
List paths for a given subdomain.
Domains
Get subdomain path
Get subdomain path details.
Domains
List egress IPs
Gets a list of egress IPs belonging to the team
Egress IPs
Get egress IP
Gets information about the given egress IP
Egress IPs
List log sinks
Gets a list of log sinks added to this account.
Integrations
Get log sink details
Gets details about a given log sink.
Integrations
List notification integrations
Lists notification integrations for the authenticated user or team.
Integrations
Get notification integration
Get details about a notification integration.
Integrations
List registries
Lists the container registry credentials saved to this account. Does not display secrets.
Integrations
Get registry
Views a set of registry credential data.
Integrations
List SSH identities
Lists the SSH identities saved to this account. Does not display SSH public keys.
Integrations
Get SSH identity
Views SSH identity data including public keys.
Integrations
List VCS providers
Lists linked version control providers
Integrations
Get VCS link session
Gets the status of a version control link session, for polling until completion.
Integrations
List repositories
Gets a list of repositories accessible to this account
Integrations
List branches
Gets a list of branches for the repo
Integrations
List load balancers
Gets a list of load balancers belonging to the team
Load Balancers
Get load balancer
Gets information about the given load balancer
Load Balancers
Get logs for a resource
Get logs for any Northflank resource
AddonsJobsServices
List team members
Gets a list of members belonging to a team.
Team Membersteam
Get network policy
Get details of a network policy.
Network Policies
Get OpenTofu job logs
Get logs for an OpenTofu job
OpenTofu
List org members
Gets a list of members belonging to the authenticated org.
Org Membersorg
List org roles
Gets a list of platform roles for the authenticated org.
Org Rolesorg
Get org role
Gets details about a specific org platform role.
Org Rolesorg
List org role members
Gets a list of members assigned to a platform role in the authenticated org.
Org Rolesorg
List plans
Lists available billing plans
Miscellaneous
List projects
Lists projects for the authenticated user or team.
Projects
List addons
Gets a list of addons belonging to the project
Addonsproject
Get addon
Gets information about the given addon
Addonsproject
Get addon backup schedules
Gets details about an addon's backup schedules
Addonsproject
List addon backups
Returns a list of backups for the given addon.
Addonsproject
Get addon backup
Gets details about a given backup.
Addonsproject
Get backup download link
Generates a temporary download link for downloading the given backup.
Addonsproject
Get addon backup logs
Get logs for an addon backup
Addonsproject
List addon backup restores
Gets a list of restores for the given backup.
Addonsproject
Get addon restore logs
Get logs for an addon restore
Addonsproject
List addon containers
Gets a list of containers for the given addon.
Addonsproject
Get addon credentials
Returns the credentials for connecting to the given addon.
Addonsproject
Get addon logs
Get logs for an addon
Addonsproject
Get addon metrics
Get metrics for an addon
Addonsproject
List addon restores
Returns a list of restores for the given addon.
Addonsproject
Get addon version details
Gets details about the current addon version including available upgrades and upgrade history.
Addonsproject
List external addons
Gets a list of external addons belonging to the project
External Addonsproject
Get external addon
Gets information about the given external addon
External Addonsproject
List harnesses
Gets a list of harnesses belonging to the project
Harnessesproject
Get harness
Gets information about the given harness
Harnessesproject
Get harness logs
Get logs for a harness
Harnessesproject
List jobs
Gets a list of jobs belonging to the project
Jobsproject
Get job
Gets information about the given job
Jobsproject
Get job branches
Gets information about the branches of the given job.
Jobsproject
List job builds
Lists builds for the given job.
Jobsproject
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.
Jobsproject
Get job build argument details
Get details about the build arguments accessible by the given job. Also requires the permission 'Project > Secrets > General > Read'
Jobsproject
Get job build
Gets information about a build for the job
Jobsproject
Get job build logs
Get logs for a job build
Jobsproject
Get job build metrics
Get metrics for a job build
Jobsproject
List job containers
Gets a list of containers for the given job.
Jobsproject
Get job deployment
Gets information about the deployment of the given job.
Jobsproject
Get job health checks
Lists the health checks for the given job.
Jobsproject
Get job logs
Get logs for a job
Jobsproject
Get job metrics
Get metrics for a job
Jobsproject
Get job pull requests
Gets information about the pull-requests of the given job.
Jobsproject
Get job runs
Fetches run history for the given job
Jobsproject
Get run details
Returns data about the given job run
Jobsproject
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.
Jobsproject
Get job runtime environment details
Get details about the runtime environment accessible by the given job. Also requires the permission 'Project > Secrets > General > Read'
Jobsproject
List AI models
Lists all AI models for a project
AI Modelsproject
Get AI model
Gets details about an AI model
AI Modelsproject
List pipelines
Lists all pipelines for a project
Pipelinesproject
Get pipeline
Get details about a pipeline
Pipelinesproject
Get preview template
Get information about the given preview template.
Pipelinesproject
List preview environments
Get a list of active preview environments for a template
Pipelinesproject
List preview template runs
Get a list of preview template runs
Pipelinesproject
Get preview template run
Get information about the given preview template run.
Pipelinesproject
Get release flow
Gets details about a release flow
Pipelinesproject
List release flow runs
Lists runs of a release flow
Pipelinesproject
Get release flow run details
Get information about the given release flow run
Pipelinesproject
List preview blueprints
Lists all preview blueprints for a project
Preview Blueprintsproject
Get preview blueprint
Gets details about a preview blueprint
Preview Blueprintsproject
List preview environments
Get a list of active previews for a preview blueprint.
Preview Blueprintsproject
List preview blueprint runs
Lists runs of a previewBlueprint
Preview Blueprintsproject
Get preview blueprint run details
Get information about the given preview blueprint run
Preview Blueprintsproject
Get project
Get information about the given project
Projects
List project secrets
Gets a list of project secrets belonging to the project
Secretsproject
Get project secret
View a project secret including its contents
Secretsproject
Get project secret addon link details
Get details about a given addon link.
Secretsproject
Get project secret details
View a project secret with details about its linked addons
Secretsproject
List services
Gets a list of services belonging to the project
Servicesproject
Get service
Gets information about the given service.
Servicesproject
Get service branches
Gets information about the branches of the given service.
Servicesproject
List service builds
Lists the builds for the service
Servicesproject
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.
Servicesproject
Get service build arguments details
Get details about the build arguments accessible by the given service. Also requires the permission 'Project > Secrets > General > Read'
Servicesproject
Get service build
Gets information about a build for the service
Servicesproject
Get service build logs
Get logs for a service build
Servicesproject
Get service build metrics
Get metrics for a service build
Servicesproject
List service containers
Gets a list of containers for the given service.
Servicesproject
Get service deployment
Gets information about the deployment of the given service.
Servicesproject
Get service health checks
Lists the health checks for the given service.
Servicesproject
Get service logs
Get logs for a service
Servicesproject
Get service metrics
Get metrics for a service
Servicesproject
Get service per-replica volumes
Lists the per-replica statefulSet volumes for the given service.
Servicesproject
Get service ports
Lists the ports for the given service.
Servicesproject
Get service pull requests
Gets information about the pull-requests of the given service.
Servicesproject
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.
Servicesproject
Get service runtime environment details
Get details about the runtime environment accessible by the given service. Also requires the permission 'Project > Secrets > General > Read'
Servicesproject
List volumes
Gets a list of volumes belonging to the project
Volumesproject
Get volume
Retrieve a volume
Volumesproject
Get volume backups
Get list of backups associated with a volume
Volumesproject
Get volume backup details
Get details for a specific volume backup
Volumesproject
List workflows
Lists all workflows for a project
Workflowsproject
Get workflow
Gets details about a workflow
Workflowsproject
List workflow runs
Lists runs of a workflow
Workflowsproject
Get workflow run details
Get information about the given workflow run
Workflowsproject
List regions
Lists available project regions
Miscellaneous
List team roles
Gets a list of platform roles for a team.
Team Rolesteam
Get team role
Gets details about a specific platform role.
Team Rolesteam
List team role members
Gets a list of members assigned to a platform role in a team.
Team Rolesteam
List global secrets
Gets a list of global secrets
Secrets
Get global secret
Get a global secret including its contents
Secrets
List tags
List the resource tags for this entity.
Tags
Get tag
View details for a given resource tag.
Tags
List teams
Gets a list of teams belonging to the authenticated org.
Teamsorg
Get team
Gets information about a team belonging to the authenticated org.
Teamsorg
List templates
Get a list of templates
Templates
Get template
Get information about the given template.
Templates
List template runs
Get a list of template runs
Templates
Get template run
Get information about the given template run.
Templates
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.
API Tokensorg
List backup destinations
Lists the backup destinations saved to this account. Does not display secrets.
Backup Destinationsteam
Get backup destination
View a backup destination, including secrets.
Backup Destinationsteam
List destinations backups
Lists the backups associated with a backup destinations.
Backup Destinationsteam
List invoices
Lists finalized invoices.
Billingteam
Get invoice
Gets details about a given invoice.
Billingteam
List usage
Lists hourly usage entries.
Billingteam
Get usage
Gets usage details for a given billing hour.
Billingteam
List clusters
Lists clusters for the authenticated user or team.
Cloud Providersteam
Get cluster
Get information about the given cluster
Cloud Providersteam
List cluster nodes
Get a list of nodes for the given cluster
Cloud Providersteam
List integrations
Lists integrations for the authenticated user or team.
Cloud Providersteam
Get integration
Get information about the given integration
Cloud Providersteam
Get workload identity provider status
Checks whether the OIDC/workload identity provider resources have been installed on the given cloud provider integration account.
Integrationsteam
Get DNS ID
Returns the partially random string used when generating host names for the authenticated account.
Miscellaneousteam
List domains
Lists available domains
Domainsteam
Get domain
Gets details about domain
Domainsteam
Get domain certificate
Retrieve certificate data for a domain to verify its contents.
Domainsteam
Get subdomain
Gets details about the given subdomain
Domainsteam
List subdomain paths
List paths for a given subdomain.
Domainsteam
Get subdomain path
Get subdomain path details.
Domainsteam
List egress IPs
Gets a list of egress IPs belonging to the team
Egress IPsteam
Get egress IP
Gets information about the given egress IP
Egress IPsteam
List log sinks
Gets a list of log sinks added to this account.
Integrationsteam
Get log sink details
Gets details about a given log sink.
Integrationsteam
List notification integrations
Lists notification integrations for the authenticated user or team.
Integrationsteam
Get notification integration
Get details about a notification integration.
Integrationsteam
List registries
Lists the container registry credentials saved to this account. Does not display secrets.
Integrationsteam
Get registry
Views a set of registry credential data.
Integrationsteam
List SSH identities
Lists the SSH identities saved to this account. Does not display SSH public keys.
Integrationsteam
Get SSH identity
Views SSH identity data including public keys.
Integrationsteam
List VCS providers
Lists linked version control providers
Integrationsteam
Get VCS link session
Gets the status of a version control link session, for polling until completion.
Integrationsteam
List repositories
Gets a list of repositories accessible to this account
Integrationsteam
List branches
Gets a list of branches for the repo
Integrationsteam
List load balancers
Gets a list of load balancers belonging to the team
Load Balancersteam
Get load balancer
Gets information about the given load balancer
Load Balancersteam
Get logs for a resource
Get logs for any Northflank resource
AddonsJobsServicesteam
Get network policy
Get details of a network policy.
Network Policiesteam
Get OpenTofu job logs
Get logs for an OpenTofu job
OpenTofuteam
List projects
Lists projects for the authenticated user or team.
Projectsteam
Get project
Get information about the given project
Projectsteam
List addons
Gets a list of addons belonging to the project
Addonsproject
Get addon
Gets information about the given addon
Addonsproject
Get addon backup schedules
Gets details about an addon's backup schedules
Addonsproject
List addon backups
Returns a list of backups for the given addon.
Addonsproject
Get addon backup
Gets details about a given backup.
Addonsproject
Get backup download link
Generates a temporary download link for downloading the given backup.
Addonsproject
Get addon backup logs
Get logs for an addon backup
Addonsproject
List addon backup restores
Gets a list of restores for the given backup.
Addonsproject
Get addon restore logs
Get logs for an addon restore
Addonsproject
List addon containers
Gets a list of containers for the given addon.
Addonsproject
Get addon credentials
Returns the credentials for connecting to the given addon.
Addonsproject
Get addon logs
Get logs for an addon
Addonsproject
Get addon metrics
Get metrics for an addon
Addonsproject
List addon restores
Returns a list of restores for the given addon.
Addonsproject
Get addon version details
Gets details about the current addon version including available upgrades and upgrade history.
Addonsproject
List external addons
Gets a list of external addons belonging to the project
External Addonsproject
Get external addon
Gets information about the given external addon
External Addonsproject
List harnesses
Gets a list of harnesses belonging to the project
Harnessesproject
Get harness
Gets information about the given harness
Harnessesproject
Get harness logs
Get logs for a harness
Harnessesproject
List jobs
Gets a list of jobs belonging to the project
Jobsproject
Get job
Gets information about the given job
Jobsproject
Get job branches
Gets information about the branches of the given job.
Jobsproject
List job builds
Lists builds for the given job.
Jobsproject
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.
Jobsproject
Get job build argument details
Get details about the build arguments accessible by the given job. Also requires the permission 'Project > Secrets > General > Read'
Jobsproject
Get job build
Gets information about a build for the job
Jobsproject
Get job build logs
Get logs for a job build
Jobsproject
Get job build metrics
Get metrics for a job build
Jobsproject
List job containers
Gets a list of containers for the given job.
Jobsproject
Get job deployment
Gets information about the deployment of the given job.
Jobsproject
Get job health checks
Lists the health checks for the given job.
Jobsproject
Get job logs
Get logs for a job
Jobsproject
Get job metrics
Get metrics for a job
Jobsproject
Get job pull requests
Gets information about the pull-requests of the given job.
Jobsproject
Get job runs
Fetches run history for the given job
Jobsproject
Get run details
Returns data about the given job run
Jobsproject
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.
Jobsproject
Get job runtime environment details
Get details about the runtime environment accessible by the given job. Also requires the permission 'Project > Secrets > General > Read'
Jobsproject
List AI models
Lists all AI models for a project
AI Modelsproject
Get AI model
Gets details about an AI model
AI Modelsproject
List pipelines
Lists all pipelines for a project
Pipelinesproject
Get pipeline
Get details about a pipeline
Pipelinesproject
Get preview template
Get information about the given preview template.
Pipelinesproject
List preview environments
Get a list of active preview environments for a template
Pipelinesproject
List preview template runs
Get a list of preview template runs
Pipelinesproject
Get preview template run
Get information about the given preview template run.
Pipelinesproject
Get release flow
Gets details about a release flow
Pipelinesproject
List release flow runs
Lists runs of a release flow
Pipelinesproject
Get release flow run details
Get information about the given release flow run
Pipelinesproject
List preview blueprints
Lists all preview blueprints for a project
Preview Blueprintsproject
Get preview blueprint
Gets details about a preview blueprint
Preview Blueprintsproject
List preview environments
Get a list of active previews for a preview blueprint.
Preview Blueprintsproject
List preview blueprint runs
Lists runs of a previewBlueprint
Preview Blueprintsproject
Get preview blueprint run details
Get information about the given preview blueprint run
Preview Blueprintsproject
List project secrets
Gets a list of project secrets belonging to the project
Secretsproject
Get project secret
View a project secret including its contents
Secretsproject
Get project secret addon link details
Get details about a given addon link.
Secretsproject
Get project secret details
View a project secret with details about its linked addons
Secretsproject
List services
Gets a list of services belonging to the project
Servicesproject
Get service
Gets information about the given service.
Servicesproject
Get service branches
Gets information about the branches of the given service.
Servicesproject
List service builds
Lists the builds for the service
Servicesproject
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.
Servicesproject
Get service build arguments details
Get details about the build arguments accessible by the given service. Also requires the permission 'Project > Secrets > General > Read'
Servicesproject
Get service build
Gets information about a build for the service
Servicesproject
Get service build logs
Get logs for a service build
Servicesproject
Get service build metrics
Get metrics for a service build
Servicesproject
List service containers
Gets a list of containers for the given service.
Servicesproject
Get service deployment
Gets information about the deployment of the given service.
Servicesproject
Get service health checks
Lists the health checks for the given service.
Servicesproject
Get service logs
Get logs for a service
Servicesproject
Get service metrics
Get metrics for a service
Servicesproject
Get service per-replica volumes
Lists the per-replica statefulSet volumes for the given service.
Servicesproject
Get service ports
Lists the ports for the given service.
Servicesproject
Get service pull requests
Gets information about the pull-requests of the given service.
Servicesproject
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.
Servicesproject
Get service runtime environment details
Get details about the runtime environment accessible by the given service. Also requires the permission 'Project > Secrets > General > Read'
Servicesproject
List volumes
Gets a list of volumes belonging to the project
Volumesproject
Get volume
Retrieve a volume
Volumesproject
Get volume backups
Get list of backups associated with a volume
Volumesproject
Get volume backup details
Get details for a specific volume backup
Volumesproject
List workflows
Lists all workflows for a project
Workflowsproject
Get workflow
Gets details about a workflow
Workflowsproject
List workflow runs
Lists runs of a workflow
Workflowsproject
Get workflow run details
Get information about the given workflow run
Workflowsproject
List global secrets
Gets a list of global secrets
Secretsteam
Get global secret
Get a global secret including its contents
Secretsteam
List tags
List the resource tags for this entity.
Tagsteam
Get tag
View details for a given resource tag.
Tagsteam
List templates
Get a list of templates
Templatesteam
Get template
Get information about the given template.
Templatesteam
List template runs
Get a list of template runs
Templatesteam
Get template run
Get information about the given template run.
Templatesteam
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.
API Tokensteam
List workload identities
Lists the workload identities saved to this account.
Integrationsteam
Get workload identity
Retrieves a workload identity by ID.
Integrationsteam
List workload identities
Lists the workload identities saved to this account.
Integrations
Get workload identity
Retrieves a workload identity by ID.
Integrations
Patch backup destination
Updates a backup destination.
Backup Destinations
Patch cluster
Updates a cluster.
Cloud Providersorg
Patch integration
Updates a integration.
Cloud Providersorg
Update geo routing configuration
Updates the geo routing configuration for a geo-routed subdomain.
Domains
Patch egress IP
Updates an egress IP
Egress IPs
Update gradual rollout strategy
Updates a gradual rollout strategy.
Rollout Strategies
Update registry
Updates a set of registry credential data.
Integrations
Update SSH identity
Updates SSH identity data.
Integrations
Patch load balancer
Updates a load balancer
Load Balancers
Update network policy
Updates an existing network policy.
Network Policies
Update org role
Partially updates a platform role for the authenticated org.
Org Rolesorg
Patch addon
Updates an addon
Addonsproject
Update external addon
Updates configuration for an external addon
External Addonsproject
Patch harness
Updates a harness
Harnessesproject
Patch cron job
Updates a cron job
Jobsproject
Patch job
Updates a job (manual or cron based on current type and settings.cron)
Jobsproject
Patch manual job
Updates a new manual job that only runs when initiated via the UI, CLI, API or JS client.
Jobsproject
Update project
Updates a project.
Projects
Patch project secret
Updates a project secret with the specified payload
Secretsproject
Patch build service
Updates a build service.
Servicesproject
Patch combined service
Updates a combined service.
Servicesproject
Patch deployment service
Updates a deployment service.
Servicesproject
Update team role
Updates a platform role for a team.
Team Rolesteam
Patch global secret
Updates a global secret with the specified payload
Secrets
Update tag
Patch a resource tag.
Tags
Update team
Updates the description of a team belonging to the authenticated org.
Teamsorg
Patch backup destination
Updates a backup destination.
Backup Destinationsteam
Patch cluster
Updates a cluster.
Cloud Providersteam
Patch integration
Updates a integration.
Cloud Providersteam
Update geo routing configuration
Updates the geo routing configuration for a geo-routed subdomain.
Domainsteam
Patch egress IP
Updates an egress IP
Egress IPsteam
Update gradual rollout strategy
Updates a gradual rollout strategy.
Rollout Strategiesteam
Update registry
Updates a set of registry credential data.
Integrationsteam
Update SSH identity
Updates SSH identity data.
Integrationsteam
Patch load balancer
Updates a load balancer
Load Balancersteam
Update network policy
Updates an existing network policy.
Network Policiesteam
Update project
Updates a project.
Projectsteam
Patch addon
Updates an addon
Addonsproject
Update external addon
Updates configuration for an external addon
External Addonsproject
Patch harness
Updates a harness
Harnessesproject
Patch cron job
Updates a cron job
Jobsproject
Patch job
Updates a job (manual or cron based on current type and settings.cron)
Jobsproject
Patch manual job
Updates a new manual job that only runs when initiated via the UI, CLI, API or JS client.
Jobsproject
Patch project secret
Updates a project secret with the specified payload
Secretsproject
Patch build service
Updates a build service.
Servicesproject
Patch combined service
Updates a combined service.
Servicesproject
Patch deployment service
Updates a deployment service.
Servicesproject
Patch global secret
Updates a global secret with the specified payload
Secretsteam
Update tag
Patch a resource tag.
Tagsteam
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.
Integrationsteam
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.
Integrations
Add backup destination
Adds a new backup destination to this account.
Backup Destinations
Create cluster
Creates a new cluster.
Cloud Providersorg
Cordon cluster node
Cordon a node on the cluster to prevent new pods from scheduling on it.
Cloud Providersorg
Drain cluster node
Drain a node by evicting all running pods.
Cloud Providersorg
Uncordon cluster node
Uncordon a node on the cluster if it was previously cordoned.
Cloud Providersorg
Create integration
Creates a new integration.
Cloud Providersorg
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.
Integrations
Create new domain
Registers a new domain
Domains
Import domain certificate
Import a certificate for the domain
Domains
Add subdomain
Adds a new subdomain to the domain.
Domains
Assign service to subdomain
Assigns a service port to the given subdomain
Domains
Remove CDN from a subdomain
Removes the CDN integration from the given subdomain
Domains
Enable CDN on a subdomain
Enables a CDN integration on the given subdomain
Domains
Purge CDN cache for a subdomain
Purges the CDN cache for the given subdomain
Domains
Add subdomain path
Adds a new path to the subdomain.
Domains
Update subdomain path
Update a subdomain path.
Domains
Assign subdomain path
Assign a subdomain path to a port.
Domains
Verify subdomain
Gets details about the given subdomain
Domains
Verify domain
Attempts to verify the domain
Domains
Create egress IP
Creates a new egress IP
Egress IPs
Create gradual rollout strategy
Creates a new gradual rollout strategy.
Rollout Strategies
Create log sink
Creates a new log sink.
Integrations
Pause log sink
Pauses a given log sink.
Integrations
Resume log sink
Resumes a paused log sink.
Integrations
Update log sink
Updates the settings for a log sink.
Integrations
Create notification integration
Create a new notification integration.
Integrations
Update notification integration
Updates a notification integration
Integrations
Add registry
Adds a new set of container registry credentials to this account.
Integrations
Add SSH identity
Adds a new SSH identity to this account.
Integrations
Generate VCS token
Generate a token for a specific VCS link.
Integrations
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.
Integrations
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.
Integrations
Create load balancer
Creates a new load balancer
Load Balancers
Invite team member
Invites a user to a team.
Team Membersteam
Create network policy
Creates a new network policy for this account.
Network Policies
Create org role
Creates a new platform role for the authenticated org.
Org Rolesorg
Add member to org role
Adds a user to a platform role in the authenticated org.
Org Rolesorg
Create project
Creates a new project.
Projects
Create addon
Creates a new addon
Addonsproject
Create addon backup schedule
Create a new backup schedule for an addon.
Addonsproject
Backup addon
Initiates a backup for the given addon
Addonsproject
Abort backup
Aborts the in progress backup.
Addonsproject
Abort backup restore
Aborts an in-progress backup restore.
Addonsproject
Restore addon backup
Restores the given addon to the given backup state.
Addonsproject
Retain backup
Flags a temporary backup generated by a backup schedule to be retained indefinitely rather than being deleted after the expiry date.
Addonsproject
Import addon backup
Imports a database from an external archive or existing live database.
Addonsproject
Update addon network settings
Updates the network settings for the addon.
Addonsproject
Pause addon
Pause the given addon.
Addonsproject
Reset addon
Reset the given addon.
Addonsproject
Restart addon
Restart the given addon.
Addonsproject
Resume addon
Resume the given addon if it is paused.
Addonsproject
Scale addon resources
Modifies the allocated resources for the given addon.
Addonsproject
Update addon security rules
Updates the security rules for the addon.
Addonsproject
Upgrade addon version
Upgrades the addon to a new version.
Addonsproject
Create external addon
Creates a new external addon (third-party cloud resource provisioned via OpenTofu)
External Addonsproject
Create harness
Creates a new harness
Harnessesproject
Pause harness
Pauses the given harness, scaling its deployment to zero.
Harnessesproject
Restart harness
Restarts the given harness.
Harnessesproject
Resume harness
Resumes the given harness, restoring its deployment.
Harnessesproject
Create job
Creates a new job (manual or cron based on settings.cron presence)
Jobsproject
Create cron job
Creates a new cron job
Jobsproject
Start job build
Start a new build for the given job. Given a commit sha, it will build that commit.
Jobsproject
Edit job build arguments
Sets build arguments for the given job.
Jobsproject
Update job build options
Updates the build options for a given job.
Jobsproject
Update job build source
Updates the version control source for a given job.
Jobsproject
Update job deployment
Updates the deployment settings of the given job.
Jobsproject
Update job health checks
Updates health checks for the given job.
Jobsproject
Pause job
Pause the given job.
Jobsproject
Resume job
Resumes the given job. Optionally takes several arguments to override resumed settings.
Jobsproject
Run job
Starts a new job run for the given job
Jobsproject
Edit job runtime environment
Sets the runtime environment for the given job.
Jobsproject
Scale job
Modifies the scaling settings for the given job.
Jobsproject
Update job settings
Updates settings for the job
Jobsproject
Suspend job
Modify cron job to toggle suspending of its schedule.
Jobsproject
Create manual job
Creates a new manual job that only runs when initiated via the UI, CLI, API or JS client.
Jobsproject
Create AI model
Create an AI model
AI Modelsproject
Update AI model
Updates an AI model
AI Modelsproject
Update preview template
Update a given preview template.
Pipelinesproject
Run preview environment
Run the given preview template.
Pipelinesproject
Update release flow
Updates a release flow
Pipelinesproject
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.
Pipelinesproject
Abort release flow run
Abort the given release flow run
Pipelinesproject
Create preview blueprint
Create a preview blueprint
Preview Blueprintsproject
Update preview blueprint
Updates a preview blueprint
Preview Blueprintsproject
Pause preview environment
Pause a preview environment generated by a preview blueprint.
Preview Blueprintsproject
Reset preview environment expiry
Reset the expiry of a preview environment generated by a preview blueprint.
Preview Blueprintsproject
Resume preview environment
Resume a preview environment generated by a preview blueprint.
Preview Blueprintsproject
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.
Preview Blueprintsproject
Abort preview blueprint run
Abort the given preview blueprint run
Preview Blueprintsproject
Create combined service
Creates a project secret with the specified payload
Secretsproject
Update project secret
Update a project secret
Secretsproject
Update project secret addon link
Link an addon to a project secret or edit the settings of the linked addon.
Secretsproject
Create build service
Creates a new build service.
Servicesproject
Create combined service
Creates a new combined service.
Servicesproject
Create deployment service
Creates a new deployment service.
Servicesproject
Start service build
Start a new build for the given combined or build service. If given a commit sha, it will build that commit. Otherwise, the most recent relevant commit will be built. If the service provided is a build service, a branch name or pull request to build from is required.
Servicesproject
Edit service build arguments
Sets the build arguments for the given service.
Servicesproject
Update service build options
Updates the build options for a given service.
Servicesproject
Update service build source
Updates the version control source for a given build or combined service.
Servicesproject
Update service deployment
Updates the deployment settings of the given service.
Servicesproject
Update service health checks
Updates health checks for the given service.
Servicesproject
Pause service
Pause the given service.
Servicesproject
Update service ports
Updates the list of ports for the given service.
Servicesproject
Restart service
Restarts the given service.
Servicesproject
Resume service
Resumes the given service. Optionally takes several arguments to override resumed settings.
Servicesproject
Edit service runtime environment
Sets the runtime environment for the given service.
Servicesproject
Scale service
Modifies the scaling settings for the given service.
Servicesproject
Create volume
Creates a volume with the specified payload
Volumesproject
Update volume
Update volume mounts and storage size
Volumesproject
Attach volume
Attach a volume
Volumesproject
Backup volume
Initiates a backup for a given volume
Volumesproject
Detach volume
Detach a volume
Volumesproject
Create workflow
Create a workflow
Workflowsproject
Update workflow
Updates a workflow
Workflowsproject
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.
Workflowsproject
Abort workflow run
Abort the given workflow run
Workflowsproject
Create team role
Creates a new platform role for a team.
Team Rolesteam
Add member to team role
Adds a user to a platform role in a team.
Team Rolesteam
Create global secret
Creates a global secret with the specified payload
Secrets
Add tag
Add a new resource tag for this entity.
Tags
Create team
Creates a new team belonging to the authenticated org.
Teamsorg
Create template
Create a template
Templates
Update template
Update a template
Templates
Run template
Run a template
Templates
Abort template run
Abort the given template run.
Templates
Add backup destination
Adds a new backup destination to this account.
Backup Destinationsteam
Create cluster
Creates a new cluster.
Cloud Providersteam
Cordon cluster node
Cordon a node on the cluster to prevent new pods from scheduling on it.
Cloud Providersteam
Drain cluster node
Drain a node by evicting all running pods.
Cloud Providersteam
Uncordon cluster node
Uncordon a node on the cluster if it was previously cordoned.
Cloud Providersteam
Create integration
Creates a new integration.
Cloud Providersteam
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.
Integrationsteam
Create new domain
Registers a new domain
Domainsteam
Import domain certificate
Import a certificate for the domain
Domainsteam
Add subdomain
Adds a new subdomain to the domain.
Domainsteam
Assign service to subdomain
Assigns a service port to the given subdomain
Domainsteam
Remove CDN from a subdomain
Removes the CDN integration from the given subdomain
Domainsteam
Enable CDN on a subdomain
Enables a CDN integration on the given subdomain
Domainsteam
Purge CDN cache for a subdomain
Purges the CDN cache for the given subdomain
Domainsteam
Add subdomain path
Adds a new path to the subdomain.
Domainsteam
Update subdomain path
Update a subdomain path.
Domainsteam
Assign subdomain path
Assign a subdomain path to a port.
Domainsteam
Verify subdomain
Gets details about the given subdomain
Domainsteam
Verify domain
Attempts to verify the domain
Domainsteam
Create egress IP
Creates a new egress IP
Egress IPsteam
Create gradual rollout strategy
Creates a new gradual rollout strategy.
Rollout Strategiesteam
Create log sink
Creates a new log sink.
Integrationsteam
Pause log sink
Pauses a given log sink.
Integrationsteam
Resume log sink
Resumes a paused log sink.
Integrationsteam
Update log sink
Updates the settings for a log sink.
Integrationsteam
Create notification integration
Create a new notification integration.
Integrationsteam
Update notification integration
Updates a notification integration
Integrationsteam
Add registry
Adds a new set of container registry credentials to this account.
Integrationsteam
Add SSH identity
Adds a new SSH identity to this account.
Integrationsteam
Generate VCS token
Generate a token for a specific VCS link.
Integrationsteam
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.
Integrationsteam
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.
Integrationsteam
Create load balancer
Creates a new load balancer
Load Balancersteam
Create network policy
Creates a new network policy for this account.
Network Policiesteam
Create project
Creates a new project.
Projectsteam
Create addon
Creates a new addon
Addonsproject
Create addon backup schedule
Create a new backup schedule for an addon.
Addonsproject
Backup addon
Initiates a backup for the given addon
Addonsproject
Abort backup
Aborts the in progress backup.
Addonsproject
Abort backup restore
Aborts an in-progress backup restore.
Addonsproject
Restore addon backup
Restores the given addon to the given backup state.
Addonsproject
Retain backup
Flags a temporary backup generated by a backup schedule to be retained indefinitely rather than being deleted after the expiry date.
Addonsproject
Import addon backup
Imports a database from an external archive or existing live database.
Addonsproject
Update addon network settings
Updates the network settings for the addon.
Addonsproject
Pause addon
Pause the given addon.
Addonsproject
Reset addon
Reset the given addon.
Addonsproject
Restart addon
Restart the given addon.
Addonsproject
Resume addon
Resume the given addon if it is paused.
Addonsproject
Scale addon resources
Modifies the allocated resources for the given addon.
Addonsproject
Update addon security rules
Updates the security rules for the addon.
Addonsproject
Upgrade addon version
Upgrades the addon to a new version.
Addonsproject
Create external addon
Creates a new external addon (third-party cloud resource provisioned via OpenTofu)
External Addonsproject
Create harness
Creates a new harness
Harnessesproject
Pause harness
Pauses the given harness, scaling its deployment to zero.
Harnessesproject
Restart harness
Restarts the given harness.
Harnessesproject
Resume harness
Resumes the given harness, restoring its deployment.
Harnessesproject
Create job
Creates a new job (manual or cron based on settings.cron presence)
Jobsproject
Create cron job
Creates a new cron job
Jobsproject
Start job build
Start a new build for the given job. Given a commit sha, it will build that commit.
Jobsproject
Edit job build arguments
Sets build arguments for the given job.
Jobsproject
Update job build options
Updates the build options for a given job.
Jobsproject
Update job build source
Updates the version control source for a given job.
Jobsproject
Update job deployment
Updates the deployment settings of the given job.
Jobsproject
Update job health checks
Updates health checks for the given job.
Jobsproject
Pause job
Pause the given job.
Jobsproject
Resume job
Resumes the given job. Optionally takes several arguments to override resumed settings.
Jobsproject
Run job
Starts a new job run for the given job
Jobsproject
Edit job runtime environment
Sets the runtime environment for the given job.
Jobsproject
Scale job
Modifies the scaling settings for the given job.
Jobsproject
Update job settings
Updates settings for the job
Jobsproject
Suspend job
Modify cron job to toggle suspending of its schedule.
Jobsproject
Create manual job
Creates a new manual job that only runs when initiated via the UI, CLI, API or JS client.
Jobsproject
Create AI model
Create an AI model
AI Modelsproject
Update AI model
Updates an AI model
AI Modelsproject
Update preview template
Update a given preview template.
Pipelinesproject
Run preview environment
Run the given preview template.
Pipelinesproject
Update release flow
Updates a release flow
Pipelinesproject
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.
Pipelinesproject
Abort release flow run
Abort the given release flow run
Pipelinesproject
Create preview blueprint
Create a preview blueprint
Preview Blueprintsproject
Update preview blueprint
Updates a preview blueprint
Preview Blueprintsproject
Pause preview environment
Pause a preview environment generated by a preview blueprint.
Preview Blueprintsproject
Reset preview environment expiry
Reset the expiry of a preview environment generated by a preview blueprint.
Preview Blueprintsproject
Resume preview environment
Resume a preview environment generated by a preview blueprint.
Preview Blueprintsproject
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.
Preview Blueprintsproject
Abort preview blueprint run
Abort the given preview blueprint run
Preview Blueprintsproject
Create combined service
Creates a project secret with the specified payload
Secretsproject
Update project secret
Update a project secret
Secretsproject
Update project secret addon link
Link an addon to a project secret or edit the settings of the linked addon.
Secretsproject
Create build service
Creates a new build service.
Servicesproject
Create combined service
Creates a new combined service.
Servicesproject
Create deployment service
Creates a new deployment service.
Servicesproject
Start service build
Start a new build for the given combined or build service. If given a commit sha, it will build that commit. Otherwise, the most recent relevant commit will be built. If the service provided is a build service, a branch name or pull request to build from is required.
Servicesproject
Edit service build arguments
Sets the build arguments for the given service.
Servicesproject
Update service build options
Updates the build options for a given service.
Servicesproject
Update service build source
Updates the version control source for a given build or combined service.
Servicesproject
Update service deployment
Updates the deployment settings of the given service.
Servicesproject
Update service health checks
Updates health checks for the given service.
Servicesproject
Pause service
Pause the given service.
Servicesproject
Update service ports
Updates the list of ports for the given service.
Servicesproject
Restart service
Restarts the given service.
Servicesproject
Resume service
Resumes the given service. Optionally takes several arguments to override resumed settings.
Servicesproject
Edit service runtime environment
Sets the runtime environment for the given service.
Servicesproject
Scale service
Modifies the scaling settings for the given service.
Servicesproject
Create volume
Creates a volume with the specified payload
Volumesproject
Update volume
Update volume mounts and storage size
Volumesproject
Attach volume
Attach a volume
Volumesproject
Backup volume
Initiates a backup for a given volume
Volumesproject
Detach volume
Detach a volume
Volumesproject
Create workflow
Create a workflow
Workflowsproject
Update workflow
Updates a workflow
Workflowsproject
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.
Workflowsproject
Abort workflow run
Abort the given workflow run
Workflowsproject
Create global secret
Creates a global secret with the specified payload
Secretsteam
Add tag
Add a new resource tag for this entity.
Tagsteam
Create template
Create a template
Templatesteam
Update template
Update a template
Templatesteam
Run template
Run a template
Templatesteam
Abort template run
Abort the given template run.
Templatesteam
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.
Integrationsteam
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.
Integrationsteam
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.
Integrations
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.
Integrations
Put cluster
Creates or update a cluster.
Cloud Providersorg
Put integration
Creates or updates a integration.
Cloud Providersorg
Put subdomain
Updates subdomain to the domain.
Domains
Put egress IP
Creates or updates an egress IP
Egress IPs
Create or update gradual rollout strategy
Creates or updates a gradual rollout strategy.
Rollout Strategies
Create or update SSH identity
Creates or updates SSH identity data.
Integrations
Put load balancer
Creates or updates a load balancer
Load Balancers
Create or update org role
Creates role or updates all user-editable fields on a platform role for the authenticated org.
Org Rolesorg
Create or update project
Creates or updates a project.
Projects
Put addon
Creates or updates an addon
Addonsproject
Put harness
Creates or updates a harness
Harnessesproject
Put job
Creates or updates a job (manual or cron based on settings.cron presence)
Jobsproject
Put cron job
Creates or updates a cron job
Jobsproject
Put manual job
Creates or updates a new manual job that only runs when initiated via the UI, CLI, API or JS client.
Jobsproject
Put project secret
Creates or updates a project secret with the specified payload
Secretsproject
Put build service
Creates or updates a build service.
Servicesproject
Put combined service
Creates or updates a combined service.
Servicesproject
Put deployment service
Creates or updates a deployment service.
Servicesproject
Create or update role
Creates role or updates all user-editable fields on a platform role.
Team Rolesteam
Put global secret
Creates or updates a global secret with the specified payload
Secrets
Put tag
Update or create a resource tag.
Tags
Put cluster
Creates or update a cluster.
Cloud Providersteam
Put integration
Creates or updates a integration.
Cloud Providersteam
Put subdomain
Updates subdomain to the domain.
Domainsteam
Put egress IP
Creates or updates an egress IP
Egress IPsteam
Create or update gradual rollout strategy
Creates or updates a gradual rollout strategy.
Rollout Strategiesteam
Create or update SSH identity
Creates or updates SSH identity data.
Integrationsteam
Put load balancer
Creates or updates a load balancer
Load Balancersteam
Create or update project
Creates or updates a project.
Projectsteam
Put addon
Creates or updates an addon
Addonsproject
Put harness
Creates or updates a harness
Harnessesproject
Put job
Creates or updates a job (manual or cron based on settings.cron presence)
Jobsproject
Put cron job
Creates or updates a cron job
Jobsproject
Put manual job
Creates or updates a new manual job that only runs when initiated via the UI, CLI, API or JS client.
Jobsproject
Put project secret
Creates or updates a project secret with the specified payload
Secretsproject
Put build service
Creates or updates a build service.
Servicesproject
Put combined service
Creates or updates a combined service.
Servicesproject
Put deployment service
Creates or updates a deployment service.
Servicesproject
Put global secret
Creates or updates a global secret with the specified payload
Secretsteam
Put tag
Update or create a resource tag.
Tagsteam
FAQ

Northflank integration, answered

How do AI agents use Northflank through Open Connector?
Your user connects Northflank once with one of its cataloged authentication methods. Open Connector stores the credential in an encrypted vault and exposes Northflank tools to your agent over MCP or a typed API, with credentials injected server-side on each call.
Is this a Northflank MCP server?
Yes. Open Connector can serve Northflank as a named MCP server with a scoped allowlist and a per-user connection URL, so any MCP client can call Northflank actions with credentials injected server-side.
Where do Northflank credentials live?
In your own infrastructure. Open Connector keeps credentials in its own vault and injects them at call time, so they never leave your environment.

Give your agents Northflank — keep the keys.

Open source, self-hostable, with Northflank credentials that never leave your infrastructure. Run it from source today.