Skip to content
Changelog

Report a bug

Buildkite integration: operations for AI agents

Buildkite connects to Type.com as an integration. This page lists the 247 operations documented for Claude and Codex in Type.com: 117 read, 57 write, 73 destructive.

About Buildkite

Buildkite is a platform for running fast, secure, and scalable continuous integration pipelines on your own infrastructure.

Categories: Developer Tools & IT

How to connect Buildkite to Type.com

Access
Organization connection: one shared account for the workspace.

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

Documented operations

247 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.

247 operations listed.

access-token

  • Read

    Get the current token

    Returns details about the API access token that was used to authenticate the request. Required scope: none Success response: 200 OK

    GET /v2/access-token

  • Destructive

    Revoke the current token

    Revokes the API access token that was used to authenticate the request. Once revoked, the token can no longer be used for further requests. Required scope: none Success response: 204 No Content

    DELETE /v2/access-token

agents

  • Read

    List agents

    Returns a paginated list of an organization's connected and stopping agents. Agents in other connection states are not returned. Use get an agent to retrieve a known agent in any connection state. Optional query string parameters : Required scope: read_agents Success response: 200 OK

    GET /v2/organizations/{org.slug}/agents

  • Read

    Get an agent

    Returns the details for a single agent, looked up by unique ID. Any valid agents can be returned, including running and disconnected agents. Required scope: read_agents Success response: 200 OK

    GET /v2/organizations/{org.slug}/agents/{id}

  • Write

    Resume an agent

    Resume dispatching jobs to an agent, and instruct the agent to resume normal operation. Required scope: write_agents Success response: 204 No Content Error responses:

    PUT /v2/organizations/{org.slug}/agents/{id}/resume

  • Destructive

    Stop an agent

    Instruct an agent to stop accepting new build jobs and shut itself down. Optional request body properties : Required scope: write_agents Success response: 204 No Content Error responses:

    PUT /v2/organizations/{org.slug}/agents/{id}/stop

  • Destructive

    Pause an agent

    Prevent dispatching jobs to an agent, and instruct the agent (which would otherwise exit when the job either is completed or times out) to remain running after finishing its current job. Optional request body properties : Required scope: write_agents Success response: 204 No Content Error responses:

    PUT /v2/organizations/{org.slug}/agents/{id}/pause

annotations

  • Read

    List annotations for a build

    Returns a paginated list of a build's annotations. Optional query string parameters : Required scope: read_builds Success response: 200 OK

    GET /v2/organizations/{org.slug}/pipelines/{pipeline.slug}/builds/{build.number}/annotations

  • Read

    List annotations for a job

    Returns a paginated list of a job's annotations. You can also use the build-scoped route if you have the pipeline slug and build number: Required scope: read_builds Success response: 200 OK

    GET /v2/organizations/{org.slug}/jobs/{job.id}/annotations

  • Read

    List annotations for a job (build-scoped route)

    Returns a paginated list of a job's annotations. You can also use the build-scoped route if you have the pipeline slug and build number: Required scope: read_builds Success response: 200 OK

    GET /v2/organizations/{org.slug}/pipelines/{pipeline.slug}/builds/{build.number}/jobs/{job.id}/annotations

  • Write

    Create an annotation on a build

    Creates an annotation on a build. Required request body properties : Optional request body properties : Required scope: write_builds Success response: 201 Created

    POST /v2/organizations/{org.slug}/pipelines/{pipeline.slug}/builds/{build.number}/annotations

  • Write

    Create an annotation on a job

    Creates an annotation scoped to a specific job in a build. Job-scoped annotations use the same parameters as build-scoped annotations. However, the scope is automatically set to job . You can also use the build-scoped route if you have the pipeline slug and build number: Required request body properties : Optional request body properties : Required scope: write_builds Success response: 201 Created

    POST /v2/organizations/{org.slug}/jobs/{job.id}/annotations

  • Write

    Create an annotation on a job (build-scoped route)

    Creates an annotation scoped to a specific job in a build. Job-scoped annotations use the same parameters as build-scoped annotations. However, the scope is automatically set to job . You can also use the build-scoped route if you have the pipeline slug and build number: Required request body properties : Optional request body properties : Required scope: write_builds Success response: 201 Created

    POST /v2/organizations/{org.slug}/pipelines/{pipeline.slug}/builds/{build.number}/jobs/{job.id}/annotations

  • Destructive

    Delete an annotation on a build

    Deletes an annotation on a build. Required scope: write_builds Success response: 204 No Content

    DELETE /v2/organizations/{org.slug}/pipelines/{pipeline.slug}/builds/{build.number}/annotations/{annotation.uuid}

  • Destructive

    Delete an annotation on a job

    Deletes an annotation on a job. You can also use the build-scoped route if you have the pipeline slug and build number: Required scope: write_builds Success response: 204 No Content

    DELETE /v2/organizations/{org.slug}/jobs/{job.id}/annotations/{annotation.uuid}

  • Destructive

    Delete an annotation on a job (build-scoped route)

    Deletes an annotation on a job. You can also use the build-scoped route if you have the pipeline slug and build number: Required scope: write_builds Success response: 204 No Content

    DELETE /v2/organizations/{org.slug}/pipelines/{pipeline.slug}/builds/{build.number}/jobs/{job.id}/annotations/{annotation.uuid}

artifacts

  • Read

    List artifacts for a build

    Returns a paginated list of a build's artifacts across all of its jobs. Optional query string parameters : Required scope: read_artifacts Success response: 200 OK

    GET /v2/organizations/{org.slug}/pipelines/{pipeline.slug}/builds/{build.number}/artifacts

  • Read

    List artifacts for a job

    Returns a paginated list of a job's artifacts. You can also use the build-scoped route if you have the pipeline slug and build number: Optional query string parameters : Required scope: read_artifacts Success response: 200 OK

    GET /v2/organizations/{org.slug}/jobs/{job.id}/artifacts

  • Read

    List artifacts for a job (build-scoped route)

    Returns a paginated list of a job's artifacts. You can also use the build-scoped route if you have the pipeline slug and build number: Optional query string parameters : Required scope: read_artifacts Success response: 200 OK

    GET /v2/organizations/{org.slug}/pipelines/{pipeline.slug}/builds/{build.number}/jobs/{job.id}/artifacts

  • Read

    Get an artifact

    You can also use the build-scoped route if you have the pipeline slug and build number: Required scope: read_artifacts Success response: 200 OK

    GET /v2/organizations/{org.slug}/jobs/{job.id}/artifacts/{id}

  • Read

    Get an artifact (build-scoped route)

    You can also use the build-scoped route if you have the pipeline slug and build number: Required scope: read_artifacts Success response: 200 OK

    GET /v2/organizations/{org.slug}/pipelines/{pipeline.slug}/builds/{build.number}/jobs/{job.id}/artifacts/{id}

  • Read

    Download an artifact

    Returns a 302 response to a URL for downloading an artifact. The URL will be returned in the response body and the Location HTTP header. You should assume the URL returned will only be valid for 60 seconds, unless you've used your own S3 bucket where the URL will be the standard public S3 URL to the artifact object. You can also use the build-scoped route if you have the pipeline slug and build number: Required scope: read_artifacts Success response: 302 Found Error responses:

    GET /v2/organizations/{org.slug}/jobs/{job.id}/artifacts/{id}/download

  • Read

    Download an artifact (build-scoped route)

    Returns a 302 response to a URL for downloading an artifact. The URL will be returned in the response body and the Location HTTP header. You should assume the URL returned will only be valid for 60 seconds, unless you've used your own S3 bucket where the URL will be the standard public S3 URL to the artifact object. You can also use the build-scoped route if you have the pipeline slug and build number: Required scope: read_artifacts Success response: 302 Found Error responses:

    GET /v2/organizations/{org.slug}/pipelines/{pipeline.slug}/builds/{build.number}/jobs/{job.id}/artifacts/{id}/download

  • Destructive

    Delete an artifact

    The artifact record is marked as deleted in the Buildkite database, and the artifact itself is removed from the Buildkite AWS S3 bucket. It will no longer be displayed in the job or build artifact lists, and it will not be returned by the artifact APIs. If the artifact was uploaded using the agent's custom AWS S3 , Google Cloud , or Artifactory storage support, the file will not be automatically deleted from that storage. You must delete the file from your private storage yourself. You can also use the build-scoped route if you have the pipeline slug and build number: Required scope: write_artifacts Success response: 204 No Content

    DELETE /v2/organizations/{org.slug}/jobs/{job.id}/artifacts/{id}

  • Destructive

    Delete an artifact (build-scoped route)

    The artifact record is marked as deleted in the Buildkite database, and the artifact itself is removed from the Buildkite AWS S3 bucket. It will no longer be displayed in the job or build artifact lists, and it will not be returned by the artifact APIs. If the artifact was uploaded using the agent's custom AWS S3 , Google Cloud , or Artifactory storage support, the file will not be automatically deleted from that storage. You must delete the file from your private storage yourself. You can also use the build-scoped route if you have the pipeline slug and build number: Required scope: write_artifacts Success response: 204 No Content

    DELETE /v2/organizations/{org.slug}/pipelines/{pipeline.slug}/builds/{build.number}/jobs/{job.id}/artifacts/{id}

builds

  • Read

    List all builds

    Returns a paginated list of all builds across all the user's organizations and pipelines. If using token-based authentication the list of builds will be for the authorized organizations only. Builds are listed in the order they were created (newest first). Use exclude_jobs=true when polling build state or retrieving build metadata, such as the branch, commit, creator, or timestamps. Fetch embedded jobs only when you need job information. You can also use exclude_pipeline=true when you do not need expanded pipeline information. Optional query string parameters : Required scope: read_builds Success response: 200 OK Error responses:

    GET /v2/builds

  • Read

    List builds for an organization

    Returns a paginated list of an organization's builds across all of an organization's pipelines. Builds are listed in the order they were created (newest first). Use exclude_jobs=true when polling build state or retrieving build metadata, such as the branch, commit, creator, or timestamps. Fetch embedded jobs only when you need job information. You can also use exclude_pipeline=true when you do not need expanded pipeline information. Optional query string parameters : Required scope: read_builds Success response: 200 OK Error responses:

    GET /v2/organizations/{org.slug}/builds

  • Read

    List builds for a pipeline

    Returns a paginated list of a pipeline's builds. Builds are listed in the order they were created (newest first). Use exclude_jobs=true when polling build state or retrieving build metadata, such as the branch, commit, creator, or timestamps. Fetch embedded jobs only when you need job information. You can also use exclude_pipeline=true when you do not need expanded pipeline information. The following response shows the embedded jobs returned when you omit exclude_jobs=true . Optional query string parameters : Required scope: read_builds Success response: 200 OK Error responses:

    GET /v2/organizations/{org.slug}/pipelines/{pipeline.slug}/builds

  • Read

    Get a build

    Use exclude_jobs=true when polling build state or retrieving build metadata, such as the branch, commit, creator, or timestamps.

    GET /v2/organizations/{org.slug}/pipelines/{pipeline.slug}/builds/{number}

  • Write

    Rebuild a build

    Creates a new build that copies the commit, branch, message, environment variables, and pull request data from the original build. A rebuild does not fetch the current state from the source control provider. Anything captured on the original build, including pull request labels, draft state, and base branch, is replayed on the new build. To run a build against the current state of a pull request or branch, use Create a build instead. Returns the newly created build. Required scope: write_builds Success response: 200 OK Error responses:

    PUT /v2/organizations/{org.slug}/pipelines/{pipeline.slug}/builds/{number}/rebuild

  • Write

    Retry failed jobs for a build

    Queues failed jobs to be retried in a build. This request is asynchronous, meaning that jobs are queued to be retried, but the request does not wait for the jobs to be completed before returning a response. The retried_jobs_count field in the response indicates how many jobs were queued to be retried. Optional request body properties : Required scope: write_builds Success response: 202 Accepted Error responses:

    PUT /v2/organizations/{org.slug}/pipelines/{pipeline.slug}/builds/{number}/retry_failed_jobs

  • Destructive

    Create a build

    Required request body properties : Optional request body properties : Required scope: write_builds Success response: 201 Created Error responses:

    POST /v2/organizations/{org.slug}/pipelines/{pipeline.slug}/builds

  • Destructive

    Cancel a build

    Cancels the build if its state is either scheduled , running , or failing . Required scope: write_builds Success response: 200 OK Error responses:

    PUT /v2/organizations/{org.slug}/pipelines/{pipeline.slug}/builds/{number}/cancel

clusters

  • Read

    List clusters

    Returns a paginated list of an organization's clusters. Required scope: read_clusters Success response: 200 OK

    GET /v2/organizations/{org.slug}/clusters

  • Read

    Get a cluster

    Required scope: read_clusters Success response: 200 OK

    GET /v2/organizations/{org.slug}/clusters/{id}

  • Write

    Create a cluster

    Required request body properties : Optional request body properties : Required scope: write_clusters Success response: 201 Created Error responses:

    POST /v2/organizations/{org.slug}/clusters

  • Write

    Update a cluster

    Request body properties : The hosted_git_mirror_enabled , hosted_container_cache_enabled , and default_cache_registry_uuid fields can only be set when updating a cluster.

    PUT /v2/organizations/{org.slug}/clusters/{id}

  • Write

    Update a cluster (alternate route)

    Request body properties : The hosted_git_mirror_enabled , hosted_container_cache_enabled , and default_cache_registry_uuid fields can only be set when updating a cluster.

    PATCH /v2/organizations/{org.slug}/clusters/{id}

  • Destructive

    Delete a cluster

    Delete a cluster along with any queues and tokens that belong to it. Required scope: write_clusters Success response: 204 No Content Error responses:

    DELETE /v2/organizations/{org.slug}/clusters/{id}

clusters/agent-images

  • Read

    List agent images

    Returns an unpaginated list of a cluster's agent images, sorted alphabetically by name. Non-hosted clusters return an empty list. Required scope: read_clusters Required permission: permission to manage the cluster Success response: 200 OK Error response: 503 Service Unavailable when the hosted-agent service cannot return the images.

    GET /v2/organizations/{org.slug}/clusters/{cluster.id}/agent-images

  • Read

    Get an agent image

    Required scope: read_clusters Required permission: permission to manage the cluster Success response: 200 OK Error response: 503 Service Unavailable when the hosted-agent service cannot return the image.

    GET /v2/organizations/{org.slug}/clusters/{cluster.id}/agent-images/{id}

  • Write

    Create an agent image

    Buildkite manages the base image for all hosted agent images. Submit only the Dockerfile body — the instructions to layer on top of the base image. Do not include a FROM instruction; Buildkite prepends the managed base image automatically. Image builds are asynchronous. The response returns the current status. Poll get an agent image until status changes from BUILDING to READY or FAILED . Required request body properties : Required scope: write_clusters Required permission: permission to manage the cluster Success response: 201 Created Error responses:

    POST /v2/organizations/{org.slug}/clusters/{cluster.id}/agent-images

  • Destructive

    Delete an agent image

    Deleting an agent image that is currently assigned to one or more queues returns 409 Conflict . Reassign those queues to a different agent image before deleting. Required scope: write_clusters Required permission: permission to manage the cluster Success response: 204 No Content Error responses:

    DELETE /v2/organizations/{org.slug}/clusters/{cluster.id}/agent-images/{id}

clusters/agent-tokens

  • Read

    List tokens

    Returns a paginated list of a cluster's agent tokens. Required scope: read_clusters Success response: 200 OK

    GET /v2/organizations/{org.slug}/clusters/{cluster.id}/tokens

  • Read

    Get a token

    Required scope: read_clusters Success response: 200 OK

    GET /v2/organizations/{org.slug}/clusters/{cluster.id}/tokens/{token.id}

  • Write

    Create a token

    Required request body properties : Optional request body properties : Required scope: write_clusters Success response: 201 Created Error responses:

    POST /v2/organizations/{org.slug}/clusters/{cluster.id}/tokens

  • Write

    Update a token

    Request body properties : Required scope: write_clusters Success response: 200 OK Error responses:

    PUT /v2/organizations/{org.slug}/clusters/{cluster.id}/tokens/{id}

  • Destructive

    Revoke a token

    Required scope: write_clusters Success response: 204 No Content Error responses:

    DELETE /v2/organizations/{org.slug}/clusters/{cluster.id}/tokens/{id}

clusters/cache-registries

  • Read

    List cache registries

    Returns a paginated list of a cluster's cache registries, ordered by slug. This endpoint uses cursor-based pagination. The response body is a JSON object with an items array and a links object. Use the next URL from links to fetch the next page. Follow that URL instead of constructing cursor values. Optional query string parameters : Required scope: read_clusters Required permission: permission to manage the cluster Success response: 200 OK Error responses:

    GET /v2/organizations/{org.slug}/clusters/{cluster.id}/cache-registries

  • Read

    Get a cache registry

    Returns the details for a single cache registry, looked up by UUID. The response contains the cache registry data model . Required scope: read_clusters Required permission: permission to manage the cluster Success response: 200 OK Error response: 404 Not Found when the cluster doesn't exist, or when no cache registry matches the given UUID in this cluster. Passing a slug instead of a UUID also returns 404 Not Found .

    GET /v2/organizations/{org.slug}/clusters/{cluster.id}/cache-registries/{id}

  • Write

    Create a cache registry

    Creates a new cache registry in a cluster. The response contains the created cache registry data model . Required request body properties : Optional request body properties : The cache store can't be set through this API. New cache registries use agent-managed storage. Required scope: write_clusters Required permission: permission to manage the cluster Success response: 201 Created Error responses:

    POST /v2/organizations/{org.slug}/clusters/{cluster.id}/cache-registries

  • Destructive

    Update a cache registry

    Updates a cache registry, looked up by UUID. Properties omitted from the request body are left unchanged. Supplying policy replaces the entire policy rather than merging its nested properties. The response contains the updated cache registry data model . Optional request body properties : The cache registry's uuid and cache store can't be changed through this API. Required scope: write_clusters Required permission: permission to manage the cluster Success response: 200 OK Error responses:

    PATCH /v2/organizations/{org.slug}/clusters/{cluster.id}/cache-registries/{id}

  • Destructive

    Delete a cache registry

    Deletes a cache registry, looked up by UUID. A cluster's default cache registry can't be deleted. First, set another registry as the cluster's default, either in the web interface ( open the registry and select Settings > Set as default ) or by setting default_cache_registry_uuid on the cluster update endpoint . Required scope: write_clusters Required permission: permission to manage the cluster, and permission to destroy the cache registry Success response: 204 No Content Error responses:

    DELETE /v2/organizations/{org.slug}/clusters/{cluster.id}/cache-registries/{id}

clusters/cache-volumes

  • Read

    List cache volumes

    Returns an unpaginated list containing the latest detached cache volume for each tag. Volumes that have not been detached are not returned. Non-hosted clusters and hosted clusters with no detached cache volumes return an empty list. Required scope: read_clusters Required permission: permission to manage the cluster Success response: 200 OK Error responses:

    GET /v2/organizations/{org.slug}/clusters/{cluster.id}/cache_volumes

  • Destructive

    Delete a cache volume

    Deletes cache data by its tag. Cache tags can contain / and ; . The tag is passed in the request body rather than as a URL path segment. Use the tag from a list response, not the cache volume id . Deletion applies to the tag represented by the list result. Required request body properties : Required scope: write_clusters Required permission: permission to manage the cluster Success response: 204 No Content Error responses:

    DELETE /v2/organizations/{org.slug}/clusters/{cluster.id}/cache_volumes

clusters/maintainers

  • Read

    List cluster maintainers

    Returns a list of maintainers on a cluster . Required scope: read_clusters Success response: 200 OK

    GET /v2/organizations/{org.slug}/clusters/{cluster.id}/maintainers

  • Read

    Get a cluster maintainer

    Required scope: read_clusters Success response: 200 OK

    GET /v2/organizations/{org.slug}/clusters/{cluster.id}/maintainers/{id}

  • Write

    Create a cluster maintainer

    Assigns cluster maintainer permissions to a user or team .

    POST /v2/organizations/{org.slug}/clusters/{cluster.id}/maintainers

clusters/network-ranges

  • Read

    List network ranges

    Returns an unpaginated list of egress network ranges for a cluster. Non-hosted clusters and hosted clusters with no configured ranges return an empty list. Required scope: read_clusters Required permission: permission to manage the cluster Success response: 200 OK Error responses:

    GET /v2/organizations/{org.slug}/clusters/{cluster.id}/network_ranges

clusters/queues

  • Read

    List queues

    Returns a paginated list of a cluster's queues. Required scope: read_clusters Success response: 200 OK

    GET /v2/organizations/{org.slug}/clusters/{cluster.id}/queues

  • Read

    Get a queue

    Required scope: read_clusters Success response: 200 OK

    GET /v2/organizations/{org.slug}/clusters/{cluster.id}/queues/{queue.id}

  • Write

    Create a self-hosted queue

    Required request body properties : Optional request body properties : Required scope: write_clusters Success response: 201 Created Error responses:

    POST /v2/organizations/{org.slug}/clusters/{cluster.id}/queues

  • Write

    Create a Buildkite hosted queue

    Required request body properties : Optional request body properties : Required scope: write_clusters Success response: 201 Created Error responses:

    POST /v2/organizations/{org.slug}/clusters/{cluster.id}/queues

  • Write

    Resume a paused queue

    Required scope: write_clusters Success response: 200 OK Error responses:

    POST /v2/organizations/{org.slug}/clusters/{cluster.id}/queues/{id}/resume_dispatch

  • Destructive

    Update a queue

    Request body properties : Required scope: write_clusters Success response: 200 OK Error responses:

    PUT /v2/organizations/{org.slug}/clusters/{cluster.id}/queues/{id}

  • Destructive

    Delete a queue

    Required scope: write_clusters Success response: 204 No Content Error responses:

    DELETE /v2/organizations/{org.slug}/clusters/{cluster.id}/queues/{id}

  • Destructive

    Pause a queue

    Pause a queue to prevent jobs from being dispatched to agents associated with the queue. Optional request body properties : Required scope: write_clusters Success response: 200 OK Error responses:

    POST /v2/organizations/{org.slug}/clusters/{cluster.id}/queues/{id}/pause_dispatch

clusters/secrets

  • Read

    List secrets

    Returns a paginated list of a cluster's secrets. Required scope: read_secrets_details Success response: 200 OK

    GET /v2/organizations/{org.slug}/clusters/{cluster.id}/secrets

  • Read

    Get a secret

    Required scope: read_secrets_details Success response: 200 OK

    GET /v2/organizations/{org.slug}/clusters/{cluster.id}/secrets/{id}

  • Write

    Create a secret

    Required request body properties : Optional request body properties : Required scope: write_secrets Success response: 201 Created

    POST /v2/organizations/{org.slug}/clusters/{cluster.id}/secrets

  • Destructive

    Update a secret's description and access policy

    Updates a secret's description and access policy. To update its value instead, see Update a secret's value . Optional request body properties : Unpermitted request body properties : Required scope: write_secrets Success response: 200 OK

    PUT /v2/organizations/{org.slug}/clusters/{cluster.id}/secrets/{id}

  • Destructive

    Update a secret's value

    Updates a secret's encrypted value only. To update the secret's other details, see Update a secret's description and access policy . Required request body properties : Required scope: write_secrets Success response: 200 OK

    PUT /v2/organizations/{org.slug}/clusters/{cluster.id}/secrets/{id}/value

  • Destructive

    Delete a secret

    Required scope: write_secrets Success response: 204 No Content

    DELETE /v2/organizations/{org.slug}/clusters/{cluster.id}/secrets/{id}

emojis

  • Read

    List emojis

    Returns a list of all the emojis for a given organization, including custom emojis and aliases. This list is not paginated. Required scope: none Success response: 200 OK

    GET /v2/organizations/{org.slug}/emojis

jobs

  • Read

    List jobs

    Returns a paginated list of jobs in a build. This endpoint uses cursor-based pagination. The response body is a JSON object with an items array and a links object. Use the next URL from links to fetch the next page. Optional query string parameters : Required scope: read_builds Success response: 200 OK Error responses:

    GET /v2/organizations/{org.slug}/pipelines/{pipeline.slug}/builds/{build.number}/jobs

  • Read

    Get a job

    Returns a single job. You can also use the organization-scoped route if you only have the organization slug and job UUID (without the pipeline or build): Required scope: read_builds Success response: 200 OK Error responses:

    GET /v2/organizations/{org.slug}/pipelines/{pipeline.slug}/builds/{build.number}/jobs/{job.id}

  • Read

    Get a job (alternate route)

    Returns a single job. You can also use the organization-scoped route if you only have the organization slug and job UUID (without the pipeline or build): Required scope: read_builds Success response: 200 OK Error responses:

    GET /v2/organizations/{org.slug}/jobs/{job.id}

  • Read

    Get a job's log output

    You can also use the build-scoped route if you have the pipeline slug and build number: Required scope: read_build_logs Success response: 200 OK Alternative formats (using Accept header or file extension):

    GET /v2/organizations/{org.slug}/jobs/{job.id}/log

  • Read

    Get a job's log output (build-scoped route)

    You can also use the build-scoped route if you have the pipeline slug and build number: Required scope: read_build_logs Success response: 200 OK Alternative formats (using Accept header or file extension):

    GET /v2/organizations/{org.slug}/pipelines/{pipeline.slug}/builds/{build.number}/jobs/{job.id}/log

  • Read

    Get log size without downloading

    Use HEAD instead of GET to retrieve the byte size of a job log without downloading its content. This is useful for monitoring log growth or checking whether new output is available. You can also use the build-scoped route: A successful response has no body and includes: Required scope: read_build_logs Success response: 200 OK

    HEAD /v2/organizations/{org.slug}/jobs/{job.id}/log

  • Read

    Get log size without downloading (build-scoped route)

    Use HEAD instead of GET to retrieve the byte size of a job log without downloading its content. This is useful for monitoring log growth or checking whether new output is available. You can also use the build-scoped route: A successful response has no body and includes: Required scope: read_build_logs Success response: 200 OK

    HEAD /v2/organizations/{org.slug}/pipelines/{pipeline.slug}/builds/{build.number}/jobs/{job.id}/log

  • Read

    Get a log tail using a range request

    To retrieve only the last N bytes of a job log, send a GET request with Accept: text/plain and a Range: bytes=-N header. This avoids downloading the entire log when you only need the most recent output. Range requests are only supported with Accept: text/plain . Only suffix ranges ( bytes=-N ) are supported. Explicit start-end ranges and multipart ranges are not supported. The response body contains the raw stored bytes without UTF-8 normalization, so Content-Length reflects the exact number of bytes returned. A successful partial response includes: Required scope: read_build_logs Success response: 206 Partial Content Error responses:

    GET /v2/organizations/{org.slug}/jobs/{job.id}/log

  • Read

    Get a job's environment variables

    You can also use the build-scoped route if you have the pipeline slug and build number: Required scope: read_job_env Success response: 200 OK Alternative formats (using Accept header or file extension):

    GET /v2/organizations/{org.slug}/jobs/{job.id}/env

  • Read

    Get a job's environment variables (build-scoped route)

    You can also use the build-scoped route if you have the pipeline slug and build number: Required scope: read_job_env Success response: 200 OK Alternative formats (using Accept header or file extension):

    GET /v2/organizations/{org.slug}/pipelines/{pipeline.slug}/builds/{build.number}/jobs/{job.id}/env

  • Write

    Create a remote desktop session

    Creates connection details for a running command job on a macOS hosted agent. The response includes a short-lived access token. Use this endpoint to connect a VNC client to the job's desktop. The response includes the Cache-Control: no-store header. Required scope: write_builds The authenticated user must have permission to manage hosted agents for the job. Remote access must also be active for the Buildkite organization. Success response: 200 OK Error responses:

    POST /v2/organizations/{org.slug}/jobs/{job.id}/vnc-session

  • Write

    Create an SSH session

    Creates connection details for a running command job on a macOS or Linux hosted agent. The response includes a short-lived access token. Use this endpoint to open an interactive SSH session with the job. For a Linux hosted job, transport is tcp , and ssh.host_keys contains one or more SSH host public keys. Verify the job's host against these keys before completing the SSH handshake. For a macOS hosted job, transport remains namespace_ingress and ssh.host_keys is always an empty array. Host verification happens as part of the ingress connection. The response includes the Cache-Control: no-store header. Required scope: write_builds The authenticated user must have permission to manage hosted agents for the job. Remote access must also be active for the Buildkite organization. Success response: 200 OK Error responses:

    POST /v2/organizations/{org.slug}/jobs/{job.id}/ssh-session

  • Write

    Retry a job

    Retries a failed OR timed_out OR a job whose step has the manual retry after passing attribute set to true (that is, permit_on_passed: true ). You can only retry each job.id once. To retry a "second time" use the new job.id returned in the first retry query. You can also use the build-scoped route if you have the pipeline slug and build number: Required scope: write_builds Success response: 200 OK Error responses:

    PUT /v2/organizations/{org.slug}/jobs/{job.id}/retry

  • Write

    Retry a job (build-scoped route)

    Retries a failed OR timed_out OR a job whose step has the manual retry after passing attribute set to true (that is, permit_on_passed: true ). You can only retry each job.id once. To retry a "second time" use the new job.id returned in the first retry query. You can also use the build-scoped route if you have the pipeline slug and build number: Required scope: write_builds Success response: 200 OK Error responses:

    PUT /v2/organizations/{org.slug}/pipelines/{pipeline.slug}/builds/{build.number}/jobs/{job.id}/retry

  • Write

    Reprioritize a job

    Reprioritizes a job by changing its priority value . This affects the order in which jobs are picked up by agents. You can also use the build-scoped route if you have the pipeline slug and build number: Required request body properties : Required scope: write_builds Success response: 200 OK Error responses:

    PUT /v2/organizations/{org.slug}/jobs/{job.id}/reprioritize

  • Write

    Reprioritize a job (build-scoped route)

    Reprioritizes a job by changing its priority value . This affects the order in which jobs are picked up by agents. You can also use the build-scoped route if you have the pipeline slug and build number: Required request body properties : Required scope: write_builds Success response: 200 OK Error responses:

    PUT /v2/organizations/{org.slug}/pipelines/{pipeline.slug}/builds/{build.number}/jobs/{job.id}/reprioritize

  • Write

    Unblock a job

    Unblocks a build's "Block pipeline" job. The job's unblockable property indicates whether it is able to be unblocked, and the unblock_url property points to this endpoint. You can also use the build-scoped route if you have the pipeline slug and build number: Optional request body properties : Required scope: write_builds Success response: 200 OK Error responses:

    PUT /v2/organizations/{org.slug}/jobs/{job.id}/unblock

  • Write

    Unblock a job (build-scoped route)

    Unblocks a build's "Block pipeline" job. The job's unblockable property indicates whether it is able to be unblocked, and the unblock_url property points to this endpoint. You can also use the build-scoped route if you have the pipeline slug and build number: Optional request body properties : Required scope: write_builds Success response: 200 OK Error responses:

    PUT /v2/organizations/{org.slug}/pipelines/{pipeline.slug}/builds/{build.number}/jobs/{job.id}/unblock

  • Destructive

    Cancel a job

    Cancels a command job that is scheduled , reserved , assigned , accepted , or running . A job that hasn't started running moves straight to canceled . A running job moves to canceling while its agent stops the job, and then moves to canceled . Canceling a job can cause its build to fail. Learn more in Manually cancel a job . You can also use the build-scoped route if you have the pipeline slug and build number: This endpoint doesn't use a request body. The response contains the canceled job. The following example shows a job that was running when it was canceled: Required scope: write_builds The authenticated user must have permission to cancel the job. Success response: 200 OK Error responses:

    PUT /v2/organizations/{org.slug}/jobs/{job.id}/cancel

  • Destructive

    Cancel a job (build-scoped route)

    Cancels a command job that is scheduled , reserved , assigned , accepted , or running . A job that hasn't started running moves straight to canceled . A running job moves to canceling while its agent stops the job, and then moves to canceled . Canceling a job can cause its build to fail. Learn more in Manually cancel a job . You can also use the build-scoped route if you have the pipeline slug and build number: This endpoint doesn't use a request body. The response contains the canceled job. The following example shows a job that was running when it was canceled: Required scope: write_builds The authenticated user must have permission to cancel the job. Success response: 200 OK Error responses:

    PUT /v2/organizations/{org.slug}/pipelines/{pipeline.slug}/builds/{build.number}/jobs/{job.id}/cancel

  • Destructive

    Delete a job's log output

    You can also use the build-scoped route if you have the pipeline slug and build number: Required scope: write_build_logs Success response: 204 No Content

    DELETE /v2/organizations/{org.slug}/jobs/{job.id}/log

  • Destructive

    Delete a job's log output (build-scoped route)

    You can also use the build-scoped route if you have the pipeline slug and build number: Required scope: write_build_logs Success response: 204 No Content

    DELETE /v2/organizations/{org.slug}/pipelines/{pipeline.slug}/builds/{build.number}/jobs/{job.id}/log

meta

  • Read

    Get meta information

    Returns an object with properties describing Buildkite. webhook_ips is a list of IP addresses in CIDR notation that Buildkite uses to send outbound traffic such as webhooks and commit statuses. These are subject to change from time to time. We recommend checking for new addresses daily, and will try to advertise new addresses for at least 7 days before they are used. Note: The IP addresses shown here are examples. You must query the API to get the current set of IP addresses. Success response: 200 OK

    GET /v2/meta

organizations

  • Read

    List organizations

    Returns a paginated list of organizations accessible by the user's access token. Required scope: read_organizations Success response: 200 OK

    GET /v2/organizations

  • Read

    Get an organization

    Required scope: read_organizations Success response: 200 OK

    GET /v2/organizations/{org.slug}

organizations/api-settings

  • Read

    Get API settings

    Required scope: read_organization_settings Success response: 200 OK Error responses:

    GET /v2/organizations/{org.slug}/api-settings

  • Destructive

    Update API settings

    Updates one or more API security settings for the organization. Include only the fields you want to change. The response contains the full updated settings. Required scope: write_organization_settings Success response: 200 OK Error responses:

    PATCH /v2/organizations/{org.slug}/api-settings

organizations/audit-events

  • Read

    List audit events

    Returns a paginated list of audit events for an organization, ordered from newest to oldest. The response body contains the following pagination fields: Optional query string parameters: Required scope: read_audit_events Success response: 200 OK Error responses:

    GET /v2/organizations/{org.slug}/audit_events

  • Read

    Get an audit event

    Returns a single audit event by UUID. Required scope: read_audit_events Success response: 200 OK Error responses:

    GET /v2/organizations/{org.slug}/audit_events/{uuid}

organizations/banner

  • Read

    Get the banner

    Required scope: read_organization_settings Success response: 200 OK Error responses:

    GET /v2/organizations/{org.slug}/banner

  • Write

    Create or update the banner

    Creates the banner if the organization doesn't have one, or updates the existing banner's message. The response status indicates which happened. Request fields: Required scope: write_organization_settings Success response: 201 Created when a banner is created, 200 OK when an existing banner is updated. Error responses:

    PUT /v2/organizations/{org.slug}/banner

  • Destructive

    Delete the banner

    Removes the organization's active banner. Required scope: write_organization_settings Success response: 204 No Content Error responses:

    DELETE /v2/organizations/{org.slug}/banner

organizations/invitations

  • Read

    List organization invitations

    Returns a paginated list of pending invitations for an organization, ordered from newest to oldest. The list does not include accepted, revoked, or expired invitations. You can retrieve those invitations individually by UUID. The response body contains the following pagination fields: Optional query string parameters: Required scope: read_organization_invitations Required permission: permission to invite organization members Success response: 200 OK Error responses:

    GET /v2/organizations/{org.slug}/invitations

  • Read

    Get an organization invitation

    Returns a single invitation by UUID. Unlike the list endpoint, this returns invitations in any state. Required scope: read_organization_invitations Required permission: permission to invite organization members Success response: 200 OK Error responses:

    GET /v2/organizations/{org.slug}/invitations/{uuid}

  • Write

    Create organization invitations

    Creates invitations for one or more email addresses. The response contains the created invitations. The API treats duplicate email addresses as one address, regardless of capitalization. The entire batch is validated before any invitations are created. If any address is invalid, no invitations are created. Required request body properties : Optional request body properties : Required scope: write_organization_invitations Required permission: permission to invite organization members Success response: 201 Created Error responses:

    POST /v2/organizations/{org.slug}/invitations

  • Destructive

    Revoke an organization invitation

    Revokes a pending invitation. Returns no content on success. Only pending invitations can be revoked. Required scope: write_organization_invitations Required permission: permission to invite organization members Success response: 204 No Content Error responses:

    DELETE /v2/organizations/{org.slug}/invitations/{uuid}

organizations/members

  • Read

    List organization members

    Returns a list of an organization's members. Required scope: read_organizations Required permission: permission to view teams in the organization Success response: 200 OK

    GET /v2/organizations/{org.slug}/members

  • Read

    Get an organization member

    Required scope: read_organizations Required permission: permission to view teams in the organization Success response: 200 OK

    GET /v2/organizations/{org.slug}/members/{user.uuid}

  • Destructive

    Update an organization member

    Updates a member's role or SSO mode within the organization. At least one of role or sso_mode must be provided. You cannot update your own membership. Optional request body properties : Required scope: write_organizations Required permission: permission to update the organization member Success response: 200 OK Error responses:

    PATCH /v2/organizations/{org.slug}/members/{user.uuid}

  • Destructive

    Remove an organization member

    Required scope: write_organizations Required permission: permission to remove the organization member Success response: 204 No Content Error responses:

    DELETE /v2/organizations/{org.slug}/members/{user.uuid}

organizations/notification-services

  • Read

    List notification services

    Returns a cursor-paginated list of notification services, ordered from oldest to newest. The response contains notification service objects in items and pagination URLs in links : Optional query string parameters : Required scope: read_notification_services Success response: 200 OK

    GET /v2/organizations/{org.slug}/services

  • Read

    Get a notification service

    Returns a notification service by UUID. Required scope: read_notification_services Success response: 200 OK Error response: 404 Not Found when no notification service is found for the UUID in the organization.

    GET /v2/organizations/{org.slug}/services/{uuid}

  • Write

    Create a notification service

    Creates a notification service. OAuth-managed slack_workspace and linear services must first be connected using the Buildkite interface, but can then be read, updated, deleted, enabled, and disabled using the API. Request body properties : Required scope: write_notification_services Success response: 201 Created Error response: 422 Unprocessable Entity when the request contains invalid, unavailable, unknown, or read-only fields.

    POST /v2/organizations/{org.slug}/services

  • Write

    Update a notification service

    Updates only the fields in the request. Omitted top-level fields and settings remain unchanged. The request accepts the same optional properties as create. If supplied, provider must match the existing provider because a service's provider cannot be changed. Some settings have additional update restrictions: Resending unchanged restricted or masked values from a get response is allowed, so a get-update round trip does not overwrite secrets. Required scope: write_notification_services Success response: 200 OK Error responses: 404 Not Found when the notification service cannot be found, or 422 Unprocessable Entity when the update is invalid.

    PATCH /v2/organizations/{org.slug}/services/{uuid}

  • Write

    Enable a notification service

    Enables a notification service and clears any previous disabled or broken state. The response contains the updated notification service object. Required scope: write_notification_services Success response: 200 OK Error response: 404 Not Found when the notification service cannot be found.

    PUT /v2/organizations/{org.slug}/services/{uuid}/enable

  • Destructive

    Delete a notification service

    Deletes a notification service. Required scope: write_notification_services Success response: 204 No Content Error responses: 404 Not Found when the notification service cannot be found, or 422 Unprocessable Entity when Buildkite cannot remove the provider configuration.

    DELETE /v2/organizations/{org.slug}/services/{uuid}

  • Destructive

    Disable a notification service

    Disables a notification service. The response contains the updated notification service object. Required scope: write_notification_services Success response: 200 OK Error response: 404 Not Found when the notification service cannot be found.

    PUT /v2/organizations/{org.slug}/services/{uuid}/disable

organizations/pipeline-settings

  • Read

    Get pipeline settings

    Required scope: read_organization_settings Success response: 200 OK Error responses:

    GET /v2/organizations/{org.slug}/pipeline-settings

  • Write

    Enable hosted agents remote access

    Enables remote access for hosted agents in the organization. SSH access applies to Linux and macOS hosted agents. VNC access applies only to supported macOS hosted jobs. Windows hosted agents don't support SSH or VNC access. Records who enabled remote access and when. Returns the full pipeline settings resource. Required scope: write_organization_settings Success response: 200 OK Error responses:

    PUT /v2/organizations/{org.slug}/pipeline-settings/hosted-agents-ssh

  • Write

    Enable public pipeline creation

    Allows organization members to create public pipelines. Returns the full pipeline settings resource. Required scope: write_organization_settings Success response: 200 OK Error responses:

    PUT /v2/organizations/{org.slug}/pipeline-settings/public-pipelines

  • Write

    Enable advanced queue metrics

    Enables advanced queue metrics for clusters in the organization. This is a one-way operation. Once enabled, it cannot be disabled via the API (the disable_supported field in the response will be false ). To disable advanced queue metrics, contact Buildkite support. Returns the full pipeline settings resource. Required scope: write_organization_settings Success response: 200 OK Error responses:

    PUT /v2/organizations/{org.slug}/pipeline-settings/advanced-queue-metrics

  • Write

    Configure build export

    Sets the location and strategy for exporting build data. Build export is a plan-gated feature. The build_exports.available field in the response indicates whether it is available on your plan. Returns the full pipeline settings resource. Required scope: write_organization_settings Success response: 200 OK Error responses:

    PUT /v2/organizations/{org.slug}/pipeline-settings/build-export

  • Destructive

    Update pipeline settings

    Updates one or more simple pipeline settings for the organization. Only the fields you include in the request body are changed. Required scope: write_organization_settings Success response: 200 OK Error responses:

    PATCH /v2/organizations/{org.slug}/pipeline-settings

  • Destructive

    Disable hosted agents remote access

    Disables remote access for hosted agents in the organization. This action removes SSH access from Linux and macOS hosted agents and VNC access from supported macOS hosted jobs. Returns the full pipeline settings resource. Required scope: write_organization_settings Success response: 200 OK Error responses:

    DELETE /v2/organizations/{org.slug}/pipeline-settings/hosted-agents-ssh

  • Destructive

    Disable public pipeline creation

    Prevents organization members from creating public pipelines. Returns the full pipeline settings resource. Required scope: write_organization_settings Success response: 200 OK Error responses:

    DELETE /v2/organizations/{org.slug}/pipeline-settings/public-pipelines

  • Destructive

    Disable build export

    Clears the build export configuration, stopping further build data exports. Returns the full pipeline settings resource. Required scope: write_organization_settings Success response: 200 OK Error responses:

    DELETE /v2/organizations/{org.slug}/pipeline-settings/build-export

organizations/rate-limits

  • Read

    Get rate limits

    Returns the current REST API and GraphQL API rate limits for a Buildkite organization, along with the authenticated caller's per-user REST and remote MCP server rate limit status. Requests to this endpoint don't count towards your organization's REST API rate limit, your per-user rate limit, or your remote MCP server rate limit. Required scope: read_organizations Success response: 200 OK

    GET /v2/organizations/{organization.slug}/rate_limit

organizations/repository-connections

  • Read

    List repository connections

    Returns an unpaginated list of repository connections for an organization. Required scope: read_organization_repository_connections Required permission: organization administrator access Success response: 200 OK

    GET /v2/organizations/{org.slug}/repository_connections

  • Read

    Get a repository connection

    Returns a repository connection by its ID. Required scope: read_organization_repository_connections Required permission: organization administrator access Success response: 200 OK Error responses:

    GET /v2/organizations/{org.slug}/repository_connections/{id}

organizations/usage

  • Read

    Get organization usage

    Success response: 200 OK . The following response excerpts omit other fields and metrics. Concurrent agents: Test executions:

    GET /v2/organizations/{org.slug}/usage

package-registries/packages

  • Read

    List all packages

    Returns a paginated list of all packages in a registry. Packages are listed in the order they were created (newest first). Optional query string parameters : Required scope: read_packages Success response: 200 OK

    GET /v2/packages/organizations/{org.slug}/registries/{registry.slug}/packages

  • Read

    Get a package

    Returns the details for a single package. Required scope: read_packages Success response: 200 OK

    GET /v2/packages/organizations/{org.slug}/registries/{registry.slug}/packages/{id}

  • Write

    Publish a package

    The following type of curl syntax for publishing to registries will work across all package ecosystems supported by Buildkite Package Registries , with the file form-field modified accordingly. However, this type of REST API call is just recommended for: For other supported package ecosystems, it is recommended that you use their native tools to publish to registries in your Buildkite Package Registries organization. These ecosystems' native tools are for: The following type of response is returned by Buildkite upon a successful curl publishing event. Required request form-field content: Required scope: write_packages Success response: 200 OK

    POST /v2/packages/organizations/{org.slug}/registries/{registry.slug}/packages

  • Write

    Copy a package

    For some supported package ecosystems , copies a package from a source registry to a destination registry. Currently, this REST API call only supports package types belonging to the following package ecosystems: If you wish this feature to be available for package types belonging to other package ecosystems, please contact support . The following type of response is returned by Buildkite upon a successful curl copying event. Required query string parameters : Required scopes: read_packages, write_packages Success response: 200 OK

    POST /v2/packages/organizations/{org.slug}/registries/{source_registry.slug}/packages/{package.id}/copy

  • Destructive

    Delete a package

    Required scope: delete_packages Success response: 200 OK

    DELETE /v2/packages/organizations/{org.slug}/registries/{registry.slug}/packages/{id}

package-registries/registries

  • Read

    List all registries

    Returns a list of an organization's registries. Required scope: read_registries Success response: 200 OK

    GET /v2/packages/organizations/{org.slug}/registries

  • Read

    Get a registry

    Returns the details for a single registry, looked up by its slug. Required scope: read_registries Success response: 200 OK

    GET /v2/packages/organizations/{org.slug}/registries/{registry.slug}

  • Write

    Create a registry

    Required request body properties : Optional request body properties : Required scope: write_registries Success response: 200 OK

    POST /v2/packages/organizations/{org.slug}/registries

  • Write

    Update a registry

    Optional request body properties : Required scope: write_registries Success response: 200 OK

    POST /v2/packages/organizations/{org.slug}/registries/{registry.slug}

  • Destructive

    Delete a registry

    Required scope: delete_registries Success response: 200 OK

    DELETE /v2/packages/organizations/{org.slug}/registries/{registry.slug}

package-registries/registry-tokens

  • Read

    List all registry tokens

    Returns a list of a registry's tokens. Required scope: read_registries Success response: 200 OK

    GET /v2/packages/organizations/{org.slug}/registries/{registry.slug}/tokens

  • Read

    Get a registry token

    Returns the details for a single registry token. Required scope: read_registries Success response: 200 OK

    GET /v2/packages/organizations/{org.slug}/registries/{registry.slug}/tokens/{id}

  • Write

    Create a registry token

    Required request body properties : Required scope: write_registries Success response: 200 OK

    POST /v2/packages/organizations/{org.slug}/registries/{registry.slug}/tokens

  • Destructive

    Update a registry token

    Required request body properties : Required scope: write_registries Success response: 200 OK

    POST /v2/packages/organizations/{org.slug}/registries/{registry.slug}/tokens/{id}

  • Destructive

    Delete a registry token

    Required scope: write_registries Success response: 200 OK

    DELETE /v2/packages/organizations/{org.slug}/registries/{registry.slug}/tokens/{id}

pipeline-schedules

  • Read

    List pipeline schedules

    Returns a paginated list of the schedules for a pipeline, with the most recently created first. Example request: Example response: Required scope: read_pipelines Success response: 200 OK

    GET /v2/organizations/{org.slug}/pipelines/{pipeline.slug}/schedules

  • Read

    Get a pipeline schedule

    Returns the details for a single pipeline schedule. Example request: Example response: Required scope: read_pipelines Success response: 200 OK

    GET /v2/organizations/{org.slug}/pipelines/{pipeline.slug}/schedules/{id}

  • Write

    Create a pipeline schedule

    Creates a new pipeline schedule. Example request: Example response: Required request body properties : Optional request body properties : Required scope: write_pipelines Success response: 201 Created Error responses:

    POST /v2/organizations/{org.slug}/pipelines/{pipeline.slug}/schedules

  • Destructive

    Update a pipeline schedule

    Updates the pipeline schedule. Example request: Example response: Optional request body properties : Required scope: write_pipelines Success response: 200 OK Error responses:

    PUT /v2/organizations/{org.slug}/pipelines/{pipeline.slug}/schedules/{id}

  • Destructive

    Delete a pipeline schedule

    Deletes a pipeline schedule. Example request: Required scope: write_pipelines Success response: 204 No Content

    DELETE /v2/organizations/{org.slug}/pipelines/{pipeline.slug}/schedules/{id}

pipeline-templates

  • Read

    List pipeline templates

    Returns a list of an organization's pipeline templates. Required scope: read_pipeline_templates Success response: 200 OK

    GET /v2/organizations/{org.slug}/pipeline-templates

  • Read

    Get a pipeline template

    Required scope: read_pipeline_templates Success response: 200 OK

    GET /v2/organizations/{org.slug}/pipeline-templates/{uuid}

  • Write

    Create a pipeline template

    Required request body properties : Optional request body properties : Required scope: write_pipeline_templates Success response: 201 Created Error responses:

    POST /v2/organizations/{org.slug}/pipeline-templates

  • Destructive

    Update a pipeline template

    Optional request body properties : Required scope: write_pipeline_templates Success response: 200 OK Error responses:

    PATCH /v2/organizations/{org.slug}/pipeline-templates/{uuid}

  • Destructive

    Delete a pipeline template

    Required scope: write_pipeline_templates Success response: 204 No Content Error responses:

    DELETE /v2/organizations/{org.slug}/pipeline-templates/{uuid}

pipeline-trigger-deliveries

  • Read

    List a trigger's deliveries

    Returns a paginated list of a pipeline trigger's retained deliveries, newest first. This endpoint uses cursor-based pagination. The response body is a JSON object with an items array and a links object. Use the next URL from links to fetch the next page. Follow that URL instead of constructing cursor values. Optional query string parameters : Required scope: read_pipelines Required permission: Full Access to the pipeline Success response: 200 OK Error responses:

    GET /v2/organizations/{org.slug}/pipelines/{pipeline.slug}/triggers/{trigger.id}/deliveries

  • Read

    Get a delivery

    Returns a single retained delivery. Required scope: read_pipelines Required permission: Full Access to the pipeline Success response: 200 OK Error response: 404 Not Found when no delivery matches the given ID for this trigger, or the delivery is no longer retained.

    GET /v2/organizations/{org.slug}/pipelines/{pipeline.slug}/triggers/{trigger.id}/deliveries/{delivery.id}

  • Read

    Get a delivery's request

    Returns the request that Buildkite Pipelines received for a delivery, including its parsed payload and headers. Header values are allowlisted before they are returned. Only the GitHub event and delivery ID header values are included. Every other header value is redacted, including authorization, cookie, signature, and token headers. Header names are normalized to lowercase, such as x-github-event . The headers value is an empty array when the delivery has no stored headers. The payload value isn't redacted and can contain sensitive data from the sending system. This response is sent with Cache-Control: private, no-store and isn't cached. Required scope: read_pipelines Required permission: Full Access to the pipeline Success response: 200 OK Error response: 404 Not Found when no delivery matches the given ID for this trigger, or the delivery is no longer retained.

    GET /v2/organizations/{org.slug}/pipelines/{pipeline.slug}/triggers/{trigger.id}/deliveries/{delivery.id}/request

pipeline-triggers

  • Read

    List pipeline triggers

    Returns a paginated list of the pipeline triggers for a pipeline, with the most recently created first. This endpoint uses cursor-based pagination. The response body is a JSON object with an items array and a links object. Use the next URL from links to fetch the next page. Follow that URL instead of constructing cursor values. Full endpoint URLs, environment variable values, and verification secrets aren't included in list responses. Use endpoint_url_hint to identify a pipeline trigger without exposing its credentials. Optional query string parameters : Required scope: read_pipelines Required permission: Full Access to the pipeline Success response: 200 OK Error responses:

    GET /v2/organizations/{org.slug}/pipelines/{pipeline.slug}/triggers

  • Read

    Get a pipeline trigger

    Returns the details for a single pipeline trigger. The response doesn't include the full endpoint URL, environment variable values, or verification secret. Required scope: read_pipelines Required permission: Full Access to the pipeline Success response: 200 OK Error response: 404 Not Found when no pipeline trigger matches the given ID for this pipeline.

    GET /v2/organizations/{org.slug}/pipelines/{pipeline.slug}/triggers/{id}

  • Write

    Create a pipeline trigger

    Creates a new pipeline trigger. Required request body properties : Optional request body properties : Required scope: write_pipelines Required permission: Full Access to the pipeline Success response: 201 Created Error responses:

    POST /v2/organizations/{org.slug}/pipelines/{pipeline.slug}/triggers

  • Write

    Create a GitHub Actions pipeline trigger

    For a new pipeline, use the recommended GitHub Actions setup in the Buildkite interface .

    POST /v2/organizations/{org.slug}/pipelines/{pipeline.slug}/triggers

  • Destructive

    Update a pipeline trigger

    Updates a pipeline trigger. Attributes omitted from the request body are left unchanged. GitHub Actions triggers don't accept build or filter updates. Configure supported workflow on declarations instead. The response contains the updated pipeline trigger data model . The full endpoint URL, environment variable values, and verification secret aren't returned. Optional request body properties : The type value can't be changed after a pipeline trigger is created. Required scope: write_pipelines Required permission: Full Access to the pipeline Success response: 200 OK Error responses: 400 Bad Request for invalid JSON, 404 Not Found when the trigger doesn't exist for this pipeline, 415 Unsupported Media Type for a non-JSON content type, and 422 Unprocessable Entity for invalid configuration.

    PATCH /v2/organizations/{org.slug}/pipelines/{pipeline.slug}/triggers/{id}

  • Destructive

    Delete a pipeline trigger

    Deletes a pipeline trigger. Its endpoint immediately stops accepting incoming webhook deliveries. Required scope: write_pipelines Required permission: Full Access to the pipeline Success response: 204 No Content Error response: 404 Not Found when no pipeline trigger matches the given ID for this pipeline.

    DELETE /v2/organizations/{org.slug}/pipelines/{pipeline.slug}/triggers/{id}

pipelines

  • Read

    List pipelines

    Returns a paginated list of an organization's pipelines. Optional query string parameters : Required scope: read_pipelines Success response: 200 OK

    GET /v2/organizations/{org.slug}/pipelines

  • Read

    Get a pipeline

    Required scope: read_pipelines Success response: 200 OK

    GET /v2/organizations/{org.slug}/pipelines/{slug}

  • Read

    Get GitHub webhook processing state

    Required scope: read_pipelines Required permission: Full Access to the pipeline Success response: 200 OK

    GET /v2/organizations/{org.slug}/pipelines/{slug}/github-webhooks

  • Write

    Unarchive a pipeline

    Unarchived pipelines are editable, and are shown on the Pipeline pages. Required scope: write_pipelines Success response: 200 OK Error responses:

    POST /v2/organizations/{org.slug}/pipelines/{slug}/unarchive

  • Write

    Add a webhook

    Create a GitHub webhook for an existing pipeline that is configured using our GitHub App. Pushes to the linked GitHub repository will trigger builds. Required scope: write_pipelines Success response: 201 Created Error responses:

    POST /v2/organizations/{org.slug}/pipelines/{slug}/webhook

  • Write

    Enable GitHub webhook processing

    Enables incoming webhook processing for the pipeline. This operation is idempotent. If webhook processing is already enabled, the endpoint returns the current state without changing it. Required scope: write_pipelines Required permission: Full Access to the pipeline Success response: 200 OK

    PUT /v2/organizations/{org.slug}/pipelines/{slug}/github-webhooks

  • Destructive

    Create a YAML pipeline

    YAML pipelines are the recommended way to manage your pipelines .

    POST /v2/organizations/{org.slug}/pipelines

  • Destructive

    Create a visual step pipeline

    YAML pipelines are the recommended way to manage your pipelines but if you're still using visual steps you can add them by setting the steps key in your json request body to an array of steps: The response contains information about your new pipeline: The resulting pipeline: Required request body properties : Optional request body properties : Required scope: write_pipelines Success response: 201 Created Error responses:

    POST /v2/organizations/{org.slug}/pipelines

  • Destructive

    Update a pipeline

    Updates one or more properties of an existing pipeline. To update a pipeline's YAML steps, make a PATCH request to the pipelines endpoint, passing the configuration attribute in the request body: Optional request body properties : Required scope: write_pipelines Success response: 200 OK Error responses:

    PATCH /v2/organizations/{org.slug}/pipelines/{slug}

  • Destructive

    Archive a pipeline

    Archived pipelines are read-only, and are hidden from Pipeline pages by default. Builds, build logs, and artifacts are preserved. Required scope: write_pipelines Success response: 200 OK Error responses:

    POST /v2/organizations/{org.slug}/pipelines/{slug}/archive

  • Destructive

    Delete a pipeline

    Required scope: write_pipelines Success response: 204 No Content

    DELETE /v2/organizations/{org.slug}/pipelines/{slug}

  • Destructive

    Disable GitHub webhook processing

    Disables incoming webhook processing for the pipeline and records who disabled it and when. This operation is idempotent. If webhook processing is already disabled, the endpoint returns the current state without changing it. Required scope: write_pipelines Required permission: Full Access to the pipeline Success response: 200 OK

    DELETE /v2/organizations/{org.slug}/pipelines/{slug}/github-webhooks

portals

  • Read

    List portals

    Returns a paginated list of an organization's portals. Required scope: read_portals Success response: 200 OK

    GET /v2/organizations/{org.slug}/portals

  • Read

    Get a portal

    Required scope: read_portals Success response: 200 OK

    GET /v2/organizations/{org.slug}/portals/{portal.slug}

  • Write

    Create a portal

    Required request body properties : Request body properties : Required scope: write_portals Success response: 201 Created Error responses:

    POST /v2/organizations/{org.slug}/portals

  • Destructive

    Update a portal

    Optional request body properties : Required scope: write_portals Success response: 200 OK Error responses:

    PUT /v2/organizations/{org.slug}/portals/{portal.slug}

  • Destructive

    Delete a portal

    Delete a portal. Required scope: write_portals Success response: 204 No Content Error responses:

    DELETE /v2/organizations/{org.slug}/portals/{portal.slug}

repository-connections

  • Read

    List repositories

    Returns the repositories available to the specified repository connection, in provider order. This endpoint is supported for GitHub, GitHub Limited Access, GitHub Restricted, GitHub Enterprise Server (GHES), Origin, and Entire connections. For Bitbucket Server, GitLab Self-Managed, and GHES Legacy connections, the endpoint returns 422 Unprocessable Entity . For Entire connections , clone_url is the native entire:// URL and default_branch is an empty string. Select the repository in the Buildkite pipeline editor to associate it with the connection. Supplying its URL through the pipelines REST API does not establish that association.

    GET /v2/organizations/{org.slug}/repository_connections/{repository_connection.id}/repositories

rules

  • Read

    List rules

    Returns a paginated list of an organization's rules. Required scope: read_rules Success response: 200 OK

    GET /v2/organizations/{org.slug}/rules

  • Read

    Get a rule

    Required scope: read_rules Success response: 200 OK

    GET /v2/organizations/{org.slug}/rules/{uuid}

  • Write

    Create a rule

    Required request body properties : Required scope: write_rules Success response: 201 Created Error responses:

    POST /v2/organizations/{org.slug}/rules

  • Destructive

    Delete a rule

    Delete a rule. Required scope: write_rules Success response: 204 No Content Error responses:

    DELETE /v2/organizations/{org.slug}/rules/{uuid}

step-uploads

  • Read

    List a build's step uploads

    Returns a paginated list of step uploads for a build, newest first. The uploaded definitions aren't included. Use Get a step upload to fetch the definition for a specific upload. This endpoint uses cursor-based pagination. The response body is a JSON object with an items array and a links object. Use the next URL from links to fetch the next page, following it verbatim rather than constructing your own cursor values. Optional query string parameters : Required scope: read_builds Success response: 200 OK Error responses:

    GET /v2/organizations/{org.slug}/pipelines/{pipeline.slug}/builds/{build.number}/step-uploads

  • Read

    Get a step upload

    Returns a single step upload, including its uploaded definition rendered as YAML. The uploaded document isn't retained as raw text, so definition_yaml is re-rendered from the stored definition and may not preserve the original file's formatting, comments, or anchors. definition_bytes reports the size of the serialized JSON definition, not the rendered YAML. Definitions whose serialized JSON is larger than 2 MB aren't rendered as YAML. For these, definition_yaml is null and definition_yaml_omitted is true , while definition_bytes still reports the serialized JSON size. Required scope: read_builds Success response: 200 OK Error responses:

    GET /v2/organizations/{org.slug}/pipelines/{pipeline.slug}/builds/{build.number}/step-uploads/{uuid}

teams

  • Read

    List teams

    Returns a paginated list of an organization's teams. Optional query string parameters : Required scope: read_teams Success response: 200 OK

    GET /v2/organizations/{org.slug}/teams

  • Read

    Get a team

    Required scope: read_teams Success response: 200 OK

    GET /v2/organizations/{org.slug}/teams/{team.uuid}

  • Write

    Create a team

    Creates a team. Required request body properties : Required scope: write_teams Success response: 201 Created Error responses:

    POST /v2/organizations/{org.slug}/teams

  • Write

    Update a team

    Updates a team. Required request body properties : Required scope: write_teams Success response: 200 OK Error responses:

    PATCH /v2/organizations/{org.slug}/teams/{team.uuid}

  • Write

    Enable teams

    Enables team-based permissions for the organization. This endpoint performs the same action as the Enable Teams button in the Buildkite web interface. If the organization has no existing teams, enabling teams creates a default "Everyone" team containing all organization members. This endpoint is idempotent. If teams are already enabled, it returns 204 No Content without making further changes. Required scope: write_teams Required permission: Organization administrator Success response: 204 No Content Error responses:

    POST /v2/organizations/{org.slug}/teams/enable

  • Destructive

    Delete a team

    Remove a team. Required scope: write_teams Success response: 204 No Content Error responses:

    DELETE /v2/organizations/{org.slug}/teams/{team.uuid}

teams/members

  • Read

    List team members

    Returns a list of a team's associated members. Required scope: view_teams Success response: 200 OK

    GET /v2/organizations/{org.slug}/teams/{team.uuid}/members

  • Read

    Get a team member

    Required scope: view_teams Success response: 200 OK

    GET /v2/organizations/{org.slug}/teams/{team.uuid}/members/{user.uuid}

  • Write

    Create a team member

    Creates an association between a team and a user. Required request body properties : Required scope: write_teams Success response: 201 Created Error responses:

    POST /v2/organizations/{org.slug}/teams/{team.uuid}/members/

  • Destructive

    Update a team member

    Updates an association between a team and a user. Required request body properties : Required scope: write_teams Success response: 200 OK Error responses:

    PATCH /v2/organizations/{org.slug}/teams/{team.uuid}/members/{user.uuid}

  • Destructive

    Delete a team member

    Remove the association between a team and a user. Required scope: write_teams Success response: 204 No Content Error responses:

    DELETE /v2/organizations/{org.slug}/teams/{team.uuid}/members/{user.uuid}

teams/pipelines

  • Read

    List team pipelines

    Returns a paginated list of a team's associated pipelines. Required scope: view_teams Success response: 200 OK

    GET /v2/organizations/{org.slug}/teams/{team.uuid}/pipelines

  • Read

    Get a team pipeline

    Required scope: view_teams Success response: 200 OK

    GET /v2/organizations/{org.slug}/teams/{team.uuid}/pipelines/{pipeline.uuid}

  • Write

    Create a team pipeline

    Creates an association between a team and a pipeline. Required request body properties : Required scope: write_teams Success response: 201 Created Error responses:

    POST /v2/organizations/{org.slug}/teams/{team.uuid}/pipelines/

  • Destructive

    Update a team pipeline

    Updates an association between a team and a pipeline. Required request body properties : Required scope: write_teams Success response: 200 OK Error responses:

    PATCH /v2/organizations/{org.slug}/teams/{team.uuid}/pipelines/{pipeline.uuid}

  • Destructive

    Delete a team pipeline

    Remove the association between a team and a pipeline. Required scope: write_teams Success response: 204 No Content Error responses:

    DELETE /v2/organizations/{org.slug}/teams/{team.uuid}/pipelines/{pipeline.uuid}

teams/suites

  • Read

    List team suites

    Returns a list of a team's associated suites. Required scope: view_teams Success response: 200 OK

    GET /v2/organizations/{org.slug}/teams/{team.uuid}/suites

  • Read

    Get a team suite

    Required scope: view_teams Success response: 200 OK

    GET /v2/organizations/{org.slug}/teams/{team.uuid}/suites/{suite.uuid}

  • Write

    Create a team suite

    Creates an association between a team and a suite. Required request body properties : Required scope: write_teams Success response: 201 Created Error responses:

    POST /v2/organizations/{org.slug}/teams/{team.uuid}/suites/

  • Destructive

    Update a team suite

    Updates an association between a team and a suite. Required request body properties : Required scope: write_teams Success response: 200 OK Error responses:

    PATCH /v2/organizations/{org.slug}/teams/{team.uuid}/suites/{suite.uuid}

  • Destructive

    Delete a team suite

    Remove the association between a team and a suite. Required scope: write_teams Success response: 204 No Content Error responses:

    DELETE /v2/organizations/{org.slug}/teams/{team.uuid}/suites/{suite.uuid}/

test-engine/build-tests

  • Read

    List tests for a build

    Returns a paginated list of tests that ran in a Buildkite Pipelines build. Each test includes execution metrics aggregated over the build's time window. The response includes tests from every Buildkite Test Engine suite associated with the build that the API token can access. The build identifier must be the build UUID, not the pipeline build number. The aggregation window starts when the build is created, unless the organization's maximum Test Engine time window requires a later start. It ends when the build finishes. For a running build, the window ends at the current time. The window cannot extend beyond 24 hours after the build was created.

    GET /v2/analytics/organizations/{org.slug}/builds/{build.id}/tests

test-engine/execution-tags

  • Destructive

    Update execution tags

    Required scope: write_suites Success response: 200 OK

    PUT /v2/analytics/organizations/{org.slug}/suites/{suite.slug}/execution-tags

test-engine/quarantine

  • Read

    Muted tests

    Required scope: read_suites Success response: 200 OK

    GET /v2/analytics/organizations/{org.slug}/suites/{suite.slug}/tests/muted

  • Write

    Enable test

    Required scope: write_suites Success response: 200 OK

    PUT /v2/analytics/organizations/{org.slug}/suites/{suite.slug}/tests/{test.id}/enable

  • Destructive

    Skip test

    Required scope: write_suites Success response: 200 OK

    PUT /v2/analytics/organizations/{org.slug}/suites/{suite.slug}/tests/{test.id}/skip

  • Destructive

    Mute test

    Required scope: write_suites Success response: 200 OK

    PUT /v2/analytics/organizations/{org.slug}/suites/{suite.slug}/tests/{test.id}/mute

test-engine/runs

  • Read

    List all runs

    Returns a paginated list of runs in a test suite. Optional query string parameters : Required scope: read_suites Success response: 200 OK

    GET /v2/analytics/organizations/{org.slug}/suites/{suite.slug}/runs

  • Read

    Get a run

    executions_count and executions_count_by_result behave the same as in the list all runs response above. Required scope: read_suites Success response: 200 OK Runs are created with a state of running and proceed to finished when all uploads have been processed. The run may return to running if additional results are uploaded. A run's result starts as pending and will proceed to passed or failed when at least one test result has been processed. The presence of a passed or failed result does not indicate that the run has finished processing. result may change from passed to failed if additional results are uploaded. The result is failed when there is at least one failing test in the run, and it is not possible for result to change from failed to any other state. If a run receives no results within a reasonable time period its result will proceed to stale .

    GET /v2/analytics/organizations/{org.slug}/suites/{suite.slug}/runs/{run.id}

  • Read

    Get failed execution data

    Returns a paginated list of failed executions for a run. The tags field contains user-defined metadata associated with the execution, returned as a flat map with dot-notation keys. Tags that duplicate other fields already present in the response ( result , scm.branch , scm.commit_sha ) are excluded. If no user-defined tags exist, this field returns an empty object ( {} ). Required scope: read_suites Success response: 200 OK

    GET /v2/analytics/organizations/{org.slug}/suites/{suite.slug}/runs/{run.id}/failed_executions

test-engine/suites

  • Read

    List all suites

    Returns a paginated list of an organization's suites. Optional query string parameters : Required scope: read_suites Success response: 200 OK

    GET /v2/analytics/organizations/{org.slug}/suites

  • Read

    List suites for a pipeline

    Returns a paginated list of the Buildkite Test Engine suites that have recorded at least one run attributed to a pipeline, ordered by creation time. Each suite is returned once, even if it has recorded several runs for the pipeline. Required scope: read_suites Success response: 200 OK

    GET /v2/analytics/organizations/{org.slug}/pipelines/{pipeline.slug}/suites

  • Read

    Get a suite

    Optional query string parameters : Required scope: read_suites Success response: 200 OK

    GET /v2/analytics/organizations/{org.slug}/suites/{suite.slug}

  • Write

    Create a suite

    Required request body properties : Optional request body properties : Required scope: write_suites Success response: 201 Created

    POST /v2/analytics/organizations/{org.slug}/suites

  • Destructive

    Update a suite

    Optional request body properties : Required scope: write_suites Success response: 200 OK

    PATCH /v2/analytics/organizations/{org.slug}/suites/{suite.slug}

  • Destructive

    Delete a suite

    Required scope: write_suites Success response: 204 No Content

    DELETE /v2/analytics/organizations/{org.slug}/suites/{suite.slug}

test-engine/tests

  • Read

    List tests

    Lists the tests in a suite, along with aggregated duration, reliability, and execution metrics for each test over a time range. The Buildkite-Version request header opts in to the versioned response shown above, which includes the aggregated metrics. Requests made without this header receive a response which contains only the test attributes id through labels . The aggregated metrics in each test are calculated over the time range set by the period , min_timestamp , and max_timestamp query string parameters. Tests without any executions recorded in Test Engine during the requested time range will not be present in the response. To retrieve flaky tests, filter by the flaky label. You can also sort by reliability in ascending order to return the least reliable tests first:

    GET /v2/analytics/organizations/{org.slug}/suites/{suite.slug}/tests

  • Read

    Get a test

    Returns a test with aggregated duration, reliability, and execution metrics over a time range, along with its flakiness scores ( transition_count_score and probabilistic_flakiness_score ).

    GET /v2/analytics/organizations/{org.slug}/suites/{suite.slug}/tests/{test.id}

  • Read

    Find a test with scope and name

    In some situations, you may not have access to UUID to make a call to Test Engine API. You can locate a test record using its scope and name to retrieve the UUID from the response. Required scope: read_suites Success response: 200 OK

    POST /v2/analytics/organizations/{org.slug}/suites/{suite.slug}/tests/find

  • Destructive

    Add or remove labels from a test

    Required request body properties : Required scope: write_suites Success response: 200 OK

    PATCH /v2/analytics/organizations/{org.slug}/suites/{suite.slug}/tests/{test.id}/labels

test-engine/workflows

  • Read

    List workflows

    Returns a paginated list of a suite's workflows, newest first. Each item has the workflow data model fields. Required scope: read_suites Success response: 200 OK

    GET /v2/analytics/organizations/{org.slug}/suites/{suite.slug}/workflows

  • Read

    Get a workflow

    Returns a single workflow with the workflow data model fields. Required scope: read_suites Success response: 200 OK

    GET /v2/analytics/organizations/{org.slug}/suites/{suite.slug}/workflows/{workflow.id}

  • Destructive

    Create a workflow

    This example creates a transition count workflow that adds the flaky label when a test alarms and removes it when the test recovers: Required request body properties : Optional request body properties: Required scope: write_suites Success response: 201 Created

    POST /v2/analytics/organizations/{org.slug}/suites/{suite.slug}/workflows

  • Destructive

    Update a workflow

    Updates the supplied fields and returns the updated workflow. All request body properties are optional. Omitted properties keep their current values, including individual fields within monitor . The monitor's type cannot be changed. This example changes only the alarm threshold and removes all recovery actions. The remaining monitor settings, filters, and alarm actions stay unchanged. Each supplied filters , alarm_actions , or recover_actions array replaces that entire list. Send [] to clear a list. Include every entry you want to retain when replacing a list. Use the same monitor , filter , and action fields as for creation. Only fields belonging to the workflow's current monitor type are accepted. Required scope: write_suites Success response: 200 OK

    PATCH /v2/analytics/organizations/{org.slug}/suites/{suite.slug}/workflows/{workflow.id}

  • Destructive

    Delete a workflow

    Deletes the workflow. A subsequent request for the deleted workflow returns 404 Not Found . Required scope: write_suites Success response: 204 No Content

    DELETE /v2/analytics/organizations/{org.slug}/suites/{suite.slug}/workflows/{workflow.id}

user

  • Read

    Get the current user

    Returns basic details about the user account that sent the request. Required scope: read_user Success response: 200 OK

    GET /v2/user

Test Engine OpenAPI additions

  • Read

    List skipped tests

    Requires the suite to have state management enabled.

    GET /v2/analytics/organizations/{org}/suites/{suite_slug}/tests/skipped

  • Read

    Get the trace for an execution

    Returns the OpenTelemetry trace recorded for a single test execution: where the execution's time went, rolled up by category and ranked by the spans that spent it. Both the ranking and the category rollup use *self* time - a span's own duration less the time its children accounted for - so an outer span is never credited with work it merely waited on. The default `summary` view omits the span list, which lets a caller ask about many executions before committing to a full payload; `view=full` adds `spans`, the trace's leading window in start time order. Spans are retained for a shorter window than executions, and an execution recorded before the organization exported traces never had one, so an execution with no trace returns an empty trace rather than a 404. A 404 means the execution itself is unknown to the suite, or the organization is not enrolled in OpenTelemetry trace ingest.

    GET /v2/analytics/organizations/{org}/suites/{suite_slug}/executions/{execution_id}/trace

  • Read

    Get an upload

    Get an upload

    GET /v2/analytics/organizations/{org}/suites/{suite_slug}/uploads/{id}

  • Read

    List span aggregate scopes for a suite

    Returns instrumentation scope names, counts, and total durations across all builds in the requested period, ordered by total duration descending, then name ascending. Requires OTel trace ingestion to be in use. Aggregates have hourly precision, data is retained for one month. Returns all scopes without pagination. To inspect an individual scope's statistics, use the `span-aggregates/span-names` endpoint. Example: `GET /v2/analytics/organizations/acme/suites/rspec/span-aggregates/scopes?period=7days`

    GET /v2/analytics/organizations/{org}/suites/{suite_slug}/span-aggregates/scopes

  • Read

    Get span-name statistics for a suite's instrumentation scope

    Returns span-name statistics for the requested instrumentation scope. Use `span-aggregates/scopes` to discover scope names. Top-N spans are returned - default 20, max 100. `span_names_truncated` indicates that more names exist. Example: `GET /v2/analytics/organizations/acme/suites/rspec/span-aggregates/span-names?period=7days&scope_name=pg&sort=-p95&limit=10`

    GET /v2/analytics/organizations/{org}/suites/{suite_slug}/span-aggregates/span-names

  • Read

    List span aggregate scopes for a build

    Returns the instrumentation scope names, counts, and total durations across for a build, ordered by total duration descending, then name ascending. The caller must have access to the build's pipeline, and only test results for suites accessible to the caller are returned. Returns all scopes without pagination. To inspect a scope's span-name statistics, use `span-aggregates/span-names`. Example: `GET /v2/analytics/organizations/acme/builds/019ee6f7-5678-7000-8000-000000000001/span-aggregates/scopes`

    GET /v2/analytics/organizations/{org}/builds/{build_id}/span-aggregates/scopes

  • Read

    Get span-name statistics for a build's instrumentation scope

    Returns statistics for the requested instrumentation scopes for a build. Use `span-aggregates/scopes` to discover scope names. The caller must have access to the build's pipeline, and only test results for suites accessible to the caller are returned. Top-N spans are returned - default 20, max 100. `span_names_truncated` indicates that more names exist. Example: `GET /v2/analytics/organizations/acme/builds/019ee6f7-5678-7000-8000-000000000001/span-aggregates/span-names?scope_name=pg&sort=-total&limit=20`

    GET /v2/analytics/organizations/{org}/builds/{build_id}/span-aggregates/span-names

  • Read

    List the slowest executions for a build

    Returns the slowest individual test executions recorded for a build, across each suite that received execution data from the build, slowest first. This is a top-N list rather than a paginated collection: use `limit` to control its size.

    GET /v2/analytics/organizations/{org}/builds/{build_id}/executions/slowest

  • Destructive

    Update a suite (PUT alias)

    Update a suite (PUT alias)

    PUT /v2/analytics/organizations/{org}/suites/{slug}

See How connections work for access and permissions, or browse all integrations.