Sign in

v1

latestOpenAPI 3.0.3MIT2026-07-1411163326.7 KB
Organization

Create a new URL Orb allow-list entry

Create a new URL Orb allow-list entry

post/organization/{org-slug-or-id}/url-orb-allow-list

Path parameters

org-slug-or-idstring required

Org UUID or slug in the form vcs-slug/org-name. For projects that use GitLab or GitHub App, use circleci as the vcs-slug and replace the org-name with the organization ID (found in Organization Settings).

Request body

namestring required

Name of the URL orb allow-list entry.

prefixstring required

URL prefix. URL orb references that start with this prefix will be allowed by this allow-list entry.

auth'github-oauth' | 'none' | 'bitbucket-oauth' | 'github-app' required

An authentication method to use for fetching URL orb references that match this allow-list entry's prefix. Allowed values are "bitbucket-oauth", "github-oauth", "github-app", or "none".

Example request

{
  "name": "Allow URL orbs from raw.githubusercontent.com/CircleCI-Public",
  "prefix": "https://raw.githubusercontent.com/CircleCI-Public/orbs/refs/heads/main/",
  "auth": "github-app"
}

Response

The ID of the new URL Orb allow-list entry

idstring required

URL orb allow-list entry UUID.

messagestring required

Message describing the outcome of an operation

Example response

{
  "id": "ba98990a-5a00-4cad-b55e-b44117b92e0c",
  "message": "Created."
}