{ "components": { "schemas": { "adhoc-modules-response": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "modules": { "type": "array", "items": { "type": "string" } } } }, "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } }, "agent-pools-collection": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "agent-count": { "type": "integer" }, "created-at": { "type": "string", "format": "date-time" }, "name": { "type": "string" }, "organization-scoped": { "type": "boolean" } } }, "id": { "type": "string", "format": "uuid" }, "links": { "type": "object", "properties": { "self": { "type": "string" } } }, "relationships": { "type": "object", "properties": { "organization": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } } } } } } }, "type": { "type": "string" } } } }, "meta": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "current-page": { "type": "integer" }, "next-page": { "nullable": true }, "page-size": { "type": "integer" }, "prev-page": { "nullable": true }, "total-count": { "type": "integer" }, "total-pages": { "type": "integer" } } } } } } }, "agent-pools-response": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "agent-count": { "type": "integer" }, "created-at": { "type": "string", "format": "date-time" }, "name": { "type": "string" }, "organization-scoped": { "type": "boolean" } } }, "id": { "type": "string", "format": "uuid" }, "links": { "type": "object", "properties": { "self": { "type": "string" } } }, "relationships": { "type": "object", "properties": { "allowed-projects": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } } }, "allowed-workspaces": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } } } } } }, "organization": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } } } } } } }, "type": { "type": "string" } } } } }, "agents-collection": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "ip-address": { "type": "string" }, "last-ping-at": { "type": "string", "format": "date-time" }, "name": { "type": "string" }, "status": { "type": "string" } } }, "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } }, "meta": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "current-page": { "type": "integer" }, "next-page": { "nullable": true }, "page-size": { "type": "integer" }, "prev-page": { "nullable": true }, "total-count": { "type": "integer" }, "total-pages": { "type": "integer" } } } } } } }, "analytics-executions-response": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "count": { "type": "integer" }, "executions": { "type": "array", "items": { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time" }, "detail": { "type": "string" }, "duration_seconds": { "type": "integer" }, "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "outcome": { "type": "string" }, "platform": { "type": "string" }, "status": { "type": "string" }, "workspace_name": { "type": "string" } } } }, "truncated": { "type": "boolean" }, "window": { "type": "object", "properties": { "since": { "type": "string", "format": "date-time" }, "until": { "type": "string", "format": "date-time" } } } } }, "id": { "type": "string" }, "type": { "type": "string" } } } } }, "analytics-response": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "activity": { "type": "object", "properties": { "by_action": { "type": "array", "items": { "type": "object", "properties": { "count": { "type": "integer" }, "label": { "type": "string" } } } }, "by_resource_type": { "type": "array", "items": { "type": "object", "properties": { "count": { "type": "integer" }, "label": { "type": "string" } } } }, "total": { "type": "integer" } } }, "ansible_jobs": { "type": "object", "properties": { "avg_duration_seconds": { "type": "integer" }, "canceled": { "type": "integer" }, "duration_samples": { "type": "integer" }, "failed": { "type": "integer" }, "p95_duration_seconds": { "type": "number" }, "pending": { "type": "integer" }, "previous": { "type": "object", "properties": { "avg_duration_seconds": { "type": "integer" }, "failed": { "type": "integer" }, "succeeded": { "type": "integer" }, "success_rate": { "nullable": true }, "total": { "type": "integer" } } }, "running": { "type": "integer" }, "succeeded": { "type": "integer" }, "success_rate": { "type": "number" }, "total": { "type": "integer" } } }, "daily": { "type": "array", "items": { "type": "object", "properties": { "activity": { "type": "integer" }, "date": { "type": "string" }, "jobs_failed": { "type": "integer" }, "jobs_other": { "type": "integer" }, "jobs_succeeded": { "type": "integer" }, "runs_failed": { "type": "integer" }, "runs_other": { "type": "integer" }, "runs_succeeded": { "type": "integer" } } } }, "recent_failures": { "type": "array", "items": { "type": "object", "properties": { "detail": { "type": "string" }, "error_message": { "type": "string" }, "failed_at": { "type": "string", "format": "date-time" }, "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "platform": { "type": "string" }, "workspace_name": { "type": "string" } } } }, "resources": { "type": "object", "properties": { "inventories": { "type": "integer" }, "job_templates": { "type": "integer" }, "playbooks": { "type": "integer" }, "projects": { "type": "integer" }, "workspaces": { "type": "integer" } } }, "running_now": { "type": "object", "properties": { "jobs": { "type": "integer" }, "runs": { "type": "integer" }, "total": { "type": "integer" } } }, "runs": { "type": "object", "properties": { "avg_duration_seconds": { "type": "number" }, "canceled": { "type": "integer" }, "duration_samples": { "type": "integer" }, "failed": { "type": "integer" }, "p95_duration_seconds": { "type": "integer" }, "pending": { "type": "integer" }, "previous": { "type": "object", "properties": { "avg_duration_seconds": { "type": "integer" }, "failed": { "type": "integer" }, "succeeded": { "type": "integer" }, "success_rate": { "nullable": true }, "total": { "type": "integer" } } }, "running": { "type": "integer" }, "succeeded": { "type": "integer" }, "success_rate": { "type": "number" }, "total": { "type": "integer" } } }, "top_templates": { "type": "array", "items": { "type": "object", "properties": { "avg_duration_seconds": { "type": "object", "additionalProperties": true }, "failed": { "type": "integer" }, "job_count": { "type": "integer" }, "succeeded": { "type": "integer" }, "success_rate": { "type": "integer" }, "template_id": { "type": "string", "format": "uuid" }, "template_name": { "type": "string" } } } }, "top_workspaces": { "type": "array", "items": { "type": "object", "properties": { "avg_duration_seconds": { "type": "object", "additionalProperties": true }, "failed": { "type": "integer" }, "project_name": { "type": "string" }, "run_count": { "type": "integer" }, "succeeded": { "type": "integer" }, "success_rate": { "type": "object", "additionalProperties": true }, "workspace_id": { "type": "string" }, "workspace_name": { "type": "string" } } } }, "window": { "type": "object", "properties": { "days": { "type": "integer" }, "since": { "type": "string", "format": "date-time" }, "until": { "type": "string", "format": "date-time" } } } } }, "id": { "type": "string" }, "type": { "type": "string" } } } } }, "ansible-collections-collection": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "description": { "type": "string" }, "name": { "type": "string" }, "namespace": { "type": "string" }, "source": { "type": "string" }, "version": { "type": "string" } } }, "id": { "type": "string" }, "type": { "type": "string" } } } }, "meta": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "current-page": { "type": "integer" }, "next-page": { "nullable": true }, "page-size": { "type": "integer" }, "prev-page": { "nullable": true }, "total-count": { "type": "integer" }, "total-pages": { "type": "integer" } } } } } } }, "ansible-configs-response": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "config-content": { "type": "string" }, "created-at": { "type": "string", "format": "date-time" }, "scope": { "type": "string" }, "updated-at": { "type": "string", "format": "date-time" } } }, "id": { "type": "string", "format": "uuid" }, "relationships": { "type": "object", "properties": { "organization": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } }, "project": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } } } }, "type": { "type": "string" } } } } }, "ansible-credentials-collection": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "azure-client-id": { "type": "string" }, "azure-tenant-id": { "type": "string" }, "created-at": { "type": "string", "format": "date-time" }, "credential-type": { "type": "string" }, "description": { "type": "string" }, "has-become-password": { "type": "boolean" }, "has-password": { "type": "boolean" }, "has-ssh-private-key": { "type": "boolean" }, "has-vault-password": { "type": "boolean" }, "name": { "type": "string" }, "ssh-become-user": { "type": "string" }, "ssh-port": { "type": "integer" }, "updated-at": { "type": "string", "format": "date-time" }, "username": { "type": "string" } } }, "id": { "type": "string", "format": "uuid" }, "relationships": { "type": "object", "properties": { "organization": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } } } }, "type": { "type": "string" } } } }, "meta": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "current-page": { "type": "integer" }, "next-page": { "nullable": true }, "page-size": { "type": "integer" }, "prev-page": { "nullable": true }, "total-count": { "type": "integer" }, "total-pages": { "type": "integer" } } } } } } }, "ansible-credentials-response": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "azure-client-id": { "type": "string" }, "azure-tenant-id": { "type": "string" }, "created-at": { "type": "string", "format": "date-time" }, "credential-type": { "type": "string" }, "description": { "type": "string" }, "has-become-password": { "type": "boolean" }, "has-password": { "type": "boolean" }, "has-ssh-private-key": { "type": "boolean" }, "has-vault-password": { "type": "boolean" }, "name": { "type": "string" }, "ssh-become-user": { "type": "string" }, "ssh-port": { "type": "integer" }, "updated-at": { "type": "string", "format": "date-time" }, "username": { "type": "string" }, "vault-id": { "type": "string" } } }, "id": { "type": "string", "format": "uuid" }, "relationships": { "type": "object", "properties": { "organization": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } } } }, "type": { "type": "string" } } } } }, "ansible-groups-collection": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "created-at": { "type": "string", "format": "date-time" }, "description": { "type": "string" }, "name": { "type": "string" }, "updated-at": { "type": "string", "format": "date-time" }, "variables": { "type": "object", "additionalProperties": true } } }, "id": { "type": "string", "format": "uuid" }, "relationships": { "type": "object", "properties": { "children": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": true } } } }, "hosts": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": true } } } }, "inventory": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } } } }, "type": { "type": "string" } } } }, "meta": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "current-page": { "type": "integer" }, "next-page": { "nullable": true }, "page-size": { "type": "integer" }, "prev-page": { "nullable": true }, "total-count": { "type": "integer" }, "total-pages": { "type": "integer" } } } } } } }, "ansible-groups-response": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "created-at": { "type": "string", "format": "date-time" }, "description": { "type": "string" }, "name": { "type": "string" }, "updated-at": { "type": "string", "format": "date-time" }, "variables": { "type": "object", "properties": { "http_port": { "type": "integer" }, "max_clients": { "type": "integer" }, "region": { "type": "string" } } } } }, "id": { "type": "string", "format": "uuid" }, "relationships": { "type": "object", "properties": { "children": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": true } } } }, "hosts": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": true } } } }, "inventory": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } }, "parent": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } } } }, "type": { "type": "string" } } } } }, "ansible-hosts-collection": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "created-at": { "type": "string", "format": "date-time" }, "description": { "type": "string" }, "enabled": { "type": "boolean" }, "hostname": { "type": "string" }, "name": { "type": "string" }, "port": { "type": "integer" }, "updated-at": { "type": "string", "format": "date-time" }, "variables": { "type": "object", "additionalProperties": true } } }, "id": { "type": "string", "format": "uuid" }, "relationships": { "type": "object", "properties": { "groups": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": true } } } }, "inventory": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } } } }, "type": { "type": "string" } } } }, "meta": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "current-page": { "type": "integer" }, "next-page": { "nullable": true }, "page-size": { "type": "integer" }, "prev-page": { "nullable": true }, "total-count": { "type": "integer" }, "total-pages": { "type": "integer" } } } } } } }, "ansible-hosts-response": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "created-at": { "type": "string", "format": "date-time" }, "description": { "type": "string" }, "enabled": { "type": "boolean" }, "hostname": { "type": "string" }, "name": { "type": "string" }, "port": { "type": "integer" }, "updated-at": { "type": "string", "format": "date-time" }, "variables": { "type": "object", "properties": { "ansible_user": { "type": "string" }, "http_port": { "type": "integer" } } } } }, "id": { "type": "string", "format": "uuid" }, "relationships": { "type": "object", "properties": { "groups": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": true } } } }, "inventory": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } } } }, "type": { "type": "string" } } } } }, "ansible-inventories-collection": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "constructed-cache-timeout": { "type": "integer" }, "constructed-limit": { "type": "string" }, "created-at": { "type": "string", "format": "date-time" }, "description": { "type": "string" }, "inventory-type": { "type": "string" }, "last-sync-at": { "nullable": true }, "last-sync-error": { "type": "string" }, "last-sync-hosts-discovered": { "type": "integer" }, "last-sync-log": { "type": "string" }, "last-sync-status": { "type": "string" }, "name": { "type": "string" }, "source": { "type": "string" }, "source-vars": { "type": "string" }, "updated-at": { "type": "string", "format": "date-time" }, "variables": { "type": "object", "additionalProperties": true }, "vcs_branch": { "type": "string" } } }, "id": { "type": "string", "format": "uuid" }, "relationships": { "type": "object", "properties": { "organization": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } } } }, "type": { "type": "string" } } } }, "meta": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "current-page": { "type": "integer" }, "next-page": { "nullable": true }, "page-size": { "type": "integer" }, "prev-page": { "nullable": true }, "total-count": { "type": "integer" }, "total-pages": { "type": "integer" } } } } } } }, "ansible-inventories-response": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "constructed-cache-timeout": { "type": "integer" }, "constructed-limit": { "type": "string" }, "created-at": { "type": "string", "format": "date-time" }, "description": { "type": "string" }, "inventory-type": { "type": "string" }, "last-sync-at": { "nullable": true }, "last-sync-error": { "type": "string" }, "last-sync-hosts-discovered": { "type": "integer" }, "last-sync-log": { "type": "string" }, "last-sync-status": { "type": "string" }, "name": { "type": "string" }, "source": { "type": "string" }, "source-vars": { "type": "string" }, "updated-at": { "type": "string", "format": "date-time" }, "variables": { "type": "object", "properties": { "ansible_port": { "type": "integer" }, "ansible_user": { "type": "string" }, "ntp_server": { "type": "string" } } }, "vcs_branch": { "type": "string" } } }, "id": { "type": "string", "format": "uuid" }, "relationships": { "type": "object", "properties": { "organization": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } } } }, "type": { "type": "string" } } } } }, "ansible-job-templates-collection": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "allow-callbacks": { "type": "boolean" }, "allow-simultaneous": { "type": "boolean" }, "become-enabled": { "type": "boolean" }, "created-at": { "type": "string", "format": "date-time" }, "description": { "type": "string" }, "diff-mode": { "type": "boolean" }, "enabled": { "type": "boolean" }, "extra-vars": { "type": "object", "additionalProperties": true }, "forks": { "type": "integer" }, "host-config-key": { "type": "string" }, "job-slice-count": { "type": "integer" }, "launch-on-webhook": { "type": "boolean" }, "limit": { "type": "string" }, "name": { "type": "string" }, "retention-days": { "nullable": true }, "schedule-cron": { "type": "string" }, "schedule-enabled": { "type": "boolean" }, "skip-tags": { "type": "string" }, "tags": { "type": "string" }, "timeout-seconds": { "type": "integer" }, "updated-at": { "type": "string", "format": "date-time" }, "verbosity": { "type": "integer" } } }, "id": { "type": "string", "format": "uuid" }, "relationships": { "type": "object", "properties": { "inventory": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } }, "playbook": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } }, "project": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } } } }, "type": { "type": "string" } } } }, "meta": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "current-page": { "type": "integer" }, "next-page": { "nullable": true }, "page-size": { "type": "integer" }, "prev-page": { "nullable": true }, "total-count": { "type": "integer" }, "total-pages": { "type": "integer" } } } } } } }, "ansible-job-templates-response": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "allow-callbacks": { "type": "boolean" }, "allow-simultaneous": { "type": "boolean" }, "become-enabled": { "type": "boolean" }, "created-at": { "type": "string", "format": "date-time" }, "description": { "type": "string" }, "diff-mode": { "type": "boolean" }, "enabled": { "type": "boolean" }, "extra-vars": { "type": "object", "properties": { "app_version": { "type": "string" }, "compliance_profile": { "type": "string" }, "rolling_update": { "type": "boolean" } } }, "forks": { "type": "integer" }, "host-config-key": { "type": "string" }, "job-slice-count": { "type": "integer" }, "launch-on-webhook": { "type": "boolean" }, "limit": { "type": "string" }, "name": { "type": "string" }, "retention-days": { "type": "integer", "nullable": true }, "schedule-cron": { "type": "string" }, "schedule-enabled": { "type": "boolean" }, "skip-tags": { "type": "string" }, "tags": { "type": "string" }, "timeout-seconds": { "type": "integer" }, "updated-at": { "type": "string", "format": "date-time" }, "verbosity": { "type": "integer" } } }, "id": { "type": "string", "format": "uuid" }, "relationships": { "type": "object", "properties": { "credentials": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } } }, "inventory": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } }, "playbook": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } }, "project": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } } } }, "type": { "type": "string" } } } } }, "ansible-jobs-collection": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "ansible-version": { "type": "string" }, "become-enabled": { "type": "boolean" }, "created-at": { "type": "string", "format": "date-time" }, "diff-mode": { "type": "boolean" }, "error-message": { "type": "string" }, "exit-code": { "nullable": true }, "extra-vars": { "type": "object", "additionalProperties": true }, "finished-at": { "nullable": true }, "forks": { "type": "string" }, "has-warnings": { "type": "boolean" }, "hosts-changed": { "type": "string" }, "hosts-failed": { "type": "string" }, "hosts-ignored": { "type": "string" }, "hosts-ok": { "type": "string" }, "hosts-rescued": { "type": "string" }, "hosts-skipped": { "type": "string" }, "hosts-total": { "type": "string" }, "hosts-unreachable": { "type": "string" }, "inventory-sync-warnings": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "job-type": { "type": "string" }, "limit": { "type": "string" }, "name": { "type": "string" }, "playbook-name": { "type": "string" }, "runner-id": { "nullable": true }, "skip-tags": { "type": "string" }, "slice-count": { "type": "string" }, "slice-group-id": { "nullable": true }, "slice-number": { "type": "string" }, "started-at": { "type": "string", "format": "date-time" }, "status": { "type": "string" }, "tags": { "type": "string" }, "updated-at": { "type": "string", "format": "date-time" }, "verbosity": { "type": "string" }, "warnings-count": { "type": "string" } } }, "id": { "type": "string", "format": "uuid" }, "relationships": { "type": "object", "properties": { "inventory": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } }, "playbook": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } }, "project": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } }, "template": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } } } }, "type": { "type": "string" } } } }, "meta": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "current-page": { "type": "string" }, "next-page": { "nullable": true }, "page-size": { "type": "string" }, "prev-page": { "nullable": true }, "total-count": { "type": "string" }, "total-pages": { "type": "string" } } } } } } }, "ansible-jobs-response": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "ansible-version": { "type": "string" }, "become-enabled": { "type": "boolean" }, "created-at": { "type": "string", "format": "date-time" }, "diff-mode": { "type": "boolean" }, "error-message": { "type": "string" }, "exit-code": { "nullable": true }, "extra-vars": { "type": "object", "additionalProperties": true }, "finished-at": { "type": "string", "format": "date-time" }, "forks": { "type": "string" }, "has-warnings": { "type": "boolean" }, "hosts-changed": { "type": "string" }, "hosts-failed": { "type": "string" }, "hosts-ignored": { "type": "string" }, "hosts-ok": { "type": "string" }, "hosts-rescued": { "type": "string" }, "hosts-skipped": { "type": "string" }, "hosts-total": { "type": "string" }, "hosts-unreachable": { "type": "string" }, "inventory-sync-warnings": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "job-type": { "type": "string" }, "limit": { "type": "string" }, "name": { "type": "string" }, "playbook-name": { "type": "string" }, "runner-id": { "nullable": true }, "skip-tags": { "type": "string" }, "slice-count": { "type": "string" }, "slice-group-id": { "nullable": true }, "slice-number": { "type": "string" }, "started-at": { "type": "string", "format": "date-time" }, "status": { "type": "string" }, "tags": { "type": "string" }, "updated-at": { "type": "string", "format": "date-time" }, "verbosity": { "type": "string" }, "warnings-count": { "type": "string" } } }, "id": { "type": "string", "format": "uuid" }, "relationships": { "type": "object", "properties": { "inventory": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } }, "playbook": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } }, "project": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } }, "template": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } } } }, "type": { "type": "string" } } } } }, "ansible-notification-attachments-response": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "notification-template-name": { "type": "string" }, "on-failure": { "type": "boolean" }, "on-started": { "type": "boolean" }, "on-success": { "type": "boolean" } } }, "id": { "type": "string", "format": "uuid" }, "relationships": { "type": "object", "properties": { "job-template": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } }, "notification-template": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } } } }, "type": { "type": "string" } } } } }, "ansible-notification-templates-response": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "config": { "type": "object", "properties": { "headers": { "type": "object", "properties": { "X-Source": { "type": "string" } } }, "method": { "type": "string" }, "skip_tls_verify": { "type": "boolean" }, "url": { "type": "string" }, "username": { "type": "string" } } }, "created-at": { "type": "string", "format": "date-time" }, "description": { "type": "string" }, "has-secret": { "type": "boolean" }, "name": { "type": "string" }, "notification-type": { "type": "string" } } }, "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } }, "ansible-playbooks-collection": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "cached-at": { "nullable": true }, "cached-commit": { "type": "string" }, "cached-size-bytes": { "type": "integer" }, "created-at": { "type": "string", "format": "date-time" }, "description": { "type": "string" }, "last-sync-at": { "nullable": true }, "last-sync-commit": { "type": "string" }, "last-sync-error": { "type": "string" }, "last-sync-status": { "type": "string" }, "name": { "type": "string" }, "playbook-path": { "type": "string" }, "source-mode": { "type": "string" }, "updated-at": { "type": "string", "format": "date-time" }, "vcs-account-name": { "type": "string" }, "vcs-branch": { "type": "string" }, "vcs-provider": { "type": "string" }, "vcs-repository": { "type": "string" } } }, "id": { "type": "string", "format": "uuid" }, "relationships": { "type": "object", "properties": { "project": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } }, "vcs-connection": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } } } }, "type": { "type": "string" } } } }, "meta": { "type": "object", "properties": { "created": { "type": "integer" }, "failed": { "type": "integer" }, "failed-rows": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "pagination": { "type": "object", "properties": { "current-page": { "type": "integer" }, "next-page": { "nullable": true }, "page-size": { "type": "integer" }, "prev-page": { "nullable": true }, "total-count": { "type": "integer" }, "total-pages": { "type": "integer" } } }, "skipped": { "type": "integer" } } } } }, "ansible-playbooks-response": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "cached-at": { "nullable": true }, "cached-commit": { "type": "string" }, "cached-size-bytes": { "type": "integer" }, "created-at": { "type": "string", "format": "date-time" }, "description": { "type": "string" }, "last-sync-at": { "nullable": true }, "last-sync-commit": { "type": "string" }, "last-sync-error": { "type": "string" }, "last-sync-status": { "type": "string" }, "name": { "type": "string" }, "playbook-path": { "type": "string" }, "source-mode": { "type": "string" }, "updated-at": { "type": "string", "format": "date-time" }, "vcs-account-name": { "type": "string" }, "vcs-branch": { "type": "string" }, "vcs-provider": { "type": "string" }, "vcs-repository": { "type": "string" } } }, "id": { "type": "string", "format": "uuid" }, "relationships": { "type": "object", "properties": { "project": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } }, "vcs-connection": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } } } }, "type": { "type": "string" } } }, "meta": { "type": "object", "properties": { "created": { "type": "boolean" } } } } }, "ansible-workflow-edges-response": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "condition": { "type": "string" }, "created-at": { "type": "string", "format": "date-time" } } }, "id": { "type": "string", "format": "uuid" }, "relationships": { "type": "object", "properties": { "source-node": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } }, "target-node": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } }, "workflow": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } } } }, "type": { "type": "string" } } } } }, "ansible-workflow-jobs-collection": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "created-at": { "type": "string", "format": "date-time" }, "finished-at": { "type": "string", "format": "date-time" }, "name": { "type": "string" }, "started-at": { "type": "string", "format": "date-time" }, "status": { "type": "string" } } }, "id": { "type": "string", "format": "uuid" }, "relationships": { "type": "object", "properties": { "workflow": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } } } }, "type": { "type": "string" } } } }, "meta": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "current-page": { "type": "integer" }, "next-page": { "nullable": true }, "page-size": { "type": "integer" }, "prev-page": { "nullable": true }, "total-count": { "type": "integer" }, "total-pages": { "type": "integer" } } } } } } }, "ansible-workflow-jobs-response": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "created-at": { "type": "string", "format": "date-time" }, "finished-at": { "type": "string", "format": "date-time", "nullable": true }, "name": { "type": "string" }, "started-at": { "type": "string", "format": "date-time" }, "status": { "type": "string" } } }, "id": { "type": "string", "format": "uuid" }, "relationships": { "type": "object", "properties": { "workflow": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } } } }, "type": { "type": "string" } } }, "included": { "type": "array", "items": { "type": "object", "additionalProperties": true } } } }, "ansible-workflow-nodes-collection": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "all-parents-must-converge": { "type": "boolean" }, "approval-message": { "type": "string" }, "approval-timeout": { "type": "integer" }, "created-at": { "type": "string", "format": "date-time" }, "extra-vars": { "type": "string" }, "identifier": { "type": "string" }, "job-template-name": { "type": "string" }, "limit": { "type": "string" }, "node-type": { "type": "string" }, "position-x": { "type": "integer" }, "position-y": { "type": "integer" }, "skip-tags": { "type": "string" }, "tags": { "type": "string" }, "verbosity": { "type": "integer" } } }, "id": { "type": "string", "format": "uuid" }, "relationships": { "type": "object", "properties": { "job-template": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } }, "workflow": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } } } }, "type": { "type": "string" } } } }, "meta": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "current-page": { "type": "integer" }, "next-page": { "nullable": true }, "page-size": { "type": "integer" }, "prev-page": { "nullable": true }, "total-count": { "type": "integer" }, "total-pages": { "type": "integer" } } } } } } }, "ansible-workflow-nodes-response": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "all-parents-must-converge": { "type": "boolean" }, "approval-message": { "type": "string" }, "approval-timeout": { "type": "integer" }, "created-at": { "type": "string", "format": "date-time" }, "extra-vars": { "type": "string" }, "identifier": { "type": "string" }, "job-template-name": { "type": "string" }, "limit": { "type": "string" }, "node-type": { "type": "string" }, "position-x": { "type": "integer" }, "position-y": { "type": "integer" }, "skip-tags": { "type": "string" }, "tags": { "type": "string" }, "verbosity": { "type": "integer" } } }, "id": { "type": "string", "format": "uuid" }, "relationships": { "type": "object", "properties": { "inventory": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } }, "job-template": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } }, "workflow": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } } } }, "type": { "type": "string" } } } } }, "ansible-workflows-collection": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "allow-simultaneous": { "type": "boolean" }, "ask-inventory-on-launch": { "type": "boolean" }, "ask-limit-on-launch": { "type": "boolean" }, "ask-variables-on-launch": { "type": "boolean" }, "created-at": { "type": "string", "format": "date-time" }, "description": { "type": "string" }, "extra-vars": { "type": "string" }, "limit": { "type": "string" }, "name": { "type": "string" }, "survey-enabled": { "type": "boolean" }, "updated-at": { "type": "string", "format": "date-time" } } }, "id": { "type": "string", "format": "uuid" }, "relationships": { "type": "object", "properties": { "organization": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } }, "project": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } } } }, "type": { "type": "string" } } } }, "meta": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "current-page": { "type": "integer" }, "next-page": { "nullable": true }, "page-size": { "type": "integer" }, "prev-page": { "nullable": true }, "total-count": { "type": "integer" }, "total-pages": { "type": "integer" } } } } } } }, "ansible-workflows-response": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "allow-simultaneous": { "type": "boolean" }, "ask-inventory-on-launch": { "type": "boolean" }, "ask-limit-on-launch": { "type": "boolean" }, "ask-variables-on-launch": { "type": "boolean" }, "created-at": { "type": "string", "format": "date-time" }, "description": { "type": "string" }, "extra-vars": { "type": "string" }, "limit": { "type": "string" }, "name": { "type": "string" }, "survey-enabled": { "type": "boolean" }, "updated-at": { "type": "string", "format": "date-time" } } }, "id": { "type": "string", "format": "uuid" }, "relationships": { "type": "object", "properties": { "edges": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": true } } } }, "inventory": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } }, "nodes": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "all-parents-must-converge": { "type": "boolean" }, "approval-message": { "type": "string" }, "approval-timeout": { "type": "integer" }, "created-at": { "type": "string", "format": "date-time" }, "extra-vars": { "type": "string" }, "identifier": { "type": "string" }, "job-template-name": { "type": "string" }, "limit": { "type": "string" }, "node-type": { "type": "string" }, "position-x": { "type": "integer" }, "position-y": { "type": "integer" }, "skip-tags": { "type": "string" }, "tags": { "type": "string" }, "verbosity": { "type": "integer" } } }, "id": { "type": "string", "format": "uuid" }, "relationships": { "type": "object", "properties": { "job-template": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } }, "workflow": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } } } }, "type": { "type": "string" } } } } } }, "organization": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } }, "project": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } } } }, "type": { "type": "string" } } } } }, "api-keys-response": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "created-at": { "type": "string", "format": "date-time" }, "expires-at": { "type": "string", "format": "date-time" }, "key": { "type": "string" }, "key-prefix": { "type": "string" }, "last-used-at": { "nullable": true }, "name": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string" } } } }, "id": { "type": "string", "format": "uuid" }, "relationships": { "type": "object", "properties": { "organization": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } } } }, "type": { "type": "string" } } } } }, "authentication-tokens-response": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "created-at": { "type": "string", "format": "date-time" }, "description": { "type": "string", "nullable": true }, "expired-at": { "type": "string", "format": "date-time" }, "last-used-at": { "nullable": true }, "token": { "type": "string" } } }, "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } }, "meta": { "type": "object", "properties": { "rotated-from": { "type": "string", "format": "uuid" }, "rotated-from-expired-at": { "type": "string", "format": "date-time" } } } } }, "bulk_actions-response": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "action_inputs": { "type": "object", "properties": { "message": { "type": "string" }, "subject": { "type": "string" } } }, "action_type": { "type": "string" }, "created_by": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } }, "organization_id": { "type": "string", "format": "uuid" } } }, "type": { "type": "string" } } } } }, "configuration-versions-response": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "auto-queue-runs": { "type": "boolean" }, "created-at": { "type": "string", "format": "date-time" }, "source": { "type": "string" }, "speculative": { "type": "boolean" }, "status": { "type": "string" }, "updated-at": { "type": "string" }, "upload-url": { "type": "string" } } }, "id": { "type": "string" }, "links": { "type": "object", "properties": { "upload": { "type": "string" } } }, "relationships": { "type": "object", "properties": { "workspace": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } } } } } } }, "type": { "type": "string" } } } } }, "dashboard-operations-response": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "executions": { "type": "array", "items": { "type": "object", "properties": { "detail": { "type": "string" }, "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "organization_id": { "type": "string", "format": "uuid" }, "organization_name": { "type": "string" }, "platform": { "type": "string" }, "started_at": { "type": "string", "format": "date-time" }, "status": { "type": "string" } } } }, "truncated": { "type": "boolean" } } }, "type": { "type": "string" } } } } }, "dashboard-stats-response": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "active_ansible_jobs": { "type": "string" }, "active_terraform_runs": { "type": "string" }, "ansible_playbooks": { "type": "string" }, "awaiting_approval": { "type": "string" }, "completed_ansible_jobs_this_month": { "type": "string" }, "completed_terraform_runs_this_month": { "type": "string" }, "errored_job_templates": { "type": "string" }, "errored_workspaces": { "type": "string" }, "failed_inventory_syncs": { "type": "string" }, "organizations": { "type": "array", "items": { "type": "object", "properties": { "active_ansible_jobs": { "type": "string" }, "active_terraform_runs": { "type": "string" }, "ansible_playbooks": { "type": "string" }, "awaiting_approval": { "type": "string" }, "completed_ansible_jobs_this_month": { "type": "string" }, "completed_terraform_runs_this_month": { "type": "string" }, "description": { "type": "string" }, "errored_job_templates": { "type": "string" }, "errored_workspaces": { "type": "string" }, "failed_inventory_syncs": { "type": "string" }, "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "open_change_requests": { "type": "string" }, "pending_terraform_runs": { "type": "string" }, "pending_workflow_approvals": { "type": "string" }, "projects": { "type": "string" }, "recent_job_failures": { "type": "string" }, "recent_run_failures": { "type": "string" }, "runners_offline": { "type": "string" }, "runners_total": { "type": "string" }, "terraform_workspaces": { "type": "string" } } } }, "pending_terraform_runs": { "type": "string" }, "pending_workflow_approvals": { "type": "string" }, "projects": { "type": "string" }, "recent_failure_window_days": { "type": "string" }, "recent_job_failures": { "type": "string" }, "recent_run_failures": { "type": "string" }, "terraform_workspaces": { "type": "string" } } }, "type": { "type": "string" } } } } }, "delete-api-v2-organizations-name-varsets-id-relationships-projects-request": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } } } } } }, "delete-api-v2-organizations-name-varsets-id-relationships-workspaces-request": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } } } } } }, "delete-api-v2-teams-id-relationships-organization-memberships-request": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } }, "required": [ "id", "type" ] } } }, "required": [ "data" ] }, "delete-api-v2-teams-id-relationships-users-request": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } }, "required": [ "id", "type" ] } } }, "required": [ "data" ] }, "delete-api-v2-varsets-id-relationships-projects-request": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } } } } } }, "delete-api-v2-varsets-id-relationships-workspaces-request": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } } } } } }, "delete-auth-sessions-id-8440a0": { "type": "object", "properties": { "details": { "type": "object", "properties": { "changeDate": { "type": "string", "format": "date-time" }, "resourceOwner": { "type": "string" }, "sequence": { "type": "string" } } } } }, "effective-permissions-response": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "ansible:adhoc:execute": { "type": "boolean" }, "ansible:credential:read": { "type": "boolean" }, "ansible:credential:write": { "type": "boolean" }, "ansible:inventory:read": { "type": "boolean" }, "ansible:inventory:write": { "type": "boolean" }, "ansible:job-template:read": { "type": "boolean" }, "ansible:job-template:write": { "type": "boolean" }, "ansible:job:execute": { "type": "boolean" }, "ansible:job:read": { "type": "boolean" }, "ansible:playbook:read": { "type": "boolean" }, "ansible:playbook:write": { "type": "boolean" }, "ansible:schedule:read": { "type": "boolean" }, "ansible:schedule:write": { "type": "boolean" }, "org:access-secret-teams": { "type": "boolean" }, "org:manage-agent-pools": { "type": "boolean" }, "org:manage-ansible": { "type": "boolean" }, "org:manage-membership": { "type": "boolean" }, "org:manage-modules": { "type": "boolean" }, "org:manage-organization-access": { "type": "boolean" }, "org:manage-policies": { "type": "boolean" }, "org:manage-policy-overrides": { "type": "boolean" }, "org:manage-projects": { "type": "boolean" }, "org:manage-providers": { "type": "boolean" }, "org:manage-run-tasks": { "type": "boolean" }, "org:manage-teams": { "type": "boolean" }, "org:manage-vcs-settings": { "type": "boolean" }, "org:manage-workspaces": { "type": "boolean" }, "org:read-ansible": { "type": "boolean" }, "org:read-projects": { "type": "boolean" }, "org:read-workspaces": { "type": "boolean" } } }, "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } }, "entitlement-sets-response": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "agents": { "type": "boolean" }, "audit-logging": { "type": "boolean" }, "configuration-design": { "type": "boolean" }, "cost-estimation": { "type": "boolean" }, "operations": { "type": "boolean" }, "policy-enforcement": { "type": "boolean" }, "private-module-registry": { "type": "boolean" }, "self-serve-billing": { "type": "boolean" }, "sentinel": { "type": "boolean" }, "sso": { "type": "boolean" }, "state-storage": { "type": "boolean" }, "teams": { "type": "boolean" }, "usage-reporting": { "type": "boolean" }, "user-limit": { "type": "integer" }, "vcs-integrations": { "type": "boolean" } } }, "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } }, "error-400": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "string" } } } }, "error-401": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "detail": { "type": "string" }, "status": { "type": "string" }, "title": { "type": "string" } } } } } }, "error-403": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "detail": { "type": "string" }, "status": { "type": "string" }, "title": { "type": "string" } } } } } }, "error-404": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "string" } } } }, "error-422": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "status": { "type": "string" }, "title": { "type": "string" } } } } } }, "error-500": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "detail": { "type": "string" }, "status": { "type": "string" }, "title": { "type": "string" } } } } } }, "gcp-oidc-configurations-response": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "project-number": { "type": "string" }, "service-account-email": { "type": "string" }, "workload-provider-name": { "type": "string" } } }, "id": { "type": "string" }, "links": { "type": "object", "properties": { "self": { "type": "string" } } }, "relationships": { "type": "object", "properties": { "organization": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } } } } } } }, "type": { "type": "string" } } } } }, "get--well-known-openid-configuration-8d57a4": { "type": "object", "properties": { "claims_supported": { "type": "array", "items": { "type": "string" } }, "id_token_signing_alg_values_supported": { "type": "array", "items": { "type": "string" } }, "issuer": { "type": "string" }, "jwks_uri": { "type": "string" }, "response_types_supported": { "type": "array", "items": { "type": "string" } }, "subject_types_supported": { "type": "array", "items": { "type": "string" } } } }, "get--well-known-terraform-json-357035": { "type": "object", "properties": { "login.v1": { "type": "object", "properties": { "authz": { "type": "string" }, "client": { "type": "string" }, "grant_types": { "type": "array", "items": { "type": "string" } }, "ports": { "type": "array", "items": { "type": "integer" } }, "token": { "type": "string" } } }, "modules.v1": { "type": "string" }, "providers.v1": { "type": "string" }, "tfe.v2": { "type": "string" }, "tfe.v2.1": { "type": "string" }, "tfe.v2.2": { "type": "string" } } }, "get-api-v2-activities-2699a0": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "meta": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "current-page": { "type": "integer" }, "next-page": { "nullable": true }, "page-size": { "type": "integer" }, "prev-page": { "nullable": true }, "total-count": { "type": "integer" }, "total-pages": { "type": "integer" } } } } } } }, "get-api-v2-activities-recent-2118da": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "meta": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "current-page": { "type": "integer" }, "next-page": { "nullable": true }, "page-size": { "type": "integer" }, "prev-page": { "nullable": true }, "total-count": { "type": "integer" }, "total-pages": { "type": "integer" } } } } } } }, "get-api-v2-agent-pools-id-authentication-tokens-9c3bbd": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "meta": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "current-page": { "type": "integer" }, "next-page": { "nullable": true }, "page-size": { "type": "integer" }, "prev-page": { "nullable": true }, "total-count": { "type": "integer" }, "total-pages": { "type": "integer" } } } } } } }, "get-api-v2-ansible-collections-search-dd1396": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "meta": { "type": "object", "properties": { "message": { "type": "string" }, "pagination": { "type": "object", "properties": { "current-page": { "type": "integer" }, "next-page": { "nullable": true }, "page-size": { "type": "integer" }, "prev-page": { "nullable": true }, "total-count": { "type": "integer" }, "total-pages": { "type": "integer" } } } } } } }, "get-api-v2-ansible-inventories-id-json-710cec": { "type": "object", "properties": { "all": { "type": "object", "properties": { "children": { "type": "object", "properties": { "ungrouped": { "nullable": true }, "webservers": { "nullable": true } } } } }, "ungrouped": { "type": "object", "properties": { "hosts": { "type": "object", "properties": { "web-01.demo.internal": { "type": "object", "properties": { "ansible_host": { "type": "string" } } } } } } }, "webservers": { "type": "object", "properties": { "hosts": { "type": "object", "additionalProperties": true } } } } }, "get-api-v2-ansible-job-templates-id-credentials-10f3a1": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "meta": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "current-page": { "type": "integer" }, "next-page": { "nullable": true }, "page-size": { "type": "integer" }, "prev-page": { "nullable": true }, "total-count": { "type": "integer" }, "total-pages": { "type": "integer" } } } } } } }, "get-api-v2-ansible-job-templates-id-notifications-dcfe45": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "meta": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "current-page": { "type": "integer" }, "next-page": { "nullable": true }, "page-size": { "type": "integer" }, "prev-page": { "nullable": true }, "total-count": { "type": "integer" }, "total-pages": { "type": "integer" } } } } } } }, "get-api-v2-ansible-job-templates-id-vars-1d29e9": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "links": { "type": "object", "properties": { "self": { "type": "string" } } }, "meta": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "current-page": { "type": "integer" }, "next-page": { "nullable": true }, "page-size": { "type": "integer" }, "prev-page": { "nullable": true }, "total-count": { "type": "integer" }, "total-pages": { "type": "integer" } } } } } } }, "get-api-v2-ansible-jobs-id-events-40dd40": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "meta": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "current-page": { "type": "integer" }, "next-page": { "nullable": true }, "page-size": { "type": "integer" }, "prev-page": { "nullable": true }, "total-count": { "type": "integer" }, "total-pages": { "type": "integer" } } } } } } }, "get-api-v2-ansible-jobs-id-output-02cdaf": { "nullable": true }, "get-api-v2-ansible-workflows-id-edges-555fc9": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "meta": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "current-page": { "type": "integer" }, "next-page": { "nullable": true }, "page-size": { "type": "integer" }, "prev-page": { "nullable": true }, "total-count": { "type": "integer" }, "total-pages": { "type": "integer" } } } } } } }, "get-api-v2-organizations-name-ansible-notification-templates-9820ac": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "meta": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "current-page": { "type": "integer" }, "next-page": { "nullable": true }, "page-size": { "type": "integer" }, "prev-page": { "nullable": true }, "total-count": { "type": "integer" }, "total-pages": { "type": "integer" } } } } } } }, "get-api-v2-organizations-name-oidc-configurations-c28ef5": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "meta": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "current-page": { "type": "integer" }, "next-page": { "nullable": true }, "page-size": { "type": "integer" }, "prev-page": { "nullable": true }, "total-count": { "type": "integer" }, "total-pages": { "type": "integer" } } } } } } }, "get-api-v2-organizations-name-runs-queue-1bb141": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "meta": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "current-page": { "type": "integer" }, "next-page": { "nullable": true }, "page-size": { "type": "integer" }, "prev-page": { "nullable": true }, "total-count": { "type": "integer" }, "total-pages": { "type": "integer" } } } } } } }, "get-api-v2-organizations-name-vcs-connections-e028b0": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "meta": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "current-page": { "type": "integer" }, "next-page": { "nullable": true }, "page-size": { "type": "integer" }, "prev-page": { "nullable": true }, "total-count": { "type": "integer" }, "total-pages": { "type": "integer" } } } } } } }, "get-api-v2-organizations-name-webhook-events-49a8f6": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "meta": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "current-page": { "type": "integer" }, "next-page": { "nullable": true }, "page-size": { "type": "integer" }, "prev-page": { "nullable": true }, "total-count": { "type": "integer" }, "total-pages": { "type": "integer" } } } } } } }, "get-api-v2-projects-id-ansible-job-templates-cbfd6b": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "meta": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "current-page": { "type": "integer" }, "next-page": { "nullable": true }, "page-size": { "type": "integer" }, "prev-page": { "nullable": true }, "total-count": { "type": "integer" }, "total-pages": { "type": "integer" } } } } } } }, "get-api-v2-projects-id-ansible-jobs-9e8c35": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "meta": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "current-page": { "type": "integer" }, "next-page": { "nullable": true }, "page-size": { "type": "integer" }, "prev-page": { "nullable": true }, "total-count": { "type": "integer" }, "total-pages": { "type": "integer" } } } } } } }, "get-api-v2-projects-id-ansible-playbooks-1a3a16": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "meta": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "current-page": { "type": "integer" }, "next-page": { "nullable": true }, "page-size": { "type": "integer" }, "prev-page": { "nullable": true }, "total-count": { "type": "integer" }, "total-pages": { "type": "integer" } } } } } } }, "get-api-v2-projects-id-effective-tag-bindings-39b35b": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "meta": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "current-page": { "type": "integer" }, "next-page": { "nullable": true }, "page-size": { "type": "integer" }, "prev-page": { "nullable": true }, "total-count": { "type": "integer" }, "total-pages": { "type": "integer" } } } } } } }, "get-api-v2-projects-id-notification-configurations-d73ecb": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "meta": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "current-page": { "type": "integer" }, "next-page": { "nullable": true }, "page-size": { "type": "integer" }, "prev-page": { "nullable": true }, "total-count": { "type": "integer" }, "total-pages": { "type": "integer" } } } } } } }, "get-api-v2-projects-id-tag-bindings-164f21": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "meta": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "current-page": { "type": "integer" }, "next-page": { "nullable": true }, "page-size": { "type": "integer" }, "prev-page": { "nullable": true }, "total-count": { "type": "integer" }, "total-pages": { "type": "integer" } } } } } } }, "get-api-v2-runs-id-task-stages-c0bd83": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "meta": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "current-page": { "type": "integer" }, "next-page": { "nullable": true }, "page-size": { "type": "integer" }, "prev-page": { "nullable": true }, "total-count": { "type": "integer" }, "total-pages": { "type": "integer" } } } } } } }, "get-api-v2-task-results-id-outcomes-0445e7": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "meta": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "current-page": { "type": "integer" }, "next-page": { "nullable": true }, "page-size": { "type": "integer" }, "prev-page": { "nullable": true }, "total-count": { "type": "integer" }, "total-pages": { "type": "integer" } } } } } } }, "get-api-v2-teams-id-notification-configurations-cc06a2": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "meta": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "current-page": { "type": "integer" }, "next-page": { "nullable": true }, "page-size": { "type": "integer" }, "prev-page": { "nullable": true }, "total-count": { "type": "integer" }, "total-pages": { "type": "integer" } } } } } } }, "get-api-v2-workspaces-id-change-requests-1d148b": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "meta": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "current-page": { "type": "integer" }, "next-page": { "nullable": true }, "page-size": { "type": "integer" }, "prev-page": { "nullable": true }, "total-count": { "type": "integer" }, "total-pages": { "type": "integer" } } } } } } }, "get-api-v2-workspaces-id-configuration-versions-940185": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "meta": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "current-page": { "type": "integer" }, "next-page": { "nullable": true }, "page-size": { "type": "integer" }, "prev-page": { "nullable": true }, "total-count": { "type": "integer" }, "total-pages": { "type": "integer" } } } } } } }, "get-api-v2-workspaces-id-effective-tag-bindings-9c10a3": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "meta": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "current-page": { "type": "integer" }, "next-page": { "nullable": true }, "page-size": { "type": "integer" }, "prev-page": { "nullable": true }, "total-count": { "type": "integer" }, "total-pages": { "type": "integer" } } } } } } }, "get-api-v2-workspaces-id-notification-configurations-8cab3c": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "meta": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "current-page": { "type": "integer" }, "next-page": { "nullable": true }, "page-size": { "type": "integer" }, "prev-page": { "nullable": true }, "total-count": { "type": "integer" }, "total-pages": { "type": "integer" } } } } } } }, "get-api-v2-workspaces-id-platform-variables-meta": { "type": "object", "properties": { "meta": { "type": "object", "properties": { "platform-variable-keys": { "type": "array", "items": { "type": "string" } } } } } }, "get-api-v2-workspaces-id-relationships-team-access-361c17": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "meta": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "current-page": { "type": "integer" }, "next-page": { "nullable": true }, "page-size": { "type": "integer" }, "prev-page": { "nullable": true }, "total-count": { "type": "integer" }, "total-pages": { "type": "integer" } } } } } } }, "get-api-v2-workspaces-id-run-triggers-2fbe10": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "meta": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "current-page": { "type": "integer" }, "next-page": { "nullable": true }, "page-size": { "type": "integer" }, "prev-page": { "nullable": true }, "total-count": { "type": "integer" }, "total-pages": { "type": "integer" } } } } } } }, "get-api-v2-workspaces-id-state-versions-84983e": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "meta": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "current-page": { "type": "integer" }, "next-page": { "nullable": true }, "page-size": { "type": "integer" }, "prev-page": { "nullable": true }, "total-count": { "type": "integer" }, "total-pages": { "type": "integer" } } } } } } }, "get-api-v2-workspaces-id-tag-bindings-268911": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "meta": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "current-page": { "type": "integer" }, "next-page": { "nullable": true }, "page-size": { "type": "integer" }, "prev-page": { "nullable": true }, "total-count": { "type": "integer" }, "total-pages": { "type": "integer" } } } } } } }, "get-api-v2-workspaces-id-tasks-68d8f2": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "meta": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "current-page": { "type": "integer" }, "next-page": { "nullable": true }, "page-size": { "type": "integer" }, "prev-page": { "nullable": true }, "total-count": { "type": "integer" }, "total-pages": { "type": "integer" } } } } } } }, "get-auth-health-auth-proxy-3b225d": { "type": "object", "properties": { "backchannel_binding_active": { "type": "boolean" }, "notification_mode": { "type": "string" }, "production_mode": { "type": "boolean" } } }, "get-auth-idp-providers-adcc06": { "type": "object", "properties": { "code": { "type": "integer" }, "details": { "type": "array", "items": { "type": "object", "properties": { "@type": { "type": "string" }, "id": { "type": "string" }, "message": { "type": "string" } } } }, "message": { "type": "string" } } }, "get-auth-oidc-auth-requests-id-282c21": { "type": "object", "properties": { "code": { "type": "integer" }, "details": { "type": "array", "items": { "type": "object", "properties": { "@type": { "type": "string" }, "id": { "type": "string" }, "message": { "type": "string" } } } }, "message": { "type": "string" } } }, "get-auth-oidc-discovery-19247f": { "type": "object", "properties": { "authorization_endpoint": { "type": "string" }, "backchannel_logout_session_supported": { "type": "boolean" }, "backchannel_logout_supported": { "type": "boolean" }, "claims_supported": { "type": "array", "items": { "type": "string" } }, "code_challenge_methods_supported": { "type": "array", "items": { "type": "string" } }, "device_authorization_endpoint": { "type": "string" }, "end_session_endpoint": { "type": "string" }, "grant_types_supported": { "type": "array", "items": { "type": "string" } }, "id_token_signing_alg_values_supported": { "type": "array", "items": { "type": "string" } }, "introspection_endpoint": { "type": "string" }, "introspection_endpoint_auth_methods_supported": { "type": "array", "items": { "type": "string" } }, "introspection_endpoint_auth_signing_alg_values_supported": { "type": "array", "items": { "type": "string" } }, "issuer": { "type": "string" }, "jwks_uri": { "type": "string" }, "request_object_signing_alg_values_supported": { "type": "array", "items": { "type": "string" } }, "request_parameter_supported": { "type": "boolean" }, "request_uri_parameter_supported": { "type": "boolean" }, "response_modes_supported": { "type": "array", "items": { "type": "string" } }, "response_types_supported": { "type": "array", "items": { "type": "string" } }, "revocation_endpoint": { "type": "string" }, "revocation_endpoint_auth_methods_supported": { "type": "array", "items": { "type": "string" } }, "revocation_endpoint_auth_signing_alg_values_supported": { "type": "array", "items": { "type": "string" } }, "scopes_supported": { "type": "array", "items": { "type": "string" } }, "subject_types_supported": { "type": "array", "items": { "type": "string" } }, "token_endpoint_auth_methods_supported": { "type": "array", "items": { "type": "string" } }, "token_endpoint_auth_signing_alg_values_supported": { "type": "array", "items": { "type": "string" } }, "ui_locales_supported": { "type": "array", "items": { "type": "string" } } } }, "get-auth-oidc-end-session-ee5f9e": { "type": "object", "properties": { "loggedOut": { "type": "boolean" } } }, "get-auth-oidc-keys-1193ff": { "type": "object", "properties": { "keys": { "type": "array", "items": { "type": "object", "properties": { "alg": { "type": "string" }, "e": { "type": "string" }, "kid": { "type": "string" }, "kty": { "type": "string" }, "n": { "type": "string" }, "use": { "type": "string" } } } } } }, "get-auth-settings-branding-58406b": { "type": "object", "properties": { "code": { "type": "integer" }, "details": { "type": "array", "items": { "type": "object", "properties": { "@type": { "type": "string" }, "id": { "type": "string" }, "message": { "type": "string" } } } }, "message": { "type": "string" } } }, "get-auth-settings-legal-fd2ce8": { "type": "object", "properties": { "code": { "type": "integer" }, "details": { "type": "array", "items": { "type": "object", "properties": { "@type": { "type": "string" }, "id": { "type": "string" }, "message": { "type": "string" } } } }, "message": { "type": "string" } } }, "get-auth-settings-lockout-8df1d0": { "type": "object", "properties": { "code": { "type": "integer" }, "details": { "type": "array", "items": { "type": "object", "properties": { "@type": { "type": "string" }, "id": { "type": "string" }, "message": { "type": "string" } } } }, "message": { "type": "string" } } }, "get-auth-settings-login-6e1460": { "type": "object", "properties": { "code": { "type": "integer" }, "details": { "type": "array", "items": { "type": "object", "properties": { "@type": { "type": "string" }, "id": { "type": "string" }, "message": { "type": "string" } } } }, "message": { "type": "string" } } }, "get-auth-settings-password-complexity-e836cc": { "type": "object", "properties": { "code": { "type": "integer" }, "details": { "type": "array", "items": { "type": "object", "properties": { "@type": { "type": "string" }, "id": { "type": "string" }, "message": { "type": "string" } } } }, "message": { "type": "string" } } }, "get-auth-settings-password-expiry-c5ddde": { "type": "object", "properties": { "code": { "type": "integer" }, "details": { "type": "array", "items": { "type": "object", "properties": { "@type": { "type": "string" }, "id": { "type": "string" }, "message": { "type": "string" } } } }, "message": { "type": "string" } } }, "get-auth-settings-security-a814c5": { "type": "object", "properties": { "code": { "type": "integer" }, "details": { "type": "array", "items": { "type": "object", "properties": { "@type": { "type": "string" }, "id": { "type": "string" }, "message": { "type": "string" } } } }, "message": { "type": "string" } } }, "get-health-428884": { "type": "object", "properties": { "status": { "type": "string" } } }, "get-v1-modules-1b59d5": { "type": "object", "properties": { "meta": { "type": "object", "properties": { "current_offset": { "type": "integer" }, "limit": { "type": "integer" } } }, "modules": { "type": "array", "items": { "type": "object", "properties": { "description": { "type": "string" }, "downloads": { "type": "integer" }, "id": { "type": "string" }, "name": { "type": "string" }, "namespace": { "type": "string" }, "owner": { "type": "string" }, "provider": { "type": "string" }, "published_at": { "type": "string", "format": "date-time" }, "source": { "type": "string" }, "verified": { "type": "boolean" }, "version": { "type": "string" } } } } } }, "get-v1-providers-c0509a": { "type": "object", "properties": { "meta": { "type": "object", "properties": { "current_offset": { "type": "integer" }, "limit": { "type": "integer" } } }, "providers": { "type": "array", "items": { "type": "object", "properties": { "downloads": { "type": "integer" }, "id": { "type": "string" }, "name": { "type": "string" }, "namespace": { "type": "string" }, "published_at": { "type": "string", "format": "date-time" }, "verified": { "type": "boolean" }, "version": { "type": "string" } } } } } }, "get-v1-providers-namespace-56a3d5": { "type": "object", "properties": { "meta": { "type": "object", "properties": { "current_offset": { "type": "integer" }, "limit": { "type": "integer" } } }, "providers": { "type": "array", "items": { "type": "object", "properties": { "downloads": { "type": "integer" }, "id": { "type": "string" }, "name": { "type": "string" }, "namespace": { "type": "string" }, "published_at": { "type": "string", "format": "date-time" }, "verified": { "type": "boolean" }, "version": { "type": "string" } } } } } }, "get-v1-providers-namespace-name-821eb0": { "type": "object", "properties": { "downloads": { "type": "integer" }, "id": { "type": "string" }, "name": { "type": "string" }, "namespace": { "type": "string" }, "platforms": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "published_at": { "type": "string", "format": "date-time" }, "verified": { "type": "boolean" }, "version": { "type": "string" }, "versions": { "type": "array", "items": { "type": "string" } } } }, "get-v1-providers-namespace-name-version-0743f3": { "type": "object", "properties": { "downloads": { "type": "integer" }, "id": { "type": "string" }, "name": { "type": "string" }, "namespace": { "type": "string" }, "platforms": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "published_at": { "type": "string", "format": "date-time" }, "verified": { "type": "boolean" }, "version": { "type": "string" }, "versions": { "type": "array", "items": { "type": "string" } } } }, "get-v1-providers-namespace-name-versions-81e7db": { "type": "object", "properties": { "versions": { "type": "array", "items": { "type": "object", "properties": { "platforms": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "protocols": { "type": "array", "items": { "type": "string" } }, "version": { "type": "string" } } } } } }, "gpg-keys-response": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "ascii-armor": { "type": "string" }, "created-at": { "type": "string", "format": "date-time" }, "key-id": { "type": "string" }, "namespace": { "type": "string" }, "source": { "type": "string" }, "source-url": { "nullable": true }, "trust-signature": { "type": "string" }, "updated-at": { "type": "string", "format": "date-time" } } }, "id": { "type": "string" }, "type": { "type": "string" } } } } }, "head-health-3ad84b": { "nullable": true }, "inventory-sources-collection": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "config": { "type": "object", "properties": { "region": { "type": "string" } } }, "created-at": { "type": "string", "format": "date-time" }, "description": { "type": "string" }, "enabled": { "type": "boolean" }, "group-by-availability-zone": { "type": "boolean" }, "group-by-instance-id": { "type": "boolean" }, "group-by-region": { "type": "boolean" }, "group-by-tag": { "type": "string" }, "hostname-var": { "type": "string" }, "hosts-count": { "type": "integer" }, "instance-filters": { "type": "string" }, "last-sync-at": { "nullable": true }, "last-sync-error": { "type": "string" }, "last-sync-log": { "type": "string" }, "name": { "type": "string" }, "overwrite": { "type": "boolean" }, "overwrite-vars": { "type": "boolean" }, "source-type": { "type": "string" }, "status": { "type": "string" }, "sync-schedule": { "type": "string" }, "update-cache-timeout": { "type": "integer" }, "update-on-launch": { "type": "boolean" }, "updated-at": { "type": "string", "format": "date-time" }, "verbosity": { "type": "integer" } } }, "id": { "type": "string", "format": "uuid" }, "relationships": { "type": "object", "properties": { "inventory": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } } } }, "type": { "type": "string" } } } }, "meta": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "current-page": { "type": "integer" }, "next-page": { "nullable": true }, "page-size": { "type": "integer" }, "prev-page": { "nullable": true }, "total-count": { "type": "integer" }, "total-pages": { "type": "integer" } } } } } } }, "inventory-sources-response": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "config": { "type": "object", "properties": { "region": { "type": "string" }, "regions": { "type": "array", "items": { "type": "string" } } } }, "created-at": { "type": "string", "format": "date-time" }, "description": { "type": "string" }, "enabled": { "type": "boolean" }, "group-by-availability-zone": { "type": "boolean" }, "group-by-instance-id": { "type": "boolean" }, "group-by-region": { "type": "boolean" }, "group-by-tag": { "type": "string" }, "hostname-var": { "type": "string" }, "hosts-count": { "type": "integer" }, "instance-filters": { "type": "string" }, "last-sync-at": { "nullable": true }, "last-sync-error": { "type": "string" }, "last-sync-log": { "type": "string" }, "name": { "type": "string" }, "overwrite": { "type": "boolean" }, "overwrite-vars": { "type": "boolean" }, "source-type": { "type": "string" }, "status": { "type": "string" }, "sync-schedule": { "type": "string" }, "update-cache-timeout": { "type": "integer" }, "update-on-launch": { "type": "boolean" }, "updated-at": { "type": "string", "format": "date-time" }, "verbosity": { "type": "integer" } } }, "id": { "type": "string", "format": "uuid" }, "relationships": { "type": "object", "properties": { "credential": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } }, "inventory": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } } } }, "type": { "type": "string" } } } } }, "inventory-syncs-collection": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "created-at": { "type": "string", "format": "date-time" }, "error": { "type": "string" }, "finished-at": { "type": "string", "format": "date-time" }, "groups-discovered": { "type": "integer" }, "hosts-discovered": { "type": "integer" }, "source-name": { "type": "string" }, "started-at": { "type": "string", "format": "date-time" }, "status": { "type": "string" }, "triggered-by": { "type": "string" } } }, "id": { "type": "string", "format": "uuid" }, "relationships": { "type": "object", "properties": { "inventory": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } }, "source": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } } } }, "type": { "type": "string" } } } }, "meta": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "current-page": { "type": "integer" }, "next-page": { "nullable": true }, "page-size": { "type": "integer" }, "prev-page": { "nullable": true }, "total-count": { "type": "integer" }, "total-pages": { "type": "integer" } } } } } } }, "inventory-syncs-response": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "created-at": { "type": "string", "format": "date-time" }, "error": { "type": "string" }, "finished-at": { "type": "string", "format": "date-time" }, "groups-discovered": { "type": "integer" }, "hosts-discovered": { "type": "integer" }, "output": { "type": "string" }, "source-name": { "type": "string" }, "started-at": { "type": "string", "format": "date-time" }, "status": { "type": "string" }, "triggered-by": { "type": "string" } } }, "id": { "type": "string", "format": "uuid" }, "relationships": { "type": "object", "properties": { "inventory": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } }, "source": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } } } }, "type": { "type": "string" } } } } }, "jwks": { "type": "object", "properties": { "keys": { "type": "array", "items": { "type": "object", "properties": { "alg": { "type": "string" }, "e": { "type": "string" }, "kid": { "type": "string" }, "kty": { "type": "string" }, "n": { "type": "string" }, "use": { "type": "string" } } } } } }, "module-versions-collection": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "dependencies": { "nullable": true }, "downloads": { "type": "integer" }, "inputs": { "nullable": true }, "outputs": { "nullable": true }, "published_at": { "type": "string", "format": "date-time" }, "readme": { "type": "string" }, "resources": { "nullable": true }, "source": { "type": "string" }, "submodules": { "nullable": true }, "tarball_size": { "type": "integer" }, "version": { "type": "string" } } }, "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } }, "meta": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "current-page": { "type": "integer" }, "next-page": { "nullable": true }, "page-size": { "type": "integer" }, "prev-page": { "nullable": true }, "total-count": { "type": "integer" }, "total-pages": { "type": "integer" } } } } } } }, "notification-configurations-response": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "created-at": { "type": "string", "format": "date-time" }, "destination-type": { "type": "string" }, "email-addresses": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "enabled": { "type": "boolean" }, "name": { "type": "string" }, "triggers": { "type": "array", "items": { "type": "string" } }, "updated-at": { "type": "string", "format": "date-time" }, "url": { "type": "string" } } }, "id": { "type": "string" }, "relationships": { "type": "object", "properties": { "subscribable": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } } } } } } }, "type": { "type": "string" } } } } }, "organization-memberships-collection": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "created-at": { "type": "string", "format": "date-time" }, "email": { "type": "string" }, "name": { "type": "string" }, "role": { "nullable": true }, "status": { "type": "string" }, "username": { "type": "string" } } }, "id": { "type": "string", "format": "uuid" }, "relationships": { "type": "object", "properties": { "organization": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } } } } }, "teams": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": true } } } }, "user": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } } } }, "type": { "type": "string" } } } }, "included": { "type": "array", "items": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "email": { "type": "string" }, "name": { "type": "string" }, "username": { "type": "string" } } }, "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } }, "meta": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "current-page": { "type": "integer" }, "next-page": { "nullable": true }, "page-size": { "type": "integer" }, "prev-page": { "nullable": true }, "total-count": { "type": "integer" }, "total-pages": { "type": "integer" } } } } } } }, "organization-memberships-response": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "created-at": { "type": "string", "format": "date-time" }, "email": { "type": "string" }, "name": { "type": "string" }, "role": { "nullable": true }, "status": { "type": "string" }, "username": { "type": "string" } } }, "id": { "type": "string", "format": "uuid" }, "relationships": { "type": "object", "properties": { "organization": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } } } } }, "teams": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": true } } } }, "user": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } } } }, "type": { "type": "string" } } }, "included": { "type": "array", "items": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "email": { "type": "string" }, "name": { "type": "string" }, "username": { "type": "string" } } }, "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } } }, "organizations-collection": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "aggregated-commit-status-enabled": { "type": "boolean" }, "allow-force-delete-workspaces": { "type": "boolean" }, "ansible-adhoc-modules": { "type": "string" }, "ansible-job-retention-days": { "type": "integer" }, "assessments-enforced": { "type": "boolean" }, "collaborator-auth-policy": { "type": "string" }, "cost-estimation-enabled": { "type": "boolean" }, "created-at": { "type": "string", "format": "date-time" }, "default-execution-mode": { "type": "string" }, "default-terraform-version": { "type": "string" }, "email": { "type": "string" }, "enforce-hyok": { "type": "boolean" }, "external-id": { "type": "string", "format": "uuid" }, "max-ttl-enabled": { "type": "boolean" }, "name": { "type": "string" }, "owners-team-saml-role-id": { "type": "string" }, "permissions": { "type": "object", "properties": { "can-access-via-teams": { "type": "boolean" }, "can-create-module": { "type": "boolean" }, "can-create-project": { "type": "boolean" }, "can-create-provider": { "type": "boolean" }, "can-create-team": { "type": "boolean" }, "can-create-workspace": { "type": "boolean" }, "can-deploy-no-code-modules": { "type": "boolean" }, "can-destroy": { "type": "boolean" }, "can-manage-assessments": { "type": "boolean" }, "can-manage-policies": { "type": "boolean" }, "can-manage-policy-overrides": { "type": "boolean" }, "can-manage-projects": { "type": "boolean" }, "can-manage-public-modules": { "type": "boolean" }, "can-manage-public-providers": { "type": "boolean" }, "can-manage-run-tasks": { "type": "boolean" }, "can-manage-sso": { "type": "boolean" }, "can-manage-subscription": { "type": "boolean" }, "can-manage-tags": { "type": "boolean" }, "can-manage-users": { "type": "boolean" }, "can-manage-varsets": { "type": "boolean" }, "can-read-assessments": { "type": "boolean" }, "can-read-run-tasks": { "type": "boolean" }, "can-read-varsets": { "type": "boolean" }, "can-start-trial": { "type": "boolean" }, "can-traverse": { "type": "boolean" }, "can-update": { "type": "boolean" }, "can-update-agent-pools": { "type": "boolean" }, "can-update-api-token": { "type": "boolean" }, "can-update-oauth": { "type": "boolean" }, "can-update-sentinel": { "type": "boolean" }, "can-update-ssh-keys": { "type": "boolean" }, "can-view-explorer": { "type": "boolean" } } }, "send-passing-statuses-for-untriggered-speculative-plans": { "type": "boolean" }, "session-remember": { "nullable": true }, "session-timeout": { "nullable": true }, "speculative-plan-management-enabled": { "type": "boolean" }, "stacks-enabled": { "type": "boolean" }, "two-factor-conformant": { "type": "boolean" }, "updated-at": { "type": "string", "format": "date-time" }, "user-tokens-enabled": { "type": "boolean" } } }, "id": { "type": "string" }, "links": { "type": "object", "properties": { "self": { "type": "string" } } }, "relationships": { "type": "object", "additionalProperties": true }, "type": { "type": "string" } } } }, "meta": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "current-page": { "type": "integer" }, "next-page": { "nullable": true }, "page-size": { "type": "integer" }, "prev-page": { "nullable": true }, "total-count": { "type": "integer" }, "total-pages": { "type": "integer" } } } } } } }, "organizations-response": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "aggregated-commit-status-enabled": { "type": "boolean" }, "allow-force-delete-workspaces": { "type": "boolean" }, "ansible-adhoc-modules": { "type": "string" }, "ansible-job-retention-days": { "type": "integer" }, "assessments-enforced": { "type": "boolean" }, "collaborator-auth-policy": { "type": "string" }, "cost-estimation-enabled": { "type": "boolean" }, "created-at": { "type": "string", "format": "date-time" }, "default-execution-mode": { "type": "string" }, "default-terraform-version": { "type": "string" }, "email": { "type": "string" }, "enforce-hyok": { "type": "boolean" }, "external-id": { "type": "string", "format": "uuid" }, "max-ttl-enabled": { "type": "boolean" }, "name": { "type": "string" }, "owners-team-saml-role-id": { "type": "string" }, "permissions": { "type": "object", "properties": { "can-access-via-teams": { "type": "boolean" }, "can-create-module": { "type": "boolean" }, "can-create-project": { "type": "boolean" }, "can-create-provider": { "type": "boolean" }, "can-create-team": { "type": "boolean" }, "can-create-workspace": { "type": "boolean" }, "can-deploy-no-code-modules": { "type": "boolean" }, "can-destroy": { "type": "boolean" }, "can-manage-assessments": { "type": "boolean" }, "can-manage-policies": { "type": "boolean" }, "can-manage-policy-overrides": { "type": "boolean" }, "can-manage-projects": { "type": "boolean" }, "can-manage-public-modules": { "type": "boolean" }, "can-manage-public-providers": { "type": "boolean" }, "can-manage-run-tasks": { "type": "boolean" }, "can-manage-sso": { "type": "boolean" }, "can-manage-subscription": { "type": "boolean" }, "can-manage-tags": { "type": "boolean" }, "can-manage-users": { "type": "boolean" }, "can-manage-varsets": { "type": "boolean" }, "can-read-assessments": { "type": "boolean" }, "can-read-run-tasks": { "type": "boolean" }, "can-read-varsets": { "type": "boolean" }, "can-start-trial": { "type": "boolean" }, "can-traverse": { "type": "boolean" }, "can-update": { "type": "boolean" }, "can-update-agent-pools": { "type": "boolean" }, "can-update-api-token": { "type": "boolean" }, "can-update-oauth": { "type": "boolean" }, "can-update-sentinel": { "type": "boolean" }, "can-update-ssh-keys": { "type": "boolean" }, "can-view-explorer": { "type": "boolean" } } }, "send-passing-statuses-for-untriggered-speculative-plans": { "type": "boolean" }, "session-remember": { "nullable": true }, "session-timeout": { "nullable": true }, "speculative-plan-management-enabled": { "type": "boolean" }, "stacks-enabled": { "type": "boolean" }, "two-factor-conformant": { "type": "boolean" }, "updated-at": { "type": "string", "format": "date-time" }, "user-tokens-enabled": { "type": "boolean" } } }, "id": { "type": "string" }, "links": { "type": "object", "properties": { "self": { "type": "string" } } }, "relationships": { "type": "object", "properties": { "default-agent-pool": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } }, "default-project": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } } } }, "type": { "type": "string" } } } } }, "patch-api-v2-account-update-request": { "type": "object", "properties": { "data": { "type": "object", "nullable": true, "properties": { "attributes": { "type": "object", "properties": { "bio": { "type": "string", "nullable": true }, "company": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "location": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "username": { "type": "string", "nullable": true } } }, "type": { "type": "string" } } } }, "required": [ "data" ] }, "patch-api-v2-admin-terraform-versions-id-request": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "archs": { "type": "array", "items": { "type": "object", "properties": { "arch": { "type": "string" }, "os": { "type": "string" }, "sha": { "type": "string" }, "url": { "type": "string" } } } }, "beta": { "type": "boolean", "nullable": true }, "deprecated": { "type": "boolean", "nullable": true }, "deprecated-reason": { "type": "string", "nullable": true }, "enabled": { "type": "boolean", "nullable": true }, "official": { "type": "boolean", "nullable": true }, "sha": { "type": "string", "nullable": true }, "url": { "type": "string", "nullable": true }, "version": { "type": "string", "nullable": true } } }, "type": { "type": "string" } } } } }, "patch-api-v2-agent-pools-id-request": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "nullable": true, "properties": { "name": { "type": "string", "nullable": true }, "organization-scoped": { "type": "boolean", "nullable": true } } }, "relationships": { "type": "object", "nullable": true, "properties": { "allowed-projects": { "type": "object", "nullable": true, "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } } } } } }, "allowed-workspaces": { "type": "object", "nullable": true, "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } } } } } }, "excluded-workspaces": { "type": "object", "nullable": true, "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } } } } } } } }, "type": { "type": "string" } }, "required": [ "type" ] } }, "required": [ "data" ] }, "patch-api-v2-ansible-credentials-id-request": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "aws-access-key-id": { "type": "string", "nullable": true }, "aws-secret-access-key": { "type": "string", "nullable": true }, "azure-client-id": { "type": "string", "nullable": true }, "azure-client-secret": { "type": "string", "nullable": true }, "azure-tenant-id": { "type": "string", "nullable": true }, "become-password": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "gcp-service-account": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "password": { "type": "string", "nullable": true }, "ssh-become-user": { "type": "string", "nullable": true }, "ssh-passphrase": { "type": "string", "nullable": true }, "ssh-port": { "type": "integer", "nullable": true }, "ssh-private-key": { "type": "string", "nullable": true }, "username": { "type": "string", "nullable": true }, "vault-password": { "type": "string", "nullable": true } } }, "relationships": { "type": "object", "properties": { "project": { "type": "object", "properties": { "data": { "type": "object", "nullable": true, "properties": { "id": { "type": "string" }, "type": { "type": "string" } } } } } } }, "type": { "type": "string" } } } } }, "patch-api-v2-ansible-groups-id-request": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "description": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "variables": { "type": "object", "nullable": true, "additionalProperties": true } } }, "relationships": { "type": "object", "properties": { "parent": { "type": "object", "properties": { "data": { "type": "object", "nullable": true, "properties": { "id": { "type": "string" }, "type": { "type": "string" } } } } } } }, "type": { "type": "string" } } } } }, "patch-api-v2-ansible-hosts-id-request": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "description": { "type": "string", "nullable": true }, "enabled": { "type": "boolean", "nullable": true }, "hostname": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "port": { "type": "integer", "nullable": true }, "variables": { "type": "object", "nullable": true, "additionalProperties": true } } }, "type": { "type": "string" } } } } }, "patch-api-v2-ansible-inventories-id-request": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "constructed-cache-timeout": { "type": "integer", "nullable": true }, "constructed-limit": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "input-inventory-ids": { "type": "array", "nullable": true, "items": { "type": "string" } }, "inventory_path": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "source": { "type": "string", "nullable": true }, "source-vars": { "type": "string", "nullable": true }, "variables": { "type": "object", "nullable": true, "additionalProperties": true }, "vcs_branch": { "type": "string", "nullable": true }, "vcs_repository": { "type": "string", "nullable": true } } }, "relationships": { "type": "object", "properties": { "project": { "type": "object", "properties": { "data": { "type": "object", "nullable": true, "properties": { "id": { "type": "string" }, "type": { "type": "string" } } } } }, "vcs_connection": { "type": "object", "properties": { "data": { "type": "object", "nullable": true, "properties": { "id": { "type": "string" }, "type": { "type": "string" } } } } } } }, "type": { "type": "string" } } } } }, "patch-api-v2-ansible-inventory-sources-source_id-request": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "config": { "type": "object", "nullable": true, "additionalProperties": true }, "credential-id": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "enabled": { "type": "boolean", "nullable": true }, "group-by-availability-zone": { "type": "boolean", "nullable": true }, "group-by-instance-id": { "type": "boolean", "nullable": true }, "group-by-region": { "type": "boolean", "nullable": true }, "group-by-tag": { "type": "string", "nullable": true }, "hostname-var": { "type": "string", "nullable": true }, "instance-filters": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "overwrite": { "type": "boolean", "nullable": true }, "overwrite-vars": { "type": "boolean", "nullable": true }, "source-type": { "type": "string", "nullable": true }, "sync-schedule": { "type": "string", "nullable": true }, "update-cache-timeout": { "type": "integer", "nullable": true }, "update-on-launch": { "type": "boolean", "nullable": true }, "verbosity": { "type": "integer", "nullable": true } } }, "type": { "type": "string" } } } } }, "patch-api-v2-ansible-job-templates-id-request": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "allow-callbacks": { "type": "boolean", "nullable": true }, "allow-simultaneous": { "type": "boolean", "nullable": true }, "become-enabled": { "type": "boolean", "nullable": true }, "description": { "type": "string", "nullable": true }, "diff-mode": { "type": "boolean", "nullable": true }, "enabled": { "type": "boolean", "nullable": true }, "extra-vars": { "type": "object", "nullable": true, "additionalProperties": true }, "forks": { "type": "integer", "nullable": true }, "job-slice-count": { "type": "integer", "nullable": true }, "launch-on-webhook": { "type": "boolean", "nullable": true }, "limit": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "retention-days": { "type": "integer", "nullable": true }, "schedule-cron": { "type": "string", "nullable": true }, "schedule-enabled": { "type": "boolean", "nullable": true }, "skip-tags": { "type": "string", "nullable": true }, "tags": { "type": "string", "nullable": true }, "timeout-seconds": { "type": "integer", "nullable": true }, "verbosity": { "type": "integer", "nullable": true } } }, "id": { "type": "string" }, "relationships": { "type": "object", "properties": { "agent-pool": { "type": "object", "properties": { "data": { "type": "object", "nullable": true, "properties": { "id": { "type": "string" }, "type": { "type": "string" } } } } }, "credentials": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } } } } } }, "inventory": { "type": "object", "properties": { "data": { "type": "object", "nullable": true, "properties": { "id": { "type": "string" }, "type": { "type": "string" } } } } }, "playbook": { "type": "object", "properties": { "data": { "type": "object", "nullable": true, "properties": { "id": { "type": "string" }, "type": { "type": "string" } } } } } } }, "type": { "type": "string" } } } } }, "patch-api-v2-ansible-job-templates-id-vars-variable_id-request": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "category": { "type": "string" }, "description": { "type": "string" }, "hcl": { "type": "boolean", "nullable": true }, "key": { "type": "string" }, "sensitive": { "type": "boolean", "nullable": true }, "value": { "type": "string" } } }, "id": { "type": "string" }, "type": { "type": "string" } } } } }, "patch-api-v2-ansible-notification-templates-id-request": { "type": "object", "properties": { "data": { "type": "object", "nullable": true, "properties": { "attributes": { "type": "object", "properties": { "config": { "type": "object", "additionalProperties": true }, "description": { "type": "string" }, "name": { "type": "string" }, "notification-type": { "type": "string" }, "secret": { "type": "string", "nullable": true } } }, "type": { "type": "string" } } } }, "required": [ "data" ] }, "patch-api-v2-ansible-playbooks-id-request": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "description": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "playbook-path": { "type": "string", "nullable": true }, "source-mode": { "type": "string", "nullable": true }, "vcs-branch": { "type": "string", "nullable": true }, "vcs-repository": { "type": "string", "nullable": true } } }, "id": { "type": "string" }, "relationships": { "type": "object", "properties": { "vcs-connection": { "type": "object", "properties": { "data": { "type": "object", "nullable": true, "properties": { "id": { "type": "string" }, "type": { "type": "string" } } } } } } }, "type": { "type": "string" } } } } }, "patch-api-v2-ansible-schedules-schedule_id-request": { "type": "object", "properties": { "data": { "type": "object", "nullable": true, "properties": { "attributes": { "type": "object", "properties": { "config": { "type": "object", "nullable": true, "additionalProperties": true }, "cron-expression": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "timezone": { "type": "string", "nullable": true } } }, "type": { "type": "string" } } } }, "required": [ "data" ] }, "patch-api-v2-ansible-workflow-nodes-id-request": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "all-parents-must-converge": { "type": "boolean", "nullable": true }, "extra-vars": { "type": "string", "nullable": true }, "limit": { "type": "string", "nullable": true }, "position-x": { "type": "number", "nullable": true }, "position-y": { "type": "number", "nullable": true }, "skip-tags": { "type": "string", "nullable": true }, "tags": { "type": "string", "nullable": true }, "verbosity": { "type": "integer", "nullable": true } } }, "type": { "type": "string" } } } } }, "patch-api-v2-ansible-workflows-id-request": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "allow-simultaneous": { "type": "boolean", "nullable": true }, "ask-inventory-on-launch": { "type": "boolean", "nullable": true }, "ask-limit-on-launch": { "type": "boolean", "nullable": true }, "ask-variables-on-launch": { "type": "boolean", "nullable": true }, "description": { "type": "string", "nullable": true }, "extra-vars": { "type": "string", "nullable": true }, "limit": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "survey-enabled": { "type": "boolean", "nullable": true } } }, "type": { "type": "string" } } } } }, "patch-api-v2-notification-configurations-id-request": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "destination-type": { "type": "string", "nullable": true }, "email-addresses": { "type": "array", "items": { "type": "string" } }, "enabled": { "type": "boolean", "nullable": true }, "name": { "type": "string", "nullable": true }, "token": { "type": "string", "nullable": true }, "triggers": { "type": "array", "items": { "type": "string" } }, "url": { "type": "string", "nullable": true } } }, "type": { "type": "string" } } } } }, "patch-api-v2-oidc-configurations-id-request": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "project-number": { "type": "string", "nullable": true }, "service-account-email": { "type": "string", "nullable": true }, "workload-provider-name": { "type": "string", "nullable": true } } }, "type": { "type": "string" } }, "required": [ "type" ] } }, "required": [ "data" ] }, "patch-api-v2-organization-memberships-id-request": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "role": { "type": "string" } } }, "id": { "type": "string" }, "type": { "type": "string" } }, "required": [ "id", "type" ] } }, "required": [ "data" ] }, "patch-api-v2-organizations-name-projects-project_name-request": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "default-agent-pool-id": { "type": "string", "nullable": true }, "default-execution-mode": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "setting-overwrites": { "type": "object", "nullable": true, "properties": { "default-agent-pool": { "type": "boolean", "nullable": true }, "default-execution-mode": { "type": "boolean", "nullable": true } } } } }, "relationships": { "type": "object", "nullable": true, "properties": { "tag-bindings": { "type": "object", "nullable": true, "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "key": { "type": "string" }, "value": { "type": "string" } } } } } } } } } }, "type": { "type": "string" } }, "required": [ "type" ] } }, "required": [ "data" ] }, "patch-api-v2-organizations-name-request": { "type": "object", "properties": { "data": { "type": "object", "nullable": true, "properties": { "attributes": { "type": "object", "properties": { "aggregated-commit-status-enabled": { "type": "boolean", "nullable": true }, "allow-force-delete-workspaces": { "type": "boolean", "nullable": true }, "ansible-adhoc-modules": { "type": "string", "nullable": true }, "ansible-job-retention-days": { "type": "integer", "nullable": true }, "assessments-enforced": { "type": "boolean", "nullable": true }, "collaborator-auth-policy": { "type": "string" }, "cost-estimation-enabled": { "type": "boolean", "nullable": true }, "default-execution-mode": { "type": "string", "nullable": true }, "default-terraform-version": { "type": "string", "nullable": true }, "description": { "type": "string" }, "email": { "type": "string" }, "name": { "type": "string" }, "send-passing-statuses-for-untriggered-speculative-plans": { "type": "boolean", "nullable": true }, "speculative-plan-management-enabled": { "type": "boolean", "nullable": true }, "user-tokens-enabled": { "type": "boolean", "nullable": true } } }, "relationships": { "type": "object", "nullable": true, "properties": { "default-agent-pool": { "type": "object", "nullable": true, "properties": { "data": { "type": "object", "nullable": true, "properties": { "id": { "type": "string" }, "type": { "type": "string" } } } } } } }, "type": { "type": "string" } } } }, "required": [ "data" ] }, "patch-api-v2-organizations-name-teams-teamName-request": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "allow-member-token-management": { "type": "boolean", "nullable": true }, "description": { "type": "string" }, "name": { "type": "string" }, "organization-access": { "type": "object", "additionalProperties": true }, "sso-team-id": { "type": "string", "nullable": true }, "visibility": { "type": "string" } } }, "type": { "type": "string" } }, "required": [ "type" ] } }, "required": [ "data" ] }, "patch-api-v2-organizations-name-varsets-id-relationships-vars-variable_id-request": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "category": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "hcl": { "type": "boolean", "nullable": true }, "key": { "type": "string", "nullable": true }, "sensitive": { "type": "boolean", "nullable": true }, "value": { "type": "string", "nullable": true } } }, "type": { "type": "string" } }, "required": [ "type" ] } }, "required": [ "data" ] }, "patch-api-v2-organizations-name-varsets-id-request": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "description": { "type": "string", "nullable": true }, "global": { "type": "boolean", "nullable": true }, "name": { "type": "string", "nullable": true }, "priority": { "type": "boolean", "nullable": true } } }, "relationships": { "type": "object", "properties": { "parent": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true } } }, "projects": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": true } } } }, "vars": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": true } } } }, "workspaces": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": true } } } } } }, "type": { "type": "string" } }, "required": [ "type" ] } }, "required": [ "data" ] }, "patch-api-v2-organizations-name-workspaces-workspace_name-request": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "agent-pool-id": { "type": "string", "nullable": true }, "allow-destroy-plan": { "type": "boolean", "nullable": true }, "assessments-enabled": { "type": "boolean", "nullable": true }, "auto-apply": { "type": "boolean", "nullable": true }, "auto-apply-run-trigger": { "type": "boolean", "nullable": true }, "auto-queue-runs": { "type": "boolean", "nullable": true }, "description": { "type": "string" }, "execution-mode": { "type": "string" }, "file-triggers-enabled": { "type": "boolean", "nullable": true }, "force-delete": { "type": "boolean", "nullable": true }, "global-remote-state": { "type": "boolean", "nullable": true }, "name": { "type": "string" }, "queue-all-runs": { "type": "boolean", "nullable": true }, "run-timeout": { "type": "integer", "nullable": true }, "speculative-enabled": { "type": "boolean", "nullable": true }, "structured-run-output-enabled": { "type": "boolean", "nullable": true }, "tag-names": { "type": "array", "items": { "type": "string" } }, "terraform-version": { "type": "string" }, "trigger-patterns": { "type": "array", "nullable": true, "items": { "type": "string" } }, "trigger-prefixes": { "type": "array", "nullable": true, "items": { "type": "string" } }, "vcs-branch": { "type": "string" }, "vcs-connection-id": { "nullable": true }, "vcs-provider": { "type": "string" }, "vcs-repo": { "type": "object", "nullable": true, "properties": { "branch": { "type": "string" }, "github-app-installation-id": { "type": "string" }, "identifier": { "type": "string" }, "ingress-submodules": { "type": "boolean" }, "oauth-token-id": { "type": "string" }, "tags-regex": { "type": "string" } } }, "vcs-repository": { "type": "string" }, "working-directory": { "type": "string" } } }, "relationships": { "type": "object", "nullable": true, "properties": { "tag-bindings": { "type": "object", "nullable": true, "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "key": { "type": "string" }, "value": { "type": "string" } } } } } } } } } }, "type": { "type": "string" } } } } }, "patch-api-v2-organizations-name-workspaces-workspace_name-response": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "actions": { "type": "object", "properties": { "is-destroyable": { "type": "boolean" } } }, "agent-pool-id": { "nullable": true }, "allow-destroy-plan": { "type": "boolean" }, "assessments-enabled": { "type": "boolean" }, "auto-apply": { "type": "boolean" }, "auto-apply-run-trigger": { "type": "boolean" }, "auto-queue-runs": { "type": "boolean" }, "created-at": { "type": "string", "format": "date-time" }, "description": { "type": "string" }, "environment": { "type": "string" }, "execution-mode": { "type": "string" }, "file-triggers-enabled": { "type": "boolean" }, "force-delete": { "type": "boolean" }, "global-remote-state": { "type": "boolean" }, "latest-change-at": { "type": "string", "format": "date-time" }, "locked": { "type": "boolean" }, "locked-reason": { "nullable": true }, "name": { "type": "string" }, "operations": { "type": "boolean" }, "permissions": { "type": "object", "properties": { "can-destroy": { "type": "boolean" }, "can-force-delete": { "type": "boolean" }, "can-force-unlock": { "type": "boolean" }, "can-lock": { "type": "boolean" }, "can-queue-destroy": { "type": "boolean" }, "can-queue-run": { "type": "boolean" }, "can-read-settings": { "type": "boolean" }, "can-unlock": { "type": "boolean" }, "can-update": { "type": "boolean" }, "can-update-variable": { "type": "boolean" } } }, "queue-all-runs": { "type": "boolean" }, "resource-count": { "type": "integer" }, "run-timeout": { "type": "integer" }, "setting-overwrites": { "type": "object", "properties": { "agent-pool": { "type": "boolean" }, "execution-mode": { "type": "boolean" } } }, "source": { "type": "string" }, "speculative-enabled": { "type": "boolean" }, "structured-run-output-enabled": { "type": "boolean" }, "tag-names": { "type": "array", "items": { "type": "string" } }, "terraform-version": { "type": "string" }, "trigger-patterns": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "trigger-prefixes": { "type": "array", "items": { "type": "string" } }, "updated-at": { "type": "string", "format": "date-time" }, "vcs-repo": { "nullable": true }, "working-directory": { "type": "string" } } }, "id": { "type": "string" }, "relationships": { "type": "object", "properties": { "agent-pool": { "type": "object", "properties": { "data": { "nullable": true } } }, "organization": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } } } } }, "project": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } } } }, "type": { "type": "string" } } } } }, "patch-api-v2-projects-id-relationships-team-access-access_id-request": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "access": { "type": "string", "nullable": true }, "project-access": { "type": "object", "properties": { "settings": { "type": "string", "nullable": true }, "teams": { "type": "string", "nullable": true }, "variable-sets": { "type": "string", "nullable": true } } }, "workspace-access": { "type": "object", "properties": { "create": { "type": "boolean", "nullable": true }, "delete": { "type": "boolean", "nullable": true }, "locking": { "type": "boolean", "nullable": true }, "move": { "type": "boolean", "nullable": true }, "run-tasks": { "type": "boolean", "nullable": true }, "runs": { "type": "string", "nullable": true }, "sentinel-mocks": { "type": "string", "nullable": true }, "state-versions": { "type": "string", "nullable": true }, "variables": { "type": "string", "nullable": true } } } } }, "type": { "type": "string" } }, "required": [ "type" ] } }, "required": [ "data" ] }, "patch-api-v2-projects-id-request": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "default-agent-pool-id": { "type": "string", "nullable": true }, "default-execution-mode": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "setting-overwrites": { "type": "object", "nullable": true, "properties": { "default-agent-pool": { "type": "boolean", "nullable": true }, "default-execution-mode": { "type": "boolean", "nullable": true } } } } }, "relationships": { "type": "object", "nullable": true, "properties": { "tag-bindings": { "type": "object", "nullable": true, "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "key": { "type": "string" }, "value": { "type": "string" } } } } } } } } } }, "type": { "type": "string" } }, "required": [ "type" ] } }, "required": [ "data" ] }, "patch-api-v2-projects-id-tag-bindings-request": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "key": { "type": "string" }, "value": { "type": "string" } } }, "type": { "type": "string" } } } } } }, "patch-api-v2-runners-id-request": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "description": { "type": "string", "nullable": true }, "labels": { "type": "array", "items": { "type": "string" } } } } } } } }, "patch-api-v2-runners-id-response": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "agent-pool-id": { "type": "string", "format": "uuid" }, "agent-pool-name": { "type": "string" }, "agent-version": { "type": "string" }, "ansible-version": { "type": "string" }, "available-collections": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "current-jobs": { "type": "integer" }, "description": { "type": "string" }, "hostname": { "type": "string" }, "ip-address": { "type": "string" }, "labels": { "type": "array", "items": { "type": "string" } }, "last-heartbeat-at": { "type": "string", "format": "date-time" }, "max-concurrent-jobs": { "type": "integer" }, "name": { "type": "string" }, "os-type": { "type": "string" }, "os-version": { "type": "string" }, "registered-at": { "type": "string", "format": "date-time" }, "runner-type": { "type": "string" }, "status": { "type": "string" }, "tofu-version": { "type": "string" } } }, "id": { "type": "string", "format": "uuid" }, "relationships": { "type": "object", "properties": { "agent-pool": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } }, "organization": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } } } }, "type": { "type": "string" } } } } }, "patch-api-v2-task-results-id-callback-request": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "message": { "type": "string" }, "status": { "type": "string" }, "url": { "type": "string" } } }, "type": { "type": "string" } } }, "included": { "type": "array", "items": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "body": { "type": "string" }, "description": { "type": "string" }, "outcome-id": { "type": "string" }, "tags": { "type": "object", "properties": { "Severity": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" } } } }, "Status": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "level": { "type": "string" } } } } } }, "url": { "type": "string" } } }, "type": { "type": "string" } } } } } }, "patch-api-v2-tasks-id-request": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "category": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "enabled": { "type": "boolean", "nullable": true }, "global-configuration": { "type": "object", "nullable": true, "properties": { "enabled": { "type": "boolean", "nullable": true }, "enforcement-level": { "type": "string", "nullable": true }, "stages": { "type": "array", "items": { "type": "string" } } } }, "hmac-key": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "url": { "type": "string", "nullable": true } } }, "type": { "type": "string" } } } } }, "patch-api-v2-tasks-id-response": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "category": { "type": "string" }, "created-at": { "type": "string", "format": "date-time" }, "description": { "type": "string" }, "enabled": { "type": "boolean" }, "global-configuration": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "enforcement-level": { "type": "string" }, "stages": { "type": "array", "items": { "type": "string" } } } }, "name": { "type": "string" }, "updated-at": { "type": "string", "format": "date-time" }, "url": { "type": "string" } } }, "id": { "type": "string" }, "relationships": { "type": "object", "properties": { "organization": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } } } } }, "workspace-tasks": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": true } } } } } }, "type": { "type": "string" } } } } }, "patch-api-v2-team-projects-id-request": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "access": { "type": "string", "nullable": true }, "project-access": { "type": "object", "properties": { "settings": { "type": "string", "nullable": true }, "teams": { "type": "string", "nullable": true }, "variable-sets": { "type": "string", "nullable": true } } }, "workspace-access": { "type": "object", "properties": { "create": { "type": "boolean", "nullable": true }, "delete": { "type": "boolean", "nullable": true }, "locking": { "type": "boolean", "nullable": true }, "move": { "type": "boolean", "nullable": true }, "run-tasks": { "type": "boolean", "nullable": true }, "runs": { "type": "string", "nullable": true }, "sentinel-mocks": { "type": "string", "nullable": true }, "state-versions": { "type": "string", "nullable": true }, "variables": { "type": "string", "nullable": true } } } } }, "type": { "type": "string" } }, "required": [ "type" ] } }, "required": [ "data" ] }, "patch-api-v2-team-workspaces-id-request": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "access": { "type": "string", "nullable": true }, "run-tasks": { "type": "boolean", "nullable": true }, "runs": { "type": "string", "nullable": true }, "sentinel-mocks": { "type": "string", "nullable": true }, "state-versions": { "type": "string", "nullable": true }, "variables": { "type": "string", "nullable": true }, "workspace-locking": { "type": "boolean", "nullable": true } } }, "type": { "type": "string" } }, "required": [ "type" ] } }, "required": [ "data" ] }, "patch-api-v2-teams-id-request": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "allow-member-token-management": { "type": "boolean", "nullable": true }, "description": { "type": "string" }, "name": { "type": "string" }, "organization-access": { "type": "object", "additionalProperties": true }, "sso-team-id": { "type": "string", "nullable": true }, "visibility": { "type": "string" } } }, "type": { "type": "string" } }, "required": [ "type" ] } }, "required": [ "data" ] }, "patch-api-v2-varsets-id-relationships-vars-variable_id-request": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "category": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "hcl": { "type": "boolean", "nullable": true }, "key": { "type": "string", "nullable": true }, "sensitive": { "type": "boolean", "nullable": true }, "value": { "type": "string", "nullable": true } } }, "type": { "type": "string" } }, "required": [ "type" ] } }, "required": [ "data" ] }, "patch-api-v2-varsets-id-request": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "description": { "type": "string", "nullable": true }, "global": { "type": "boolean", "nullable": true }, "name": { "type": "string", "nullable": true }, "priority": { "type": "boolean", "nullable": true } } }, "relationships": { "type": "object", "properties": { "parent": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true } } }, "projects": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": true } } } }, "vars": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": true } } } }, "workspaces": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": true } } } } } }, "type": { "type": "string" } }, "required": [ "type" ] } }, "required": [ "data" ] }, "patch-api-v2-workspaces-id-relationships-team-access-access_id-request": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "access": { "type": "string", "nullable": true }, "run-tasks": { "type": "boolean", "nullable": true }, "runs": { "type": "string", "nullable": true }, "sentinel-mocks": { "type": "string", "nullable": true }, "state-versions": { "type": "string", "nullable": true }, "variables": { "type": "string", "nullable": true }, "workspace-locking": { "type": "boolean", "nullable": true } } }, "type": { "type": "string" } }, "required": [ "type" ] } }, "required": [ "data" ] }, "patch-api-v2-workspaces-id-request": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "agent-pool-id": { "type": "string", "nullable": true }, "allow-destroy-plan": { "type": "boolean", "nullable": true }, "assessments-enabled": { "type": "boolean", "nullable": true }, "auto-apply": { "type": "boolean", "nullable": true }, "auto-apply-run-trigger": { "type": "boolean", "nullable": true }, "auto-queue-runs": { "type": "boolean", "nullable": true }, "description": { "type": "string" }, "execution-mode": { "type": "string" }, "file-triggers-enabled": { "type": "boolean", "nullable": true }, "force-delete": { "type": "boolean", "nullable": true }, "global-remote-state": { "type": "boolean", "nullable": true }, "name": { "type": "string" }, "queue-all-runs": { "type": "boolean", "nullable": true }, "run-timeout": { "type": "integer", "nullable": true }, "speculative-enabled": { "type": "boolean", "nullable": true }, "structured-run-output-enabled": { "type": "boolean", "nullable": true }, "tag-names": { "type": "array", "items": { "type": "string" } }, "terraform-version": { "type": "string" }, "trigger-patterns": { "type": "array", "nullable": true, "items": { "type": "string" } }, "trigger-prefixes": { "type": "array", "nullable": true, "items": { "type": "string" } }, "vcs-branch": { "type": "string" }, "vcs-connection-id": { "nullable": true }, "vcs-provider": { "type": "string" }, "vcs-repo": { "type": "object", "nullable": true, "properties": { "branch": { "type": "string" }, "github-app-installation-id": { "type": "string" }, "identifier": { "type": "string" }, "ingress-submodules": { "type": "boolean" }, "oauth-token-id": { "type": "string" }, "tags-regex": { "type": "string" } } }, "vcs-repository": { "type": "string" }, "working-directory": { "type": "string" } } }, "relationships": { "type": "object", "nullable": true, "properties": { "tag-bindings": { "type": "object", "nullable": true, "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "key": { "type": "string" }, "value": { "type": "string" } } } } } } } } } }, "type": { "type": "string" } } } } }, "patch-api-v2-workspaces-id-response": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "actions": { "type": "object", "properties": { "is-destroyable": { "type": "boolean" } } }, "agent-pool-id": { "nullable": true }, "allow-destroy-plan": { "type": "boolean" }, "assessments-enabled": { "type": "boolean" }, "auto-apply": { "type": "boolean" }, "auto-apply-run-trigger": { "type": "boolean" }, "auto-queue-runs": { "type": "boolean" }, "created-at": { "type": "string", "format": "date-time" }, "description": { "type": "string" }, "environment": { "type": "string" }, "execution-mode": { "type": "string" }, "file-triggers-enabled": { "type": "boolean" }, "force-delete": { "type": "boolean" }, "global-remote-state": { "type": "boolean" }, "latest-change-at": { "type": "string", "format": "date-time" }, "locked": { "type": "boolean" }, "locked-reason": { "nullable": true }, "name": { "type": "string" }, "operations": { "type": "boolean" }, "permissions": { "type": "object", "properties": { "can-destroy": { "type": "boolean" }, "can-force-delete": { "type": "boolean" }, "can-force-unlock": { "type": "boolean" }, "can-lock": { "type": "boolean" }, "can-queue-destroy": { "type": "boolean" }, "can-queue-run": { "type": "boolean" }, "can-read-settings": { "type": "boolean" }, "can-unlock": { "type": "boolean" }, "can-update": { "type": "boolean" }, "can-update-variable": { "type": "boolean" } } }, "queue-all-runs": { "type": "boolean" }, "resource-count": { "type": "integer" }, "run-timeout": { "type": "integer" }, "setting-overwrites": { "type": "object", "properties": { "agent-pool": { "type": "boolean" }, "execution-mode": { "type": "boolean" } } }, "source": { "type": "string" }, "speculative-enabled": { "type": "boolean" }, "structured-run-output-enabled": { "type": "boolean" }, "tag-names": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "terraform-version": { "type": "string" }, "trigger-patterns": { "type": "array", "items": { "type": "string" } }, "trigger-prefixes": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "updated-at": { "type": "string", "format": "date-time" }, "vcs-repo": { "nullable": true }, "working-directory": { "type": "string" } } }, "id": { "type": "string" }, "relationships": { "type": "object", "properties": { "agent-pool": { "type": "object", "properties": { "data": { "nullable": true } } }, "organization": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } } } } }, "project": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } } } }, "type": { "type": "string" } } } } }, "patch-api-v2-workspaces-id-tag-bindings-request": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "key": { "type": "string" }, "value": { "type": "string" } } }, "type": { "type": "string" } } } } } }, "patch-api-v2-workspaces-id-tasks-tid-request": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "enforcement-level": { "type": "string", "nullable": true }, "stage": { "type": "string", "nullable": true }, "stages": { "type": "array", "items": { "type": "string" } } } }, "relationships": { "type": "object", "properties": { "task": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } } } } } } }, "type": { "type": "string" } } } } }, "patch-api-v2-workspaces-id-vars-variable_id-request": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "category": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "hcl": { "type": "boolean", "nullable": true }, "key": { "type": "string", "nullable": true }, "sensitive": { "type": "boolean", "nullable": true }, "value": { "type": "string", "nullable": true } } }, "id": { "type": "string" }, "type": { "type": "string" } } } } }, "patch-auth-sessions-id-a0576c": { "type": "object", "properties": { "details": { "type": "object", "properties": { "changeDate": { "type": "string", "format": "date-time" }, "resourceOwner": { "type": "string" }, "sequence": { "type": "string" } } }, "sessionToken": { "type": "string" } } }, "patch-auth-sessions-id-request": { "type": "object", "properties": { "checks": { "type": "object", "properties": { "password": { "type": "object", "properties": { "password": { "type": "string" } } } } } } }, "plans-response": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "execution-details": { "type": "object", "properties": { "mode": { "type": "string" } } }, "generated-configuration": { "type": "boolean" }, "has-changes": { "type": "boolean" }, "log-read-url": { "type": "string" }, "resource-additions": { "type": "integer" }, "resource-changes": { "type": "integer" }, "resource-destructions": { "type": "integer" }, "resource-imports": { "type": "integer" }, "status": { "type": "string" }, "status-timestamps": { "type": "object", "properties": { "pending-at": { "type": "string", "format": "date-time" }, "queued-at": { "type": "string", "format": "date-time" } } } } }, "id": { "type": "string" }, "links": { "type": "object", "properties": { "json-output": { "type": "string" }, "self": { "type": "string" } } }, "relationships": { "type": "object", "properties": { "state-versions": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": true } } } } } }, "type": { "type": "string" } } } } }, "platform-settings-response": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "organization-creation": { "type": "string" } } }, "id": { "type": "string" }, "type": { "type": "string" } } } } }, "post-api-registry-registry-v2-gpg-keys-request": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "ascii-armor": { "type": "string" }, "namespace": { "type": "string" } } }, "type": { "type": "string" } } } } }, "post-api-v2-admin-terraform-versions-request": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "archs": { "type": "array", "items": { "type": "object", "properties": { "arch": { "type": "string" }, "os": { "type": "string" }, "sha": { "type": "string" }, "url": { "type": "string" } } } }, "beta": { "type": "boolean", "nullable": true }, "deprecated": { "type": "boolean", "nullable": true }, "deprecated-reason": { "type": "string", "nullable": true }, "enabled": { "type": "boolean", "nullable": true }, "official": { "type": "boolean", "nullable": true }, "sha": { "type": "string" }, "url": { "type": "string" }, "version": { "type": "string" } } }, "type": { "type": "string" } } } } }, "post-api-v2-agent-pools-id-authentication-tokens-request": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "description": { "type": "string" } } }, "type": { "type": "string" } } } } }, "post-api-v2-ansible-inventories-id-actions-run-command-request": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "agent-pool-id": { "type": "string" }, "become-enabled": { "type": "boolean" }, "credential-id": { "type": "string" }, "extra-vars": { "type": "object", "additionalProperties": true }, "forks": { "type": "integer" }, "limit": { "type": "string" }, "module": { "type": "string" }, "module-args": { "type": "string" }, "project-id": { "type": "string" }, "verbosity": { "type": "integer" } }, "required": [ "module" ] } } } } }, "post-api-v2-ansible-inventories-id-actions-run-command-response": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "ansible-version": { "type": "string" }, "become-enabled": { "type": "boolean" }, "created-at": { "type": "string", "format": "date-time" }, "diff-mode": { "type": "boolean" }, "error-message": { "type": "string" }, "exit-code": { "nullable": true }, "extra-vars": { "type": "object", "additionalProperties": true }, "finished-at": { "nullable": true }, "forks": { "type": "integer" }, "has-warnings": { "type": "boolean" }, "hosts-changed": { "type": "integer" }, "hosts-failed": { "type": "integer" }, "hosts-ignored": { "type": "integer" }, "hosts-ok": { "type": "integer" }, "hosts-rescued": { "type": "integer" }, "hosts-skipped": { "type": "integer" }, "hosts-total": { "type": "integer" }, "hosts-unreachable": { "type": "integer" }, "inventory-sync-warnings": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "job-type": { "type": "string" }, "limit": { "type": "string" }, "module": { "type": "string" }, "module-args": { "type": "string" }, "name": { "type": "string" }, "playbook-name": { "type": "string" }, "runner-id": { "nullable": true }, "skip-tags": { "type": "string" }, "slice-count": { "type": "integer" }, "slice-group-id": { "nullable": true }, "slice-number": { "type": "integer" }, "started-at": { "nullable": true }, "status": { "type": "string" }, "tags": { "type": "string" }, "updated-at": { "type": "string", "format": "date-time" }, "verbosity": { "type": "integer" }, "warnings-count": { "type": "integer" } } }, "id": { "type": "string", "format": "uuid" }, "relationships": { "type": "object", "properties": { "created-by": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } }, "inventory": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } }, "project": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } } } }, "type": { "type": "string" } } } } }, "post-api-v2-ansible-inventories-id-groups-request": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "description": { "type": "string" }, "name": { "type": "string" }, "variables": { "type": "object", "additionalProperties": true } }, "required": [ "name" ] }, "relationships": { "type": "object", "properties": { "parent": { "type": "object", "properties": { "data": { "type": "object", "nullable": true, "properties": { "id": { "type": "string" }, "type": { "type": "string" } } } } } } }, "type": { "type": "string" } } } } }, "post-api-v2-ansible-inventories-id-hosts-request": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "description": { "type": "string" }, "enabled": { "type": "boolean", "nullable": true }, "hostname": { "type": "string" }, "name": { "type": "string" }, "port": { "type": "integer" }, "variables": { "type": "object", "additionalProperties": true } }, "required": [ "name" ] }, "type": { "type": "string" } } } } }, "post-api-v2-ansible-inventories-id-sources-request": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "config": { "type": "object", "additionalProperties": true }, "credential-id": { "type": "string", "nullable": true }, "description": { "type": "string" }, "enabled": { "type": "boolean", "nullable": true }, "group-by-availability-zone": { "type": "boolean", "nullable": true }, "group-by-instance-id": { "type": "boolean", "nullable": true }, "group-by-region": { "type": "boolean", "nullable": true }, "group-by-tag": { "type": "string" }, "hostname-var": { "type": "string" }, "instance-filters": { "type": "string" }, "name": { "type": "string" }, "overwrite": { "type": "boolean", "nullable": true }, "overwrite-vars": { "type": "boolean", "nullable": true }, "source-type": { "type": "string" }, "sync-schedule": { "type": "string" }, "update-cache-timeout": { "type": "integer", "nullable": true }, "update-on-launch": { "type": "boolean", "nullable": true }, "verbosity": { "type": "integer", "nullable": true } }, "required": [ "name", "source-type" ] }, "type": { "type": "string" } } } } }, "post-api-v2-ansible-job-templates-id-callback-request": { "type": "object", "properties": { "host_config_key": { "type": "string" } } }, "post-api-v2-ansible-job-templates-id-credentials-request": { "type": "object", "properties": { "data": { "type": "object", "nullable": true, "properties": { "id": { "type": "string" }, "type": { "type": "string" } }, "required": [ "id" ] } }, "required": [ "data" ] }, "post-api-v2-ansible-job-templates-id-launch-request": { "type": "object", "properties": { "data": { "type": "object", "nullable": true, "properties": { "attributes": { "type": "object", "properties": { "extra-vars": { "type": "object", "additionalProperties": true }, "limit": { "type": "string", "nullable": true }, "skip-tags": { "type": "string", "nullable": true }, "tags": { "type": "string", "nullable": true } } }, "type": { "type": "string" } } } } }, "post-api-v2-ansible-job-templates-id-launch-response": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "ansible-version": { "type": "string" }, "become-enabled": { "type": "boolean" }, "created-at": { "type": "string", "format": "date-time" }, "diff-mode": { "type": "boolean" }, "error-message": { "type": "string" }, "exit-code": { "nullable": true }, "extra-vars": { "type": "object", "properties": { "release": { "type": "string" }, "stackweaver_inventory_id": { "type": "string", "format": "uuid" }, "stackweaver_job_template_id": { "type": "string", "format": "uuid" }, "stackweaver_playbook_id": { "type": "string", "format": "uuid" }, "stackweaver_project_id": { "type": "string", "format": "uuid" } } }, "finished-at": { "nullable": true }, "forks": { "type": "integer" }, "has-warnings": { "type": "boolean" }, "hosts-changed": { "type": "integer" }, "hosts-failed": { "type": "integer" }, "hosts-ignored": { "type": "integer" }, "hosts-ok": { "type": "integer" }, "hosts-rescued": { "type": "integer" }, "hosts-skipped": { "type": "integer" }, "hosts-total": { "type": "integer" }, "hosts-unreachable": { "type": "integer" }, "inventory-sync-warnings": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "job-type": { "type": "string" }, "limit": { "type": "string" }, "name": { "type": "string" }, "playbook-name": { "type": "string" }, "runner-id": { "nullable": true }, "skip-tags": { "type": "string" }, "slice-count": { "type": "integer" }, "slice-group-id": { "nullable": true }, "slice-number": { "type": "integer" }, "started-at": { "nullable": true }, "status": { "type": "string" }, "tags": { "type": "string" }, "updated-at": { "type": "string", "format": "date-time" }, "verbosity": { "type": "integer" }, "warnings-count": { "type": "integer" } } }, "id": { "type": "string", "format": "uuid" }, "relationships": { "type": "object", "properties": { "created-by": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } }, "inventory": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } }, "playbook": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } }, "project": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } }, "template": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } } } }, "type": { "type": "string" } } } } }, "post-api-v2-ansible-job-templates-id-vars-request": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "category": { "type": "string" }, "description": { "type": "string" }, "hcl": { "type": "boolean" }, "key": { "type": "string" }, "sensitive": { "type": "boolean" }, "value": { "type": "string" } }, "required": [ "key", "value" ] }, "type": { "type": "string" } } } } }, "post-api-v2-ansible-jobs-id-actions-cancel-response": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "ansible-version": { "type": "string" }, "become-enabled": { "type": "boolean" }, "created-at": { "type": "string", "format": "date-time" }, "diff-mode": { "type": "boolean" }, "error-message": { "type": "string" }, "exit-code": { "nullable": true }, "extra-vars": { "type": "object", "properties": { "stackweaver_inventory_id": { "type": "string", "format": "uuid" }, "stackweaver_job_template_id": { "type": "string", "format": "uuid" }, "stackweaver_playbook_id": { "type": "string", "format": "uuid" }, "stackweaver_project_id": { "type": "string", "format": "uuid" } } }, "finished-at": { "type": "string", "format": "date-time" }, "forks": { "type": "integer" }, "has-warnings": { "type": "boolean" }, "hosts-changed": { "type": "integer" }, "hosts-failed": { "type": "integer" }, "hosts-ignored": { "type": "integer" }, "hosts-ok": { "type": "integer" }, "hosts-rescued": { "type": "integer" }, "hosts-skipped": { "type": "integer" }, "hosts-total": { "type": "integer" }, "hosts-unreachable": { "type": "integer" }, "inventory-sync-warnings": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "job-type": { "type": "string" }, "limit": { "type": "string" }, "name": { "type": "string" }, "playbook-name": { "type": "string" }, "runner-id": { "nullable": true }, "skip-tags": { "type": "string" }, "slice-count": { "type": "integer" }, "slice-group-id": { "nullable": true }, "slice-number": { "type": "integer" }, "started-at": { "nullable": true }, "status": { "type": "string" }, "tags": { "type": "string" }, "updated-at": { "type": "string", "format": "date-time" }, "verbosity": { "type": "integer" }, "warnings-count": { "type": "integer" } } }, "id": { "type": "string", "format": "uuid" }, "relationships": { "type": "object", "properties": { "created-by": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } }, "inventory": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } }, "playbook": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } }, "project": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } }, "template": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } } } }, "type": { "type": "string" } } } } }, "post-api-v2-ansible-jobs-id-actions-relaunch-response": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "ansible-version": { "type": "string" }, "become-enabled": { "type": "boolean" }, "created-at": { "type": "string", "format": "date-time" }, "diff-mode": { "type": "boolean" }, "error-message": { "type": "string" }, "exit-code": { "nullable": true }, "extra-vars": { "type": "object", "properties": { "stackweaver_inventory_id": { "type": "string", "format": "uuid" }, "stackweaver_job_template_id": { "type": "string", "format": "uuid" }, "stackweaver_playbook_id": { "type": "string", "format": "uuid" }, "stackweaver_project_id": { "type": "string", "format": "uuid" } } }, "finished-at": { "nullable": true }, "forks": { "type": "integer" }, "has-warnings": { "type": "boolean" }, "hosts-changed": { "type": "integer" }, "hosts-failed": { "type": "integer" }, "hosts-ignored": { "type": "integer" }, "hosts-ok": { "type": "integer" }, "hosts-rescued": { "type": "integer" }, "hosts-skipped": { "type": "integer" }, "hosts-total": { "type": "integer" }, "hosts-unreachable": { "type": "integer" }, "inventory-sync-warnings": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "job-type": { "type": "string" }, "limit": { "type": "string" }, "name": { "type": "string" }, "playbook-name": { "type": "string" }, "runner-id": { "nullable": true }, "skip-tags": { "type": "string" }, "slice-count": { "type": "integer" }, "slice-group-id": { "nullable": true }, "slice-number": { "type": "integer" }, "started-at": { "nullable": true }, "status": { "type": "string" }, "tags": { "type": "string" }, "updated-at": { "type": "string", "format": "date-time" }, "verbosity": { "type": "integer" }, "warnings-count": { "type": "integer" } } }, "id": { "type": "string", "format": "uuid" }, "relationships": { "type": "object", "properties": { "created-by": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } }, "inventory": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } }, "playbook": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } }, "project": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } }, "template": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } } } }, "type": { "type": "string" } } } } }, "post-api-v2-ansible-workflows-id-edges-request": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "condition": { "type": "string" } } }, "relationships": { "type": "object", "properties": { "source-node": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" } } } } }, "target-node": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" } } } } } } }, "type": { "type": "string" } } } } }, "post-api-v2-ansible-workflows-id-launch-request": { "type": "object", "properties": { "data": { "type": "object", "nullable": true, "properties": { "attributes": { "type": "object", "properties": { "extra-vars": { "type": "object", "additionalProperties": true } } }, "type": { "type": "string" } } } }, "required": [ "data" ] }, "post-api-v2-ansible-workflows-id-nodes-request": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "all-parents-must-converge": { "type": "boolean" }, "approval-message": { "type": "string" }, "approval-timeout": { "type": "integer" }, "extra-vars": { "type": "string" }, "identifier": { "type": "string" }, "limit": { "type": "string" }, "node-type": { "type": "string" }, "position-x": { "type": "number" }, "position-y": { "type": "number" }, "skip-tags": { "type": "string" }, "tags": { "type": "string" }, "verbosity": { "type": "integer" } } }, "relationships": { "type": "object", "properties": { "credential": { "type": "object", "properties": { "data": { "type": "object", "nullable": true, "properties": { "id": { "type": "string" } } } } }, "inventory": { "type": "object", "properties": { "data": { "type": "object", "nullable": true, "properties": { "id": { "type": "string" } } } } }, "job-template": { "type": "object", "properties": { "data": { "type": "object", "nullable": true, "properties": { "id": { "type": "string" } } } } } } }, "type": { "type": "string" } } } } }, "post-api-v2-authentication-tokens-id-actions-rotate-request": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "grace-period-hours": { "type": "integer", "nullable": true } } } } } } }, "post-api-v2-notification-configurations-id-actions-verify-response": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "created-at": { "type": "string", "format": "date-time" }, "destination-type": { "type": "string" }, "email-addresses": { "type": "array", "items": { "type": "string" } }, "enabled": { "type": "boolean" }, "name": { "type": "string" }, "triggers": { "type": "array", "items": { "type": "string" } }, "updated-at": { "type": "string", "format": "date-time" }, "url": { "type": "string" } } }, "id": { "type": "string" }, "relationships": { "type": "object", "properties": { "subscribable": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } } } } } } }, "type": { "type": "string" } } } } }, "post-api-v2-oauth-authorize-b9fb7c": { "type": "object", "properties": { "code": { "type": "string" }, "state": { "type": "string" } } }, "post-api-v2-oauth-authorize-request": { "type": "object", "properties": { "client_id": { "type": "string" }, "code_challenge": { "type": "string" }, "code_challenge_method": { "type": "string" }, "redirect_uri": { "type": "string" }, "state": { "type": "string" } } }, "post-api-v2-oauth-token-bba1e3": { "type": "object", "properties": { "access_token": { "type": "string" }, "error": { "type": "string" }, "token_type": { "type": "string" } } }, "post-api-v2-oauth-token-request": { "type": "object", "properties": { "client_id": { "type": "string" }, "code": { "type": "string" }, "code_verifier": { "type": "string" }, "grant_type": { "type": "string" }, "redirect_uri": { "type": "string" } } }, "post-api-v2-organizations-name-agent-pools-request": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "name": { "type": "string" }, "organization-scoped": { "type": "boolean", "nullable": true } }, "required": [ "name" ] }, "relationships": { "type": "object", "nullable": true, "properties": { "allowed-projects": { "type": "object", "nullable": true, "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } } } } } }, "allowed-workspaces": { "type": "object", "nullable": true, "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } } } } } }, "excluded-workspaces": { "type": "object", "nullable": true, "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } } } } } } } }, "type": { "type": "string" } }, "required": [ "attributes", "type" ] } }, "required": [ "data" ] }, "post-api-v2-organizations-name-ansible-credentials-request": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "aws-access-key-id": { "type": "string" }, "aws-secret-access-key": { "type": "string" }, "azure-client-id": { "type": "string" }, "azure-client-secret": { "type": "string" }, "azure-tenant-id": { "type": "string" }, "become-password": { "type": "string" }, "credential-type": { "type": "string" }, "description": { "type": "string" }, "gcp-service-account": { "type": "string" }, "name": { "type": "string" }, "password": { "type": "string" }, "ssh-become-user": { "type": "string" }, "ssh-passphrase": { "type": "string" }, "ssh-port": { "type": "integer" }, "ssh-private-key": { "type": "string" }, "username": { "type": "string" }, "vault-password": { "type": "string" } }, "required": [ "credential-type", "name" ] }, "relationships": { "type": "object", "properties": { "project": { "type": "object", "properties": { "data": { "type": "object", "nullable": true, "properties": { "id": { "type": "string" }, "type": { "type": "string" } } } } } } }, "type": { "type": "string" } } } } }, "post-api-v2-organizations-name-ansible-inventories-request": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "constructed-cache-timeout": { "type": "integer" }, "constructed-limit": { "type": "string" }, "description": { "type": "string" }, "input-inventory-ids": { "type": "array", "items": { "type": "string" } }, "inventory-type": { "type": "string" }, "inventory_path": { "type": "string" }, "name": { "type": "string" }, "source": { "type": "string" }, "source-vars": { "type": "string" }, "variables": { "type": "object", "additionalProperties": true }, "vcs_branch": { "type": "string" }, "vcs_repository": { "type": "string" } }, "required": [ "name" ] }, "relationships": { "type": "object", "properties": { "project": { "type": "object", "properties": { "data": { "type": "object", "nullable": true, "properties": { "id": { "type": "string" }, "type": { "type": "string" } } } } }, "vcs_connection": { "type": "object", "properties": { "data": { "type": "object", "nullable": true, "properties": { "id": { "type": "string" }, "type": { "type": "string" } } } } } } }, "type": { "type": "string" } } } } }, "post-api-v2-organizations-name-ansible-job-templates-request": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "allow-simultaneous": { "type": "boolean" }, "become-enabled": { "type": "boolean" }, "description": { "type": "string" }, "diff-mode": { "type": "boolean" }, "enabled": { "type": "boolean", "nullable": true }, "extra-vars": { "type": "object", "additionalProperties": true }, "forks": { "type": "integer" }, "job-slice-count": { "type": "integer" }, "limit": { "type": "string" }, "name": { "type": "string" }, "retention-days": { "type": "integer", "nullable": true }, "schedule-cron": { "type": "string" }, "schedule-enabled": { "type": "boolean" }, "skip-tags": { "type": "string" }, "tags": { "type": "string" }, "timeout-seconds": { "type": "integer" }, "verbosity": { "type": "integer" } } }, "relationships": { "type": "object", "properties": { "agent-pool": { "type": "object", "properties": { "data": { "type": "object", "nullable": true, "properties": { "id": { "type": "string" }, "type": { "type": "string" } } } } }, "credentials": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } } } } } }, "inventory": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } } } } }, "playbook": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } } } } }, "project": { "type": "object", "properties": { "data": { "type": "object", "nullable": true, "properties": { "id": { "type": "string" }, "type": { "type": "string" } } } } } } }, "type": { "type": "string" } } } } }, "post-api-v2-organizations-name-ansible-jobs-request": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "ansible-version": { "type": "string" }, "become-enabled": { "type": "boolean" }, "diff-mode": { "type": "boolean" }, "extra-vars": { "type": "object", "additionalProperties": true }, "forks": { "type": "integer" }, "job-type": { "type": "string" }, "limit": { "type": "string" }, "name": { "type": "string" }, "skip-tags": { "type": "string" }, "tags": { "type": "string" }, "verbosity": { "type": "integer" } } }, "relationships": { "type": "object", "properties": { "credentials": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } } } } } }, "inventory": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } } } } }, "playbook": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } } } } }, "project": { "type": "object", "properties": { "data": { "type": "object", "nullable": true, "properties": { "id": { "type": "string" }, "type": { "type": "string" } } } } } } }, "type": { "type": "string" } } } } }, "post-api-v2-organizations-name-ansible-jobs-response": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "ansible-version": { "type": "string" }, "become-enabled": { "type": "boolean" }, "created-at": { "type": "string", "format": "date-time" }, "diff-mode": { "type": "boolean" }, "error-message": { "type": "string" }, "exit-code": { "nullable": true }, "extra-vars": { "type": "object", "properties": { "release": { "type": "string" }, "stackweaver_inventory_id": { "type": "string", "format": "uuid" }, "stackweaver_playbook_id": { "type": "string", "format": "uuid" }, "stackweaver_project_id": { "type": "string", "format": "uuid" } } }, "finished-at": { "nullable": true }, "forks": { "type": "integer" }, "has-warnings": { "type": "boolean" }, "hosts-changed": { "type": "integer" }, "hosts-failed": { "type": "integer" }, "hosts-ignored": { "type": "integer" }, "hosts-ok": { "type": "integer" }, "hosts-rescued": { "type": "integer" }, "hosts-skipped": { "type": "integer" }, "hosts-total": { "type": "integer" }, "hosts-unreachable": { "type": "integer" }, "inventory-sync-warnings": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "job-type": { "type": "string" }, "limit": { "type": "string" }, "name": { "type": "string" }, "playbook-name": { "type": "string" }, "runner-id": { "nullable": true }, "skip-tags": { "type": "string" }, "slice-count": { "type": "integer" }, "slice-group-id": { "nullable": true }, "slice-number": { "type": "integer" }, "started-at": { "nullable": true }, "status": { "type": "string" }, "tags": { "type": "string" }, "updated-at": { "type": "string", "format": "date-time" }, "verbosity": { "type": "integer" }, "warnings-count": { "type": "integer" } } }, "id": { "type": "string", "format": "uuid" }, "relationships": { "type": "object", "properties": { "created-by": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } }, "inventory": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } }, "playbook": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } }, "project": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } } } }, "type": { "type": "string" } } } } }, "post-api-v2-organizations-name-ansible-notification-attachments-request": { "type": "object", "properties": { "data": { "type": "object", "nullable": true, "properties": { "attributes": { "type": "object", "properties": { "on-failure": { "type": "boolean", "nullable": true }, "on-started": { "type": "boolean" }, "on-success": { "type": "boolean", "nullable": true } } }, "relationships": { "type": "object", "properties": { "job-template": { "type": "object", "nullable": true, "properties": { "data": { "type": "object", "nullable": true, "properties": { "id": { "type": "string" }, "type": { "type": "string" } } }, "links": {} } }, "notification-template": { "type": "object", "nullable": true, "properties": { "data": { "type": "object", "nullable": true, "properties": { "id": { "type": "string" }, "type": { "type": "string" } } }, "links": {} } }, "workflow": { "type": "object", "nullable": true, "properties": { "data": { "type": "object", "nullable": true, "properties": { "id": { "type": "string" }, "type": { "type": "string" } } }, "links": {} } } } }, "type": { "type": "string" } } } }, "required": [ "data" ] }, "post-api-v2-organizations-name-ansible-notification-templates-request": { "type": "object", "properties": { "data": { "type": "object", "nullable": true, "properties": { "attributes": { "type": "object", "properties": { "config": { "type": "object", "additionalProperties": true }, "description": { "type": "string" }, "name": { "type": "string" }, "notification-type": { "type": "string" }, "secret": { "type": "string", "nullable": true } } }, "type": { "type": "string" } } } }, "required": [ "data" ] }, "post-api-v2-organizations-name-ansible-playbooks-actions-bulk-import-request": { "type": "object", "properties": { "data": { "type": "object", "nullable": true, "properties": { "attributes": { "type": "object", "properties": { "branch": { "type": "string" }, "playbooks": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "path": { "type": "string" } } } }, "project-id": { "type": "string" }, "repository": { "type": "string" }, "source-mode": { "type": "string" }, "vcs-connection-id": { "type": "string" } } }, "type": { "type": "string" } } } }, "required": [ "data" ] }, "post-api-v2-organizations-name-ansible-playbooks-actions-find-or-create-request": { "type": "object", "properties": { "data": { "type": "object", "nullable": true, "properties": { "attributes": { "type": "object", "properties": { "branch": { "type": "string" }, "name": { "type": "string" }, "path": { "type": "string" }, "project-id": { "type": "string" }, "repository": { "type": "string" }, "source-mode": { "type": "string" }, "vcs-connection-id": { "type": "string" } } }, "type": { "type": "string" } } } }, "required": [ "data" ] }, "post-api-v2-organizations-name-ansible-playbooks-request": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "description": { "type": "string" }, "name": { "type": "string" }, "playbook-path": { "type": "string" }, "source-mode": { "type": "string" }, "vcs-branch": { "type": "string" }, "vcs-repository": { "type": "string" } } }, "relationships": { "type": "object", "properties": { "project": { "type": "object", "properties": { "data": { "type": "object", "nullable": true, "properties": { "id": { "type": "string" }, "type": { "type": "string" } } } } }, "vcs-connection": { "type": "object", "properties": { "data": { "type": "object", "nullable": true, "properties": { "id": { "type": "string" }, "type": { "type": "string" } } } } } } }, "type": { "type": "string" } } } } }, "post-api-v2-organizations-name-ansible-schedules-request": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "config": { "type": "object", "additionalProperties": true }, "cron-expression": { "type": "string" }, "description": { "type": "string" }, "end-date-time": { "type": "string" }, "inventory-source-id": { "type": "string" }, "job-template-id": { "type": "string" }, "name": { "type": "string" }, "playbook-id": { "type": "string" }, "schedule-type": { "type": "string" }, "start-date-time": { "type": "string" }, "timezone": { "type": "string" }, "workflow-id": { "type": "string" } }, "required": [ "cron-expression", "name", "schedule-type", "timezone" ] }, "type": { "type": "string" } }, "required": [ "attributes", "type" ] } }, "required": [ "data" ] }, "post-api-v2-organizations-name-ansible-workflows-request": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "allow-simultaneous": { "type": "boolean" }, "ask-inventory-on-launch": { "type": "boolean" }, "ask-limit-on-launch": { "type": "boolean" }, "ask-variables-on-launch": { "type": "boolean" }, "description": { "type": "string" }, "extra-vars": { "type": "string" }, "limit": { "type": "string" }, "name": { "type": "string" }, "survey-enabled": { "type": "boolean" } } }, "relationships": { "type": "object", "properties": { "inventory": { "type": "object", "properties": { "data": { "type": "object", "nullable": true, "properties": { "id": { "type": "string" } } } } }, "project": { "type": "object", "properties": { "data": { "type": "object", "nullable": true, "properties": { "id": { "type": "string" } } } } } } }, "type": { "type": "string" } } } } }, "post-api-v2-organizations-name-authentication-token-request": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "expired-at": { "type": "string", "format": "date-time", "nullable": true } } }, "type": { "type": "string" } } } } }, "post-api-v2-organizations-name-explorer-bulk-actions-request": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "action_inputs": { "type": "object", "properties": { "message": { "type": "string" }, "subject": { "type": "string" } } }, "action_type": { "type": "string" }, "query": { "type": "object", "additionalProperties": true }, "target_ids": { "type": "array", "items": { "type": "string" } } } }, "type": { "type": "string" } } } } }, "post-api-v2-organizations-name-oidc-configurations-request": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "project-number": { "type": "string" }, "service-account-email": { "type": "string" }, "workload-provider-name": { "type": "string" } } }, "type": { "type": "string" } }, "required": [ "attributes", "type" ] } }, "required": [ "data" ] }, "post-api-v2-organizations-name-organization-memberships-request": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "email": { "type": "string" } }, "required": [ "email" ] }, "relationships": { "type": "object", "properties": { "teams": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } } } } } } } }, "type": { "type": "string" } }, "required": [ "type" ] } }, "required": [ "data" ] }, "post-api-v2-organizations-name-projects-request": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "description": { "type": "string" }, "name": { "type": "string" } }, "required": [ "name" ] }, "relationships": { "type": "object", "nullable": true, "properties": { "tag-bindings": { "type": "object", "nullable": true, "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "key": { "type": "string" }, "value": { "type": "string" } } } } } } } } } }, "type": { "type": "string" } }, "required": [ "attributes", "type" ] } }, "required": [ "data" ] }, "post-api-v2-organizations-name-registry-modules-module_name-provider-versions-request": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" }, "version": { "type": "string" } } }, "post-api-v2-organizations-name-registry-modules-request": { "type": "object", "properties": { "data": { "type": "object", "nullable": true, "properties": { "attributes": { "type": "object", "properties": { "auto_publish_tags": { "type": "boolean", "nullable": true }, "description": { "type": "string" }, "name": { "type": "string" }, "provider": { "type": "string" }, "vcs_connection_id": { "nullable": true }, "vcs_repository": { "type": "string" } }, "required": [ "name", "provider" ] }, "type": { "type": "string" } } } }, "required": [ "data" ] }, "post-api-v2-organizations-name-registry-providers-registry_name-namespace-provider_name-versions-version-platforms-request": { "type": "object", "properties": { "arch": { "type": "string" }, "file": { "type": "string", "format": "binary" }, "key_id": { "type": "string" }, "os": { "type": "string" }, "protocols": { "type": "string" }, "shasums": { "type": "string", "format": "binary" }, "shasums_sig": { "type": "string", "format": "binary" } } }, "post-api-v2-organizations-name-registry-providers-request": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "name": { "type": "string" }, "namespace": { "type": "string" }, "registry-name": { "type": "string" } } }, "type": { "type": "string" } } } } }, "post-api-v2-organizations-name-tasks-request": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "category": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "enabled": { "type": "boolean", "nullable": true }, "global-configuration": { "type": "object", "nullable": true, "properties": { "enabled": { "type": "boolean", "nullable": true }, "enforcement-level": { "type": "string", "nullable": true }, "stages": { "type": "array", "items": { "type": "string" } } } }, "hmac-key": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "url": { "type": "string", "nullable": true } } }, "type": { "type": "string" } } } } }, "post-api-v2-organizations-name-tasks-response": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "category": { "type": "string" }, "created-at": { "type": "string", "format": "date-time" }, "description": { "type": "string" }, "enabled": { "type": "boolean" }, "global-configuration": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "enforcement-level": { "type": "string" }, "stages": { "type": "array", "items": { "type": "string" } } } }, "name": { "type": "string" }, "updated-at": { "type": "string", "format": "date-time" }, "url": { "type": "string" } } }, "id": { "type": "string" }, "relationships": { "type": "object", "properties": { "organization": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } } } } }, "workspace-tasks": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": true } } } } } }, "type": { "type": "string" } } } } }, "post-api-v2-organizations-name-teams-request": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "allow-member-token-management": { "type": "boolean", "nullable": true }, "description": { "type": "string" }, "name": { "type": "string" }, "organization-access": { "type": "object", "additionalProperties": true }, "sso-team-id": { "type": "string", "nullable": true }, "visibility": { "type": "string" } }, "required": [ "name" ] }, "relationships": { "type": "object", "properties": { "organization": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } } } } } } }, "type": { "type": "string" } }, "required": [ "attributes", "type" ] } }, "required": [ "data" ] }, "post-api-v2-organizations-name-varsets-id-relationships-projects-request": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } } } } } }, "post-api-v2-organizations-name-varsets-id-relationships-vars-request": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "category": { "type": "string" }, "description": { "type": "string" }, "hcl": { "type": "boolean" }, "key": { "type": "string" }, "sensitive": { "type": "boolean" }, "value": { "type": "string" } }, "required": [ "key" ] }, "type": { "type": "string" } }, "required": [ "attributes", "type" ] } }, "required": [ "data" ] }, "post-api-v2-organizations-name-varsets-id-relationships-workspaces-request": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } } } } } }, "post-api-v2-organizations-name-varsets-request": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "description": { "type": "string" }, "global": { "type": "boolean" }, "name": { "type": "string" }, "priority": { "type": "boolean" } }, "required": [ "name" ] }, "relationships": { "type": "object", "properties": { "parent": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true } } }, "projects": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": true } } } }, "vars": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": true } } } }, "workspaces": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": true } } } } } }, "type": { "type": "string" } }, "required": [ "attributes", "type" ] } }, "required": [ "data" ] }, "post-api-v2-organizations-name-vcs-connections-request": { "type": "object", "properties": { "data": { "type": "object", "nullable": true, "properties": { "attributes": { "type": "object", "properties": { "access_token": { "type": "string" }, "account_name": { "type": "string" }, "account_type": { "type": "string" }, "provider": { "type": "string" }, "refresh_token": { "type": "string" }, "token_expires_at": { "type": "string" } }, "required": [ "access_token", "account_name", "account_type", "provider" ] }, "type": { "type": "string" } } } }, "required": [ "data" ] }, "post-api-v2-organizations-name-workspaces-request": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "agent-pool-id": { "type": "string", "nullable": true }, "allow-destroy-plan": { "type": "boolean", "nullable": true }, "assessments-enabled": { "type": "boolean", "nullable": true }, "auto-apply": { "type": "boolean", "nullable": true }, "auto-apply-run-trigger": { "type": "boolean", "nullable": true }, "auto-queue-runs": { "type": "boolean", "nullable": true }, "description": { "type": "string" }, "execution-mode": { "type": "string" }, "file-triggers-enabled": { "type": "boolean", "nullable": true }, "force-delete": { "type": "boolean", "nullable": true }, "global-remote-state": { "type": "boolean", "nullable": true }, "name": { "type": "string" }, "project-id": { "nullable": true }, "queue-all-runs": { "type": "boolean", "nullable": true }, "run-timeout": { "type": "integer", "nullable": true }, "source-name": { "type": "string" }, "source-url": { "type": "string" }, "speculative-enabled": { "type": "boolean", "nullable": true }, "structured-run-output-enabled": { "type": "boolean", "nullable": true }, "tag-names": { "type": "array", "items": { "type": "string" } }, "terraform-version": { "type": "string" }, "trigger-patterns": { "type": "array", "nullable": true, "items": { "type": "string" } }, "trigger-prefixes": { "type": "array", "nullable": true, "items": { "type": "string" } }, "vcs-branch": { "type": "string" }, "vcs-connection-id": { "nullable": true }, "vcs-repo": { "type": "object", "nullable": true, "properties": { "branch": { "type": "string" }, "github-app-installation-id": { "type": "string" }, "identifier": { "type": "string" }, "ingress-submodules": { "type": "boolean" }, "oauth-token-id": { "type": "string" }, "tags-regex": { "type": "string" } } }, "vcs-repository": { "type": "string" }, "working-directory": { "type": "string" } } }, "relationships": { "type": "object", "properties": { "project": { "type": "object", "nullable": true, "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } } } } }, "tag-bindings": { "type": "object", "nullable": true, "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "key": { "type": "string" }, "value": { "type": "string" } } } } } } } } } }, "type": { "type": "string" } } } } }, "post-api-v2-organizations-name-workspaces-response": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "actions": { "type": "object", "properties": { "is-destroyable": { "type": "boolean" } } }, "agent-pool-id": { "nullable": true }, "allow-destroy-plan": { "type": "boolean" }, "assessments-enabled": { "type": "boolean" }, "auto-apply": { "type": "boolean" }, "auto-apply-run-trigger": { "type": "boolean" }, "auto-queue-runs": { "type": "boolean" }, "created-at": { "type": "string", "format": "date-time" }, "description": { "type": "string" }, "environment": { "type": "string" }, "execution-mode": { "type": "string" }, "file-triggers-enabled": { "type": "boolean" }, "force-delete": { "type": "boolean" }, "global-remote-state": { "type": "boolean" }, "latest-change-at": { "type": "string", "format": "date-time" }, "locked": { "type": "boolean" }, "locked-reason": { "nullable": true }, "name": { "type": "string" }, "operations": { "type": "boolean" }, "permissions": { "type": "object", "properties": { "can-destroy": { "type": "boolean" }, "can-force-delete": { "type": "boolean" }, "can-force-unlock": { "type": "boolean" }, "can-lock": { "type": "boolean" }, "can-queue-destroy": { "type": "boolean" }, "can-queue-run": { "type": "boolean" }, "can-read-settings": { "type": "boolean" }, "can-unlock": { "type": "boolean" }, "can-update": { "type": "boolean" }, "can-update-variable": { "type": "boolean" } } }, "queue-all-runs": { "type": "boolean" }, "resource-count": { "type": "integer" }, "run-timeout": { "type": "integer" }, "setting-overwrites": { "type": "object", "properties": { "agent-pool": { "type": "boolean" }, "execution-mode": { "type": "boolean" } } }, "source": { "type": "string" }, "speculative-enabled": { "type": "boolean" }, "structured-run-output-enabled": { "type": "boolean" }, "tag-names": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "terraform-version": { "type": "string" }, "trigger-patterns": { "type": "array", "items": { "type": "string" } }, "trigger-prefixes": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "updated-at": { "type": "string", "format": "date-time" }, "vcs-repo": { "nullable": true }, "working-directory": { "type": "string" } } }, "id": { "type": "string" }, "relationships": { "type": "object", "properties": { "agent-pool": { "type": "object", "properties": { "data": { "nullable": true } } }, "organization": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } } } } }, "project": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } } } }, "type": { "type": "string" } } } } }, "post-api-v2-organizations-request": { "type": "object", "properties": { "data": { "type": "object", "nullable": true, "properties": { "attributes": { "type": "object", "properties": { "aggregated-commit-status-enabled": { "type": "boolean", "nullable": true }, "allow-force-delete-workspaces": { "type": "boolean", "nullable": true }, "ansible-adhoc-modules": { "type": "string", "nullable": true }, "ansible-job-retention-days": { "type": "integer", "nullable": true }, "assessments-enforced": { "type": "boolean", "nullable": true }, "collaborator-auth-policy": { "type": "string" }, "cost-estimation-enabled": { "type": "boolean", "nullable": true }, "default-execution-mode": { "type": "string", "nullable": true }, "default-terraform-version": { "type": "string", "nullable": true }, "description": { "type": "string" }, "email": { "type": "string" }, "name": { "type": "string" }, "send-passing-statuses-for-untriggered-speculative-plans": { "type": "boolean", "nullable": true }, "speculative-plan-management-enabled": { "type": "boolean", "nullable": true }, "user-tokens-enabled": { "type": "boolean", "nullable": true } } }, "type": { "type": "string" } } } }, "required": [ "data" ] }, "post-api-v2-projects-id-notification-configurations-request": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "destination-type": { "type": "string", "nullable": true }, "email-addresses": { "type": "array", "items": { "type": "string" } }, "enabled": { "type": "boolean", "nullable": true }, "name": { "type": "string", "nullable": true }, "token": { "type": "string", "nullable": true }, "triggers": { "type": "array", "items": { "type": "string" } }, "url": { "type": "string", "nullable": true } } }, "type": { "type": "string" } } } } }, "post-api-v2-projects-id-relationships-team-access-request": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "access": { "type": "string", "nullable": true }, "project-access": { "type": "object", "properties": { "settings": { "type": "string", "nullable": true }, "teams": { "type": "string", "nullable": true }, "variable-sets": { "type": "string", "nullable": true } } }, "workspace-access": { "type": "object", "properties": { "create": { "type": "boolean", "nullable": true }, "delete": { "type": "boolean", "nullable": true }, "locking": { "type": "boolean", "nullable": true }, "move": { "type": "boolean", "nullable": true }, "run-tasks": { "type": "boolean", "nullable": true }, "runs": { "type": "string", "nullable": true }, "sentinel-mocks": { "type": "string", "nullable": true }, "state-versions": { "type": "string", "nullable": true }, "variables": { "type": "string", "nullable": true } } } } }, "relationships": { "type": "object", "properties": { "project": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } } } } }, "team": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } } } } } } }, "type": { "type": "string" } }, "required": [ "type" ] } }, "required": [ "data" ] }, "post-api-v2-runner-deregister-491424": { "type": "object", "properties": { "status": { "type": "string" } } }, "post-api-v2-runner-deregister-request": { "type": "object", "properties": { "runner_id": { "type": "string" } } }, "post-api-v2-runner-heartbeat-b955dc": { "type": "object", "properties": { "pending_jobs": { "type": "array", "items": { "type": "object", "properties": { "job_id": { "type": "string" }, "job_type": { "type": "string" }, "priority": { "type": "integer" }, "run_type": { "type": "string" }, "workspace_id": { "type": "string" }, "workspace_name": { "type": "string" } } } } } }, "post-api-v2-runner-heartbeat-request": { "type": "object", "properties": { "available_capacity": { "type": "integer" }, "current_jobs": { "type": "integer" }, "runner_id": { "type": "string" }, "status": { "type": "string" } }, "required": [ "runner_id" ] }, "post-api-v2-runner-jobs-id-complete-5a9aa4": { "type": "object", "properties": { "status": { "type": "string" } } }, "post-api-v2-runner-jobs-id-complete-request": { "type": "object", "properties": { "error_message": { "type": "string" }, "exit_code": { "type": "integer" }, "has_changes": { "type": "boolean" }, "output": { "type": "string" }, "output_changes": { "type": "integer" }, "plan_json": { "type": "string" }, "resource_additions": { "type": "integer" }, "resource_changes": { "type": "integer" }, "resource_destructions": { "type": "integer" }, "runner_id": { "type": "string" }, "status": { "type": "string" } }, "required": [ "runner_id", "status" ] }, "post-api-v2-runner-jobs-id-events-041bf4": { "type": "object", "properties": { "status": { "type": "string" } } }, "post-api-v2-runner-jobs-id-events-request": { "type": "object", "properties": { "event": { "type": "string" }, "failed": { "type": "boolean" }, "stderr": { "type": "string" }, "stdout": { "type": "string" }, "task": { "type": "string" } } }, "post-api-v2-runner-jobs-id-output-0fcec5": { "type": "object", "properties": { "status": { "type": "string" } } }, "post-api-v2-runner-jobs-id-output-request": { "type": "object", "properties": { "output": { "type": "string" }, "runner_id": { "type": "string" }, "stream": { "type": "string" } }, "required": [ "output", "runner_id" ] }, "post-api-v2-runner-jobs-id-start-f47007": { "type": "object", "properties": { "status": { "type": "string" } } }, "post-api-v2-runner-jobs-id-start-request": { "type": "object", "properties": { "runner_id": { "type": "string" } }, "required": [ "runner_id" ] }, "post-api-v2-runner-jobs-id-state-562204": { "type": "object", "properties": { "status": { "type": "string" }, "version": { "type": "integer" } } }, "post-api-v2-runner-jobs-id-state-request": { "type": "object", "properties": { "runner_id": { "type": "string" }, "state": { "type": "string" } } }, "post-api-v2-runner-register-1039b3": { "type": "object", "properties": { "poll_interval_seconds": { "type": "integer" }, "runner_api_key": { "type": "string" }, "runner_id": { "type": "string", "format": "uuid" } } }, "post-api-v2-runner-register-request": { "type": "object", "properties": { "agent_pool_id": { "type": "string" }, "agent_version": { "type": "string" }, "ansible_version": { "type": "string" }, "available_collections": { "type": "array", "items": { "type": "string" } }, "hostname": { "type": "string" }, "labels": { "type": "array", "items": { "type": "string" } }, "max_concurrent_jobs": { "type": "integer" }, "name": { "type": "string" }, "os_type": { "type": "string" }, "os_version": { "type": "string" }, "tofu_version": { "type": "string" } }, "required": [ "agent_pool_id", "name" ] }, "post-api-v2-runs-request": { "type": "object", "properties": { "data": { "type": "object", "nullable": true, "properties": { "attributes": { "type": "object", "properties": { "auto-apply": { "type": "boolean", "nullable": true }, "is-destroy": { "type": "boolean", "nullable": true }, "message": { "type": "string" }, "plan-only": { "type": "boolean", "nullable": true } } }, "relationships": { "type": "object", "properties": { "configuration-version": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } } } } }, "workspace": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } } } } } } }, "type": { "type": "string" } } } }, "required": [ "data" ] }, "post-api-v2-settings-2fa-start-meta": { "type": "object", "properties": { "meta": { "type": "object", "properties": { "secret": { "type": "string" }, "url": { "type": "string" } } } } }, "post-api-v2-settings-2fa-verify-request": { "type": "object", "properties": { "data": { "type": "object", "nullable": true, "properties": { "attributes": { "type": "object", "properties": { "code": { "type": "string" } }, "required": [ "code" ] }, "type": { "type": "string" } } } }, "required": [ "data" ] }, "post-api-v2-settings-api-keys-request": { "type": "object", "properties": { "data": { "type": "object", "nullable": true, "properties": { "attributes": { "type": "object", "properties": { "expires-at": { "type": "string", "nullable": true }, "name": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string" } } }, "required": [ "name" ] }, "type": { "type": "string" } } } }, "required": [ "data" ] }, "post-api-v2-settings-password-request": { "type": "object", "properties": { "data": { "type": "object", "nullable": true, "properties": { "attributes": { "type": "object", "properties": { "current-password": { "type": "string" }, "new-password": { "type": "string" } }, "required": [ "current-password", "new-password" ] }, "type": { "type": "string" } } } }, "required": [ "data" ] }, "post-api-v2-task-stages-id-actions-override-request": { "type": "object", "properties": { "comment": { "type": "string" } } }, "post-api-v2-team-projects-request": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "access": { "type": "string", "nullable": true }, "project-access": { "type": "object", "properties": { "settings": { "type": "string", "nullable": true }, "teams": { "type": "string", "nullable": true }, "variable-sets": { "type": "string", "nullable": true } } }, "workspace-access": { "type": "object", "properties": { "create": { "type": "boolean", "nullable": true }, "delete": { "type": "boolean", "nullable": true }, "locking": { "type": "boolean", "nullable": true }, "move": { "type": "boolean", "nullable": true }, "run-tasks": { "type": "boolean", "nullable": true }, "runs": { "type": "string", "nullable": true }, "sentinel-mocks": { "type": "string", "nullable": true }, "state-versions": { "type": "string", "nullable": true }, "variables": { "type": "string", "nullable": true } } } } }, "relationships": { "type": "object", "properties": { "project": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } } } } }, "team": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } } } } } } }, "type": { "type": "string" } }, "required": [ "type" ] } }, "required": [ "data" ] }, "post-api-v2-team-workspaces-request": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "access": { "type": "string", "nullable": true }, "run-tasks": { "type": "boolean", "nullable": true }, "runs": { "type": "string", "nullable": true }, "sentinel-mocks": { "type": "string", "nullable": true }, "state-versions": { "type": "string", "nullable": true }, "variables": { "type": "string", "nullable": true }, "workspace-locking": { "type": "boolean", "nullable": true } } }, "relationships": { "type": "object", "properties": { "team": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } } } } }, "workspace": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } } } } } } }, "type": { "type": "string" } }, "required": [ "type" ] } }, "required": [ "data" ] }, "post-api-v2-teams-id-authentication-token-request": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "expired-at": { "type": "string", "format": "date-time", "nullable": true } } }, "type": { "type": "string" } } } } }, "post-api-v2-teams-id-notification-configurations-request": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "destination-type": { "type": "string", "nullable": true }, "email-addresses": { "type": "array", "items": { "type": "string" } }, "enabled": { "type": "boolean", "nullable": true }, "name": { "type": "string", "nullable": true }, "token": { "type": "string", "nullable": true }, "triggers": { "type": "array", "items": { "type": "string" } }, "url": { "type": "string", "nullable": true } } }, "type": { "type": "string" } } } } }, "post-api-v2-teams-id-notification-configurations-response": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "created-at": { "type": "string", "format": "date-time" }, "destination-type": { "type": "string" }, "email-addresses": { "type": "array", "items": { "type": "string" } }, "enabled": { "type": "boolean" }, "name": { "type": "string" }, "triggers": { "type": "array", "items": { "type": "string" } }, "updated-at": { "type": "string", "format": "date-time" }, "url": { "type": "string" } } }, "id": { "type": "string" }, "relationships": { "type": "object", "properties": { "subscribable": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } } } }, "type": { "type": "string" } } } } }, "post-api-v2-teams-id-relationships-organization-memberships-request": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } }, "required": [ "id", "type" ] } } }, "required": [ "data" ] }, "post-api-v2-teams-id-relationships-users-request": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } }, "required": [ "id", "type" ] } } }, "required": [ "data" ] }, "post-api-v2-tokens-request": { "type": "object", "properties": { "data": { "type": "object", "nullable": true, "properties": { "attributes": { "type": "object", "properties": { "description": { "type": "string" }, "expires_at": { "type": "string", "format": "date-time", "nullable": true }, "platform_admin": { "type": "boolean" } } }, "type": { "type": "string" } } } }, "required": [ "data" ] }, "post-api-v2-varsets-id-relationships-projects-request": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } } } } } }, "post-api-v2-varsets-id-relationships-vars-request": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "category": { "type": "string" }, "description": { "type": "string" }, "hcl": { "type": "boolean" }, "key": { "type": "string" }, "sensitive": { "type": "boolean" }, "value": { "type": "string" } }, "required": [ "key" ] }, "type": { "type": "string" } }, "required": [ "attributes", "type" ] } }, "required": [ "data" ] }, "post-api-v2-varsets-id-relationships-workspaces-request": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } } } } } }, "post-api-v2-vcs-connections-azure-devops-webhook-c11ee6": { "type": "object", "properties": { "message": { "type": "string" } } }, "post-api-v2-vcs-connections-azure-devops-webhook-request": { "type": "object", "properties": { "eventType": { "type": "string" }, "notificationId": { "type": "integer" }, "publisherId": { "type": "string" }, "resource": { "type": "object", "properties": { "commits": { "type": "array", "items": { "type": "object", "properties": { "author": { "type": "object", "properties": { "email": { "type": "string" }, "name": { "type": "string" } } }, "comment": { "type": "string" }, "commitId": { "type": "string" } } } }, "refUpdates": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "newObjectId": { "type": "string" }, "oldObjectId": { "type": "string" } } } }, "repository": { "type": "object", "properties": { "name": { "type": "string" }, "project": { "type": "object", "properties": { "name": { "type": "string" } } }, "remoteUrl": { "type": "string" } } } } }, "subscriptionId": { "type": "string", "format": "uuid" } } }, "post-api-v2-workspaces-id-actions-lock-request": { "type": "object", "properties": { "reason": { "type": "string" } } }, "post-api-v2-workspaces-id-configuration-versions-request": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "auto-queue-runs": { "type": "boolean", "nullable": true }, "speculative": { "type": "boolean", "nullable": true } } }, "type": { "type": "string" } } } } }, "post-api-v2-workspaces-id-notification-configurations-request": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "destination-type": { "type": "string", "nullable": true }, "email-addresses": { "type": "array", "items": { "type": "string" } }, "enabled": { "type": "boolean", "nullable": true }, "name": { "type": "string", "nullable": true }, "token": { "type": "string", "nullable": true }, "triggers": { "type": "array", "items": { "type": "string" } }, "url": { "type": "string", "nullable": true } } }, "type": { "type": "string" } } } } }, "post-api-v2-workspaces-id-relationships-team-access-request": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "access": { "type": "string", "nullable": true }, "run-tasks": { "type": "boolean", "nullable": true }, "runs": { "type": "string", "nullable": true }, "sentinel-mocks": { "type": "string", "nullable": true }, "state-versions": { "type": "string", "nullable": true }, "variables": { "type": "string", "nullable": true }, "workspace-locking": { "type": "boolean", "nullable": true } } }, "relationships": { "type": "object", "properties": { "team": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } } } } }, "workspace": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } } } } } } }, "type": { "type": "string" } }, "required": [ "type" ] } }, "required": [ "data" ] }, "post-api-v2-workspaces-id-run-triggers-request": { "type": "object", "properties": { "data": { "type": "object", "properties": { "relationships": { "type": "object", "properties": { "sourceable": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } } } } } } }, "type": { "type": "string" } } } } }, "post-api-v2-workspaces-id-state-versions-remove-resource-request": { "type": "object", "properties": { "data": { "type": "object", "nullable": true, "properties": { "attributes": { "type": "object", "properties": { "address": { "type": "string" } }, "required": [ "address" ] }, "type": { "type": "string" } } } }, "required": [ "data" ] }, "post-api-v2-workspaces-id-state-versions-request": { "type": "object", "properties": { "data": { "type": "object", "nullable": true, "properties": { "attributes": { "type": "object", "properties": { "force": { "type": "boolean", "nullable": true }, "json-state": { "type": "string", "nullable": true }, "json-state-outputs": { "type": "string", "nullable": true }, "lineage": { "type": "string", "nullable": true }, "md5": { "type": "string", "nullable": true }, "serial": { "type": "integer", "nullable": true }, "state": { "type": "string", "nullable": true } }, "required": [ "md5", "serial" ] }, "relationships": { "type": "object", "properties": { "run": { "type": "object", "nullable": true, "properties": { "data": { "type": "object", "nullable": true, "properties": { "id": { "type": "string" }, "type": { "type": "string" } } }, "links": {} } } } }, "type": { "type": "string" } } } }, "required": [ "data" ] }, "post-api-v2-workspaces-id-tasks-request": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "enforcement-level": { "type": "string", "nullable": true }, "stage": { "type": "string", "nullable": true }, "stages": { "type": "array", "items": { "type": "string" } } } }, "relationships": { "type": "object", "properties": { "task": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } } } } } } }, "type": { "type": "string" } } } } }, "post-api-v2-workspaces-id-vars-request": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "category": { "type": "string" }, "description": { "type": "string" }, "hcl": { "type": "boolean" }, "key": { "type": "string" }, "sensitive": { "type": "boolean" }, "value": { "type": "string" } }, "required": [ "key" ] }, "type": { "type": "string" } } } } }, "post-api-v2-zitadel-actions-complement-token-55ebdc": { "type": "object", "properties": { "append_claims": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "value": { "type": "array", "items": { "type": "string" } } } } } } }, "post-api-v2-zitadel-actions-complement-token-request": { "type": "object", "properties": { "function": { "type": "string" }, "org": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } } }, "user": { "type": "object", "properties": { "id": { "type": "string" }, "preferred_login_name": { "type": "string" } } }, "user_metadata": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "value": { "type": "string" } } } } } }, "post-api-v2-zitadel-actions-idp-sync-2976f5": { "type": "object", "properties": { "addHumanUser": { "type": "object", "properties": { "email": { "type": "object", "properties": { "email": { "type": "string" }, "isVerified": { "type": "boolean" } } }, "metadata": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "value": { "type": "string" } } } }, "profile": { "type": "object", "properties": { "familyName": { "type": "string" }, "givenName": { "type": "string" } } } } }, "details": { "type": "object", "properties": { "resourceOwner": { "type": "string" }, "sequence": { "type": "string" } } }, "idpInformation": { "type": "object", "properties": { "idpId": { "type": "string" }, "rawInformation": { "type": "object", "properties": { "email": { "type": "string" }, "groups": { "type": "array", "items": { "type": "string" } }, "sub": { "type": "string" } } } } } } }, "post-api-v2-zitadel-actions-idp-sync-request": { "type": "object", "properties": { "fullMethod": { "type": "string" }, "instanceID": { "type": "string" }, "orgID": { "type": "string" }, "request": { "type": "object", "properties": { "idpIntentId": { "type": "string" } } }, "response": { "type": "object", "properties": { "addHumanUser": { "type": "object", "properties": { "email": { "type": "object", "properties": { "email": { "type": "string" }, "isVerified": { "type": "boolean" } } }, "profile": { "type": "object", "properties": { "familyName": { "type": "string" }, "givenName": { "type": "string" } } } } }, "details": { "type": "object", "properties": { "resourceOwner": { "type": "string" }, "sequence": { "type": "string" } } }, "idpInformation": { "type": "object", "properties": { "idpId": { "type": "string" }, "rawInformation": { "type": "object", "properties": { "email": { "type": "string" }, "groups": { "type": "array", "items": { "type": "string" } }, "sub": { "type": "string" } } } } } } } } }, "post-auth-idp-complete-intentId-e5e263": { "type": "object", "properties": { "code": { "type": "integer" }, "details": { "type": "array", "items": { "type": "object", "properties": { "@type": { "type": "string" }, "id": { "type": "string" }, "message": { "type": "string" } } } }, "message": { "type": "string" } } }, "post-auth-oidc-end-session-e13077": { "type": "object", "properties": { "loggedOut": { "type": "boolean" } } }, "post-auth-oidc-end-session-request": { "type": "object", "properties": { "client_id": { "type": "string" }, "post_logout_redirect_uri": { "type": "string" }, "state": { "type": "string" } } }, "post-auth-oidc-finalize-d63267": { "type": "object", "properties": { "callbackUrl": { "type": "string" }, "details": { "type": "object", "properties": { "changeDate": { "type": "string", "format": "date-time" }, "resourceOwner": { "type": "string" }, "sequence": { "type": "string" } } } } }, "post-auth-oidc-finalize-request": { "type": "object", "properties": { "authRequestId": { "type": "string" }, "sessionId": { "type": "string" }, "sessionToken": { "type": "string" } } }, "post-auth-session-end-ab5972": { "nullable": true }, "post-auth-session-request": { "type": "object", "properties": { "data": { "type": "object", "nullable": true, "properties": { "attributes": { "type": "object", "properties": { "code": { "type": "string" }, "state": { "type": "string" } }, "required": [ "code", "state" ] }, "type": { "type": "string" } } } }, "required": [ "data" ] }, "post-auth-sessions-0a2e24": { "type": "object", "properties": { "code": { "type": "integer" }, "details": { "type": "array", "items": { "type": "object", "properties": { "@type": { "type": "string" }, "id": { "type": "string" }, "message": { "type": "string" } } } }, "message": { "type": "string" } } }, "post-auth-sessions-request": { "type": "object", "properties": { "checks": { "type": "object", "properties": { "password": { "type": "object", "properties": { "password": { "type": "string" } } }, "user": { "type": "object", "properties": { "loginName": { "type": "string" } } } } } } }, "post-auth-sessions-response": { "type": "object", "properties": { "details": { "type": "object", "properties": { "changeDate": { "type": "string", "format": "date-time" }, "resourceOwner": { "type": "string" }, "sequence": { "type": "string" } } }, "sessionId": { "type": "string" }, "sessionToken": { "type": "string" } } }, "post-auth-sessions-search-0f5a16": { "type": "object", "properties": { "details": { "type": "object", "properties": { "timestamp": { "type": "string", "format": "date-time" }, "totalResult": { "type": "string" } } }, "sessions": { "type": "array", "items": { "type": "object", "properties": { "changeDate": { "type": "string", "format": "date-time" }, "creationDate": { "type": "string", "format": "date-time" }, "factors": { "type": "object", "properties": { "password": { "type": "object", "properties": { "verifiedAt": { "type": "string", "format": "date-time" } } }, "user": { "type": "object", "properties": { "displayName": { "type": "string" }, "id": { "type": "string" }, "loginName": { "type": "string" }, "organizationId": { "type": "string" }, "verifiedAt": { "type": "string", "format": "date-time" } } } } }, "id": { "type": "string" }, "sequence": { "type": "string" } } } } } }, "post-auth-sessions-search-request": { "type": "object", "properties": { "query": { "type": "object", "properties": { "asc": { "type": "boolean" }, "limit": { "type": "integer" } } }, "sortingColumn": { "type": "string" } } }, "post-auth-users-id-email-23776e": { "type": "object", "properties": { "code": { "type": "integer" }, "details": { "type": "array", "items": { "type": "object", "properties": { "@type": { "type": "string" }, "id": { "type": "string" }, "message": { "type": "string" } } } }, "message": { "type": "string" } } }, "post-auth-users-id-email-request": { "type": "object", "properties": { "verificationCode": { "type": "string" } } }, "post-auth-users-id-email-response": { "type": "object", "properties": { "details": { "type": "object", "properties": { "changeDate": { "type": "string", "format": "date-time" }, "resourceOwner": { "type": "string" }, "sequence": { "type": "string" } } } } }, "post-auth-users-id-invite-code-verify-6c612e": { "type": "object", "properties": { "code": { "type": "integer" }, "details": { "type": "array", "items": { "type": "object", "properties": { "@type": { "type": "string" }, "id": { "type": "string" }, "message": { "type": "string" } } } }, "message": { "type": "string" } } }, "post-auth-users-id-invite-code-verify-request": { "type": "object", "properties": { "verificationCode": { "type": "string" } } }, "post-auth-users-id-invite-code-verify-response": { "type": "object", "properties": { "authenticatorSetupRequired": { "type": "boolean" }, "details": { "type": "object", "properties": { "changeDate": { "type": "string", "format": "date-time" }, "resourceOwner": { "type": "string" }, "sequence": { "type": "string" } } } } }, "post-auth-users-id-otp-email-231926": { "type": "object", "properties": { "details": { "type": "object", "properties": { "changeDate": { "type": "string", "format": "date-time" }, "resourceOwner": { "type": "string" }, "sequence": { "type": "string" } } } } }, "post-auth-users-id-otp-sms-fc5cd4": { "type": "object", "properties": { "details": { "type": "object", "properties": { "changeDate": { "type": "string", "format": "date-time" }, "resourceOwner": { "type": "string" }, "sequence": { "type": "string" } } } } }, "post-auth-users-id-passkeys-d33f79": { "type": "object", "properties": { "details": { "type": "object", "properties": { "changeDate": { "type": "string", "format": "date-time" }, "resourceOwner": { "type": "string" }, "sequence": { "type": "string" } } }, "passkeyId": { "type": "string" }, "publicKeyCredentialCreationOptions": { "type": "object", "properties": { "publicKey": { "type": "object", "properties": { "attestation": { "type": "string" }, "authenticatorSelection": { "type": "object", "properties": { "userVerification": { "type": "string" } } }, "challenge": { "type": "string" }, "pubKeyCredParams": { "type": "array", "items": { "type": "object", "properties": { "alg": { "type": "integer" }, "type": { "type": "string" } } } }, "rp": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } } }, "timeout": { "type": "integer" }, "user": { "type": "object", "properties": { "displayName": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" } } } } } } } } }, "post-auth-users-id-passkeys-request": { "type": "object", "properties": { "authenticator": { "type": "string" }, "domain": { "type": "string" } } }, "post-auth-users-id-password-2c5511": { "type": "object", "properties": { "code": { "type": "integer" }, "details": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "message": { "type": "string" } } }, "post-auth-users-id-password-request": { "type": "object", "properties": { "currentPassword": { "type": "string" }, "newPassword": { "type": "object", "properties": { "changeRequired": { "type": "boolean" }, "password": { "type": "string" } } } } }, "post-auth-users-id-password-reset-7b52f6": { "type": "object", "properties": { "code": { "type": "integer" }, "details": { "type": "array", "items": { "type": "object", "properties": { "@type": { "type": "string" }, "id": { "type": "string" }, "message": { "type": "string" } } } }, "message": { "type": "string" } } }, "post-auth-users-id-password-reset-response": { "type": "object", "properties": { "details": { "type": "object", "properties": { "changeDate": { "type": "string", "format": "date-time" }, "resourceOwner": { "type": "string" }, "sequence": { "type": "string" } } } } }, "post-auth-users-id-password-response": { "type": "object", "properties": { "details": { "type": "object", "properties": { "changeDate": { "type": "string", "format": "date-time" }, "resourceOwner": { "type": "string" }, "sequence": { "type": "string" } } } } }, "post-auth-users-id-totp-52a611": { "type": "object", "properties": { "details": { "type": "object", "properties": { "changeDate": { "type": "string", "format": "date-time" }, "resourceOwner": { "type": "string" }, "sequence": { "type": "string" } } }, "secret": { "type": "string" }, "uri": { "type": "string" } } }, "post-auth-users-id-totp-verify-b94c95": { "type": "object", "properties": { "details": { "type": "object", "properties": { "changeDate": { "type": "string", "format": "date-time" }, "resourceOwner": { "type": "string" }, "sequence": { "type": "string" } } } } }, "post-auth-users-id-totp-verify-request": { "type": "object", "properties": { "code": { "type": "string" } } }, "post-auth-users-id-u2f-4e007c": { "type": "object", "properties": { "details": { "type": "object", "properties": { "changeDate": { "type": "string", "format": "date-time" }, "resourceOwner": { "type": "string" }, "sequence": { "type": "string" } } }, "publicKeyCredentialCreationOptions": { "type": "object", "properties": { "publicKey": { "type": "object", "properties": { "attestation": { "type": "string" }, "authenticatorSelection": { "type": "object", "properties": { "userVerification": { "type": "string" } } }, "challenge": { "type": "string" }, "pubKeyCredParams": { "type": "array", "items": { "type": "object", "properties": { "alg": { "type": "integer" }, "type": { "type": "string" } } } }, "rp": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } } }, "timeout": { "type": "integer" }, "user": { "type": "object", "properties": { "displayName": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" } } } } } } }, "u2fId": { "type": "string" } } }, "post-auth-users-id-u2f-request": { "type": "object", "properties": { "domain": { "type": "string" } } }, "projects-collection": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "created-at": { "type": "string", "format": "date-time" }, "default-execution-mode": { "type": "string" }, "description": { "type": "string" }, "is-unified": { "type": "boolean" }, "name": { "type": "string" }, "setting-overwrites": { "type": "object", "properties": { "default-agent-pool": { "type": "boolean" }, "default-execution-mode": { "type": "boolean" } } }, "updated-at": { "type": "string", "format": "date-time" } } }, "id": { "type": "string", "format": "uuid" }, "links": { "type": "object", "properties": { "self": { "type": "string" } } }, "relationships": { "type": "object", "properties": { "default-agent-pool": { "type": "object", "properties": { "data": { "nullable": true } } }, "organization": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } } } } } } }, "type": { "type": "string" } } } }, "meta": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "current-page": { "type": "integer" }, "next-page": { "nullable": true }, "page-size": { "type": "integer" }, "prev-page": { "nullable": true }, "total-count": { "type": "integer" }, "total-pages": { "type": "integer" } } } } } } }, "projects-response": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "created-at": { "type": "string", "format": "date-time" }, "credentials-count": { "type": "integer" }, "default-execution-mode": { "type": "string" }, "description": { "type": "string" }, "inventories-count": { "type": "integer" }, "is-unified": { "type": "boolean" }, "job-templates-count": { "type": "integer" }, "name": { "type": "string" }, "playbooks-count": { "type": "integer" }, "setting-overwrites": { "type": "object", "properties": { "default-agent-pool": { "type": "boolean" }, "default-execution-mode": { "type": "boolean" } } }, "updated-at": { "type": "string", "format": "date-time" }, "workflows-count": { "type": "integer" }, "workspaces-count": { "type": "integer" } } }, "id": { "type": "string", "format": "uuid" }, "links": { "type": "object", "properties": { "self": { "type": "string" } } }, "relationships": { "type": "object", "properties": { "default-agent-pool": { "type": "object", "properties": { "data": { "type": "object", "nullable": true, "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } }, "organization": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } } } } } } }, "type": { "type": "string" } } } } }, "put-api-v2-organizations-name-ansible-config-request": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "config-content": { "type": "string" } }, "required": [ "config-content" ] }, "type": { "type": "string" } }, "required": [ "attributes" ] } }, "required": [ "data" ] }, "put-api-v2-projects-id-ansible-config-request": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "config-content": { "type": "string" } }, "required": [ "config-content" ] }, "type": { "type": "string" } }, "required": [ "attributes" ] } }, "required": [ "data" ] }, "queue-depths-response": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "busy-runners": { "type": "integer" }, "idle-runners": { "type": "integer" }, "pending-ansible-jobs": { "type": "integer" }, "pending-terraform-jobs": { "type": "integer" }, "total-pending": { "type": "integer" }, "total-runners": { "type": "integer" } } }, "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } }, "registry-module-versions-response": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "published_at": { "type": "string", "format": "date-time" }, "version": { "type": "string" } } }, "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } }, "registry-modules-collection": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "auto_publish_tags": { "type": "boolean" }, "description": { "type": "string" }, "downloads": { "type": "integer" }, "latest_version": { "type": "string" }, "name": { "type": "string" }, "provider": { "type": "string" }, "published_at": { "type": "string", "format": "date-time" }, "vcs_repository": { "type": "string" } } }, "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } }, "meta": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "current-page": { "type": "integer" }, "next-page": { "nullable": true }, "page-size": { "type": "integer" }, "prev-page": { "nullable": true }, "total-count": { "type": "integer" }, "total-pages": { "type": "integer" } } } } } } }, "registry-modules-response": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "auto_publish_tags": { "type": "boolean" }, "description": { "type": "string" }, "name": { "type": "string" }, "provider": { "type": "string" }, "vcs_repository": { "type": "string" } } }, "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } }, "registry-provider-platforms-response": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "arch": { "type": "string" }, "filename": { "type": "string" }, "os": { "type": "string" }, "provider-binary-uploaded": { "type": "boolean" }, "shasum": { "type": "string" } } }, "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } }, "registry-providers-collection": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "created-at": { "type": "string", "format": "date-time" }, "name": { "type": "string" }, "namespace": { "type": "string" }, "permissions": { "type": "object", "properties": { "can-delete": { "type": "boolean" } } }, "registry-name": { "type": "string" }, "updated-at": { "type": "string", "format": "date-time" } } }, "id": { "type": "string", "format": "uuid" }, "relationships": { "type": "object", "properties": { "organization": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } } } } } } }, "type": { "type": "string" } } } }, "meta": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "current-page": { "type": "integer" }, "next-page": { "nullable": true }, "page-size": { "type": "integer" }, "prev-page": { "nullable": true }, "total-count": { "type": "integer" }, "total-pages": { "type": "integer" } } } } } } }, "registry-providers-response": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "created-at": { "type": "string", "format": "date-time" }, "name": { "type": "string" }, "namespace": { "type": "string" }, "permissions": { "type": "object", "properties": { "can-delete": { "type": "boolean" } } }, "registry-name": { "type": "string" }, "updated-at": { "type": "string", "format": "date-time" } } }, "id": { "type": "string", "format": "uuid" }, "relationships": { "type": "object", "properties": { "organization": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } } } } } } }, "type": { "type": "string" } } } } }, "run-triggers-response": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "created-at": { "type": "string", "format": "date-time" }, "sourceable-name": { "type": "string" }, "workspace-name": { "type": "string" } } }, "id": { "type": "string" }, "relationships": { "type": "object", "properties": { "sourceable": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } } } } }, "workspace": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } } } } } } }, "type": { "type": "string" } } } } }, "runner-stats-response": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "offline": { "type": "integer" }, "online": { "type": "integer" }, "total": { "type": "integer" } } }, "type": { "type": "string" } } } } }, "runners-collection": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "agent-pool-id": { "type": "string", "format": "uuid" }, "agent-pool-name": { "type": "string" }, "agent-version": { "type": "string" }, "ansible-version": { "type": "string" }, "available-collections": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "current-jobs": { "type": "integer" }, "description": { "type": "string" }, "hostname": { "type": "string" }, "ip-address": { "type": "string" }, "labels": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "last-heartbeat-at": { "type": "string", "format": "date-time" }, "max-concurrent-jobs": { "type": "integer" }, "name": { "type": "string" }, "os-type": { "type": "string" }, "os-version": { "type": "string" }, "registered-at": { "type": "string", "format": "date-time" }, "runner-type": { "type": "string" }, "status": { "type": "string" }, "tofu-version": { "type": "string" } } }, "id": { "type": "string", "format": "uuid" }, "relationships": { "type": "object", "properties": { "agent-pool": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } }, "organization": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } } } }, "type": { "type": "string" } } } }, "meta": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "current-page": { "type": "integer" }, "next-page": { "nullable": true }, "page-size": { "type": "integer" }, "prev-page": { "nullable": true }, "total-count": { "type": "integer" }, "total-pages": { "type": "integer" } } } } } } }, "runners-response": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "agent-pool-id": { "type": "string", "format": "uuid" }, "agent-pool-name": { "type": "string" }, "agent-version": { "type": "string" }, "ansible-version": { "type": "string" }, "available-collections": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "current-jobs": { "type": "integer" }, "description": { "type": "string" }, "hostname": { "type": "string" }, "ip-address": { "type": "string" }, "labels": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "last-heartbeat-at": { "type": "string", "format": "date-time" }, "max-concurrent-jobs": { "type": "integer" }, "name": { "type": "string" }, "os-type": { "type": "string" }, "os-version": { "type": "string" }, "recent_jobs": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "registered-at": { "type": "string", "format": "date-time" }, "runner-type": { "type": "string" }, "status": { "type": "string" }, "tofu-version": { "type": "string" } } }, "id": { "type": "string", "format": "uuid" }, "relationships": { "type": "object", "properties": { "agent-pool": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } }, "organization": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } } } }, "type": { "type": "string" } } } } }, "runs-collection": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "actions": { "type": "object", "properties": { "is-cancelable": { "type": "boolean" }, "is-confirmable": { "type": "boolean" }, "is-discardable": { "type": "boolean" }, "is-force-cancelable": { "type": "boolean" } } }, "completed-at": { "type": "string", "format": "date-time" }, "created-at": { "type": "string", "format": "date-time" }, "has-changes": { "type": "boolean" }, "is-destroy": { "type": "boolean" }, "message": { "type": "string" }, "operation": { "type": "string" }, "permissions": { "type": "object", "properties": { "can-apply": { "type": "boolean" }, "can-cancel": { "type": "boolean" }, "can-discard": { "type": "boolean" }, "can-force-cancel": { "type": "boolean" }, "can-force-execute": { "type": "boolean" } } }, "plan-only": { "type": "boolean" }, "source": { "type": "string" }, "started-at": { "type": "string", "format": "date-time" }, "status": { "type": "string" }, "status-timestamps": { "type": "object", "properties": { "applied-at": { "type": "string", "format": "date-time" }, "planned-at": { "type": "string", "format": "date-time" }, "planning-at": { "type": "string", "format": "date-time" } } }, "updated-at": { "type": "string", "format": "date-time" } } }, "id": { "type": "string" }, "relationships": { "type": "object", "properties": { "plan": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } } } } }, "workspace": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } } } } } } }, "type": { "type": "string" } } } }, "meta": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "current-page": { "type": "string" }, "next-page": { "nullable": true }, "page-size": { "type": "string" }, "prev-page": { "nullable": true }, "total-count": { "type": "string" }, "total-pages": { "type": "string" } } } } } } }, "runs-response": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "actions": { "type": "object", "properties": { "is-cancelable": { "type": "boolean" }, "is-confirmable": { "type": "boolean" }, "is-discardable": { "type": "boolean" }, "is-force-cancelable": { "type": "boolean" } } }, "completed-at": { "type": "string", "format": "date-time" }, "created-at": { "type": "string", "format": "date-time" }, "has-changes": { "type": "boolean" }, "is-destroy": { "type": "boolean" }, "message": { "type": "string" }, "operation": { "type": "string" }, "permissions": { "type": "object", "properties": { "can-apply": { "type": "boolean" }, "can-cancel": { "type": "boolean" }, "can-discard": { "type": "boolean" }, "can-force-cancel": { "type": "boolean" }, "can-force-execute": { "type": "boolean" } } }, "plan-only": { "type": "boolean" }, "source": { "type": "string" }, "started-at": { "type": "string", "format": "date-time" }, "status": { "type": "string" }, "status-timestamps": { "type": "object", "properties": { "applying-at": { "type": "string", "format": "date-time" }, "plan-queued-at": { "type": "string", "format": "date-time" }, "planning-at": { "type": "string", "format": "date-time" } } }, "updated-at": { "type": "string", "format": "date-time" } } }, "id": { "type": "string" }, "relationships": { "type": "object", "properties": { "apply": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } } } } }, "plan": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } } } } }, "workspace": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } } } } } } }, "type": { "type": "string" } } } } }, "schedules-collection": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "config": { "type": "object", "additionalProperties": true }, "created-at": { "type": "string", "format": "date-time" }, "cron-expression": { "type": "string" }, "description": { "type": "string" }, "name": { "type": "string" }, "schedule-type": { "type": "string" }, "status": { "type": "string" }, "timezone": { "type": "string" }, "updated-at": { "type": "string", "format": "date-time" } } }, "id": { "type": "string", "format": "uuid" }, "relationships": { "type": "object", "properties": { "job-template": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } }, "organization": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } } } }, "type": { "type": "string" } } } }, "meta": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "current-page": { "type": "integer" }, "next-page": { "nullable": true }, "page-size": { "type": "integer" }, "prev-page": { "nullable": true }, "total-count": { "type": "integer" }, "total-pages": { "type": "integer" } } } } } } }, "schedules-response": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "config": { "type": "object", "properties": { "extra_vars": { "type": "object", "properties": { "compliance_profile": { "type": "string" }, "reboot": { "type": "boolean" } } } } }, "created-at": { "type": "string", "format": "date-time" }, "cron-expression": { "type": "string" }, "description": { "type": "string" }, "end-date-time": { "type": "string", "format": "date-time" }, "last-run-at": { "type": "string", "format": "date-time" }, "last-run-status": { "type": "string" }, "name": { "type": "string" }, "next-run-at": { "type": "string", "format": "date-time" }, "run-count": { "type": "integer" }, "schedule-type": { "type": "string" }, "start-date-time": { "type": "string", "format": "date-time" }, "status": { "type": "string" }, "timezone": { "type": "string" }, "updated-at": { "type": "string", "format": "date-time" } } }, "id": { "type": "string", "format": "uuid" }, "relationships": { "type": "object", "properties": { "created-by": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } }, "job-template": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } }, "last-job": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } }, "organization": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } } } }, "type": { "type": "string" } } } } }, "sessions-response": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "email": { "type": "string" }, "expires-at": { "type": "string", "format": "date-time" }, "family-name": { "type": "string" }, "given-name": { "type": "string" }, "name": { "type": "string" }, "picture": { "type": "string" } } }, "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } }, "state-versions-response": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "created-at": { "type": "string", "format": "date-time" }, "hosted-state-download-url": { "type": "string" }, "lineage": { "type": "string", "format": "uuid" }, "resources-processed": { "type": "boolean" }, "serial": { "type": "integer", "nullable": true }, "size": { "type": "integer" }, "state-version": { "type": "integer" }, "status": { "type": "string" }, "vcs-commit-sha": { "type": "string" } } }, "id": { "type": "string" }, "relationships": { "type": "object", "properties": { "outputs": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } } } } } }, "workspace": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } } } } } } }, "type": { "type": "string" } } } } }, "tag-bindings-collection": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "key": { "type": "string" }, "value": { "type": "string" } } }, "id": { "type": "string" }, "type": { "type": "string" } } } }, "meta": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "current-page": { "type": "integer" }, "next-page": { "nullable": true }, "page-size": { "type": "integer" }, "prev-page": { "nullable": true }, "total-count": { "type": "integer" }, "total-pages": { "type": "integer" } } } } } } }, "task-results-response": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "created-at": { "type": "string", "format": "date-time" }, "message": { "type": "string" }, "status": { "type": "string" }, "status-timestamps": { "type": "object", "properties": { "passed-at": { "type": "string", "format": "date-time" }, "running-at": { "type": "string", "format": "date-time" } } }, "task-id": { "type": "string" }, "task-name": { "type": "string" }, "task-url": { "type": "string" }, "updated-at": { "type": "string", "format": "date-time" }, "url": { "type": "string" }, "workspace-task-enforcement-level": { "type": "string" }, "workspace-task-id": { "type": "string" } } }, "id": { "type": "string" }, "relationships": { "type": "object", "properties": { "task-stage": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } } } } }, "task_stage": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } } } } } } }, "type": { "type": "string" } } } } }, "task-stages-response": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "actions": { "type": "object", "properties": { "is-overridable": { "type": "boolean" } } }, "created-at": { "type": "string", "format": "date-time" }, "permissions": { "type": "object", "properties": { "can-override": { "type": "boolean" }, "can-override-policy": { "type": "boolean" }, "can-override-tasks": { "type": "boolean" } } }, "stage": { "type": "string" }, "status": { "type": "string" }, "status-timestamps": { "type": "object", "properties": { "failed-at": { "type": "string", "format": "date-time" }, "passed-at": { "type": "string", "format": "date-time" }, "running-at": { "type": "string", "format": "date-time" } } }, "updated-at": { "type": "string", "format": "date-time" } } }, "id": { "type": "string" }, "relationships": { "type": "object", "properties": { "policy-evaluations": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": true } } } }, "run": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } } } } }, "task-results": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } } } } } } } }, "type": { "type": "string" } } } } }, "tasks-collection": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "category": { "type": "string" }, "created-at": { "type": "string", "format": "date-time" }, "description": { "type": "string" }, "enabled": { "type": "boolean" }, "global-configuration": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "enforcement-level": { "type": "string" }, "stages": { "type": "array", "items": { "type": "object", "additionalProperties": true } } } }, "name": { "type": "string" }, "updated-at": { "type": "string", "format": "date-time" }, "url": { "type": "string" } } }, "id": { "type": "string" }, "relationships": { "type": "object", "properties": { "organization": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } } } } }, "workspace-tasks": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": true } } } } } }, "type": { "type": "string" } } } }, "meta": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "current-page": { "type": "integer" }, "next-page": { "nullable": true }, "page-size": { "type": "integer" }, "prev-page": { "nullable": true }, "total-count": { "type": "integer" }, "total-pages": { "type": "integer" } } } } } } }, "tasks-response": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "category": { "type": "string" }, "created-at": { "type": "string", "format": "date-time" }, "description": { "type": "string" }, "enabled": { "type": "boolean" }, "global-configuration": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "enforcement-level": { "type": "string" }, "stages": { "type": "array", "items": { "type": "object", "additionalProperties": true } } } }, "name": { "type": "string" }, "updated-at": { "type": "string", "format": "date-time" }, "url": { "type": "string" } } }, "id": { "type": "string" }, "relationships": { "type": "object", "properties": { "organization": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } } } } }, "workspace-tasks": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": true } } } } } }, "type": { "type": "string" } } } } }, "team-access-collection": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "execute": { "type": "boolean" }, "read": { "type": "boolean" }, "team-name": { "type": "string" }, "write": { "type": "boolean" } } }, "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } }, "meta": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "current-page": { "type": "integer" }, "next-page": { "nullable": true }, "page-size": { "type": "integer" }, "prev-page": { "nullable": true }, "total-count": { "type": "integer" }, "total-pages": { "type": "integer" } } } } } } }, "team-projects-collection": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "access": { "type": "string" } } }, "id": { "type": "string", "format": "uuid" }, "links": { "type": "object", "properties": { "self": { "type": "string" } } }, "relationships": { "type": "object", "properties": { "project": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } }, "team": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } } } }, "type": { "type": "string" } } } }, "meta": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "current-page": { "type": "integer" }, "next-page": { "nullable": true }, "page-size": { "type": "integer" }, "prev-page": { "nullable": true }, "total-count": { "type": "integer" }, "total-pages": { "type": "integer" } } } } } } }, "team-projects-response": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "access": { "type": "string" }, "project-access": { "type": "object", "properties": { "settings": { "type": "string" }, "teams": { "type": "string" }, "variable-sets": { "type": "string" } } }, "workspace-access": { "type": "object", "properties": { "create": { "type": "boolean" }, "delete": { "type": "boolean" }, "locking": { "type": "boolean" }, "move": { "type": "boolean" }, "run-tasks": { "type": "boolean" }, "runs": { "type": "string" }, "sentinel-mocks": { "type": "string" }, "state-versions": { "type": "string" }, "variables": { "type": "string" } } } } }, "id": { "type": "string", "format": "uuid" }, "links": { "type": "object", "properties": { "self": { "type": "string" } } }, "relationships": { "type": "object", "properties": { "project": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } }, "team": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } } } }, "type": { "type": "string" } } } } }, "team-workspaces-response": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "access": { "type": "string" }, "permissions": { "type": "object", "properties": { "run-tasks": { "type": "boolean" }, "runs": { "type": "string" }, "sentinel-mocks": { "type": "string" }, "state-versions": { "type": "string" }, "variables": { "type": "string" }, "workspace-locking": { "type": "boolean" } } } } }, "id": { "type": "string", "format": "uuid" }, "links": { "type": "object", "properties": { "self": { "type": "string" } } }, "relationships": { "type": "object", "properties": { "team": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } }, "workspace": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } } } } } } }, "type": { "type": "string" } } } } }, "teams-collection": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "allow-member-token-management": { "type": "boolean" }, "name": { "type": "string" }, "organization-access": { "type": "object", "properties": { "access-secret-teams": { "type": "boolean" }, "manage-agent-pools": { "type": "boolean" }, "manage-ansible": { "type": "boolean" }, "manage-ansible-credentials": { "type": "boolean" }, "manage-ansible-inventories": { "type": "boolean" }, "manage-ansible-job-templates": { "type": "boolean" }, "manage-ansible-jobs": { "type": "boolean" }, "manage-ansible-playbooks": { "type": "boolean" }, "manage-ansible-schedules": { "type": "boolean" }, "manage-membership": { "type": "boolean" }, "manage-modules": { "type": "boolean" }, "manage-organization-access": { "type": "boolean" }, "manage-policies": { "type": "boolean" }, "manage-policy-overrides": { "type": "boolean" }, "manage-projects": { "type": "boolean" }, "manage-providers": { "type": "boolean" }, "manage-run-tasks": { "type": "boolean" }, "manage-teams": { "type": "boolean" }, "manage-vcs-settings": { "type": "boolean" }, "manage-workspaces": { "type": "boolean" }, "read-ansible": { "type": "boolean" }, "read-ansible-credentials": { "type": "boolean" }, "read-ansible-inventories": { "type": "boolean" }, "read-ansible-job-templates": { "type": "boolean" }, "read-ansible-jobs": { "type": "boolean" }, "read-ansible-playbooks": { "type": "boolean" }, "read-ansible-schedules": { "type": "boolean" }, "read-projects": { "type": "boolean" }, "read-workspaces": { "type": "boolean" } } }, "permissions": { "type": "object", "properties": { "can-destroy": { "type": "boolean" }, "can-update-api-token": { "type": "boolean" }, "can-update-membership": { "type": "boolean" }, "can-update-organization-access": { "type": "boolean" }, "can-update-visibility": { "type": "boolean" } } }, "sso-team-id": { "nullable": true }, "users-count": { "type": "integer" }, "visibility": { "type": "string" } } }, "id": { "type": "string", "format": "uuid" }, "links": { "type": "object", "properties": { "self": { "type": "string" } } }, "relationships": { "type": "object", "properties": { "authentication-token": { "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": true } } }, "organization-memberships": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": true } } } }, "users": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } } } } }, "type": { "type": "string" } } } }, "meta": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "current-page": { "type": "integer" }, "next-page": { "nullable": true }, "page-size": { "type": "integer" }, "prev-page": { "nullable": true }, "total-count": { "type": "integer" }, "total-pages": { "type": "integer" } } } } } } }, "teams-response": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "allow-member-token-management": { "type": "boolean" }, "name": { "type": "string" }, "organization-access": { "type": "object", "properties": { "access-secret-teams": { "type": "boolean" }, "manage-agent-pools": { "type": "boolean" }, "manage-ansible": { "type": "boolean" }, "manage-ansible-credentials": { "type": "boolean" }, "manage-ansible-inventories": { "type": "boolean" }, "manage-ansible-job-templates": { "type": "boolean" }, "manage-ansible-jobs": { "type": "boolean" }, "manage-ansible-playbooks": { "type": "boolean" }, "manage-ansible-schedules": { "type": "boolean" }, "manage-membership": { "type": "boolean" }, "manage-modules": { "type": "boolean" }, "manage-organization-access": { "type": "boolean" }, "manage-policies": { "type": "boolean" }, "manage-policy-overrides": { "type": "boolean" }, "manage-projects": { "type": "boolean" }, "manage-providers": { "type": "boolean" }, "manage-run-tasks": { "type": "boolean" }, "manage-teams": { "type": "boolean" }, "manage-vcs-settings": { "type": "boolean" }, "manage-workspaces": { "type": "boolean" }, "read-ansible": { "type": "boolean" }, "read-ansible-credentials": { "type": "boolean" }, "read-ansible-inventories": { "type": "boolean" }, "read-ansible-job-templates": { "type": "boolean" }, "read-ansible-jobs": { "type": "boolean" }, "read-ansible-playbooks": { "type": "boolean" }, "read-ansible-schedules": { "type": "boolean" }, "read-projects": { "type": "boolean" }, "read-workspaces": { "type": "boolean" } } }, "permissions": { "type": "object", "properties": { "can-destroy": { "type": "boolean" }, "can-update-api-token": { "type": "boolean" }, "can-update-membership": { "type": "boolean" }, "can-update-organization-access": { "type": "boolean" }, "can-update-visibility": { "type": "boolean" } } }, "sso-team-id": { "type": "string", "nullable": true }, "users-count": { "type": "integer" }, "visibility": { "type": "string" } } }, "id": { "type": "string", "format": "uuid" }, "links": { "type": "object", "properties": { "self": { "type": "string" } } }, "relationships": { "type": "object", "properties": { "authentication-token": { "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": true } } }, "organization-memberships": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } } }, "users": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } } } } }, "type": { "type": "string" } } } } }, "terraform-versions-collection": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "archs": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "beta": { "type": "boolean" }, "created-at": { "type": "string", "format": "date-time" }, "deprecated": { "type": "boolean" }, "enabled": { "type": "boolean" }, "official": { "type": "boolean" }, "sha": { "type": "string" }, "url": { "type": "string" }, "usage": { "type": "integer" }, "version": { "type": "string" } } }, "id": { "type": "string" }, "type": { "type": "string" } } } }, "meta": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "current-page": { "type": "integer" }, "next-page": { "nullable": true }, "page-size": { "type": "integer" }, "prev-page": { "nullable": true }, "total-count": { "type": "integer" }, "total-pages": { "type": "integer" } } } } } } }, "terraform-versions-response": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "archs": { "type": "array", "items": { "type": "object", "properties": { "arch": { "type": "string" }, "os": { "type": "string" }, "sha": { "type": "string" }, "url": { "type": "string" } } } }, "beta": { "type": "boolean" }, "created-at": { "type": "string", "format": "date-time" }, "deprecated": { "type": "boolean" }, "deprecated-reason": { "type": "string" }, "enabled": { "type": "boolean" }, "official": { "type": "boolean" }, "sha": { "type": "string" }, "url": { "type": "string" }, "usage": { "type": "integer" }, "version": { "type": "string" } } }, "id": { "type": "string" }, "type": { "type": "string" } } } } }, "tokens-response": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time" }, "description": { "type": "string" }, "expires_at": { "type": "string", "format": "date-time" }, "platform_admin": { "type": "boolean" }, "token": { "type": "string" } } }, "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } }, "two-factor-response": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "enabled": { "type": "boolean" } } }, "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } }, "users-collection": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "avatar-url": { "type": "string" }, "email": { "type": "string" }, "is-admin": { "type": "boolean" }, "is-service-account": { "type": "boolean" }, "is-site-auditor": { "type": "boolean" }, "is-suspended": { "type": "boolean" }, "name": { "type": "string" }, "platform-admin-declared": { "type": "boolean" }, "username": { "type": "string" } } }, "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } }, "meta": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "current-page": { "type": "integer" }, "next-page": { "nullable": true }, "page-size": { "type": "integer" }, "prev-page": { "nullable": true }, "total-count": { "type": "integer" }, "total-pages": { "type": "integer" } } } } } } }, "users-response": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "avatar-url": { "type": "string" }, "bio": { "type": "string" }, "company": { "type": "string" }, "created-at": { "type": "string", "format": "date-time" }, "email": { "type": "string" }, "is-admin": { "type": "boolean" }, "is-service-account": { "type": "boolean" }, "is-site-admin": { "type": "boolean" }, "is-site-auditor": { "type": "boolean" }, "is-suspended": { "type": "boolean" }, "location": { "type": "string" }, "name": { "type": "string" }, "permissions": { "type": "object", "properties": { "can-create-organizations": { "type": "boolean" } } }, "platform-admin-declared": { "type": "boolean" }, "unconfirmed-email": { "type": "string" }, "updated-at": { "type": "string", "format": "date-time" }, "username": { "type": "string" }, "v2-only": { "type": "boolean" } } }, "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } }, "vars-collection": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "category": { "type": "string" }, "description": { "type": "string" }, "hcl": { "type": "boolean" }, "key": { "type": "string" }, "sensitive": { "type": "boolean" }, "value": { "type": "string" }, "version-id": { "type": "string" } } }, "id": { "type": "string" }, "links": { "type": "object", "properties": { "self": { "type": "string" } } }, "relationships": { "type": "object", "properties": { "configurable": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } } }, "links": { "type": "object", "properties": { "related": { "type": "string" } } } } } } }, "type": { "type": "string" } } } }, "meta": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "current-page": { "type": "integer" }, "next-page": { "nullable": true }, "page-size": { "type": "integer" }, "prev-page": { "nullable": true }, "total-count": { "type": "integer" }, "total-pages": { "type": "integer" } } } } } } }, "vars-response": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "category": { "type": "string" }, "description": { "type": "string" }, "hcl": { "type": "boolean" }, "key": { "type": "string" }, "sensitive": { "type": "boolean" }, "value": { "type": "string" }, "version-id": { "type": "string" } } }, "id": { "type": "string" }, "links": { "type": "object", "properties": { "self": { "type": "string" } } }, "relationships": { "type": "object", "properties": { "configurable": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } } }, "links": { "type": "object", "properties": { "related": { "type": "string" } } } } }, "varset": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } } }, "links": { "type": "object", "properties": { "related": { "type": "string" } } } } } } }, "type": { "type": "string" } } } } }, "varsets-collection": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "description": { "type": "string" }, "global": { "type": "boolean" }, "name": { "type": "string" }, "priority": { "type": "boolean" }, "project-count": { "type": "integer" }, "updated-at": { "type": "string", "format": "date-time" }, "var-count": { "type": "integer" }, "workspace-count": { "type": "integer" } } }, "id": { "type": "string" }, "relationships": { "type": "object", "properties": { "organization": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } } } } }, "parent": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } } } } }, "vars": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "category": { "type": "string" }, "description": { "type": "string" }, "hcl": { "type": "boolean" }, "key": { "type": "string" }, "sensitive": { "type": "boolean" }, "value": { "type": "string" } } }, "id": { "type": "string" }, "type": { "type": "string" } } } } } } } }, "type": { "type": "string" } } } }, "meta": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "current-page": { "type": "integer" }, "next-page": { "nullable": true }, "page-size": { "type": "integer" }, "prev-page": { "nullable": true }, "total-count": { "type": "integer" }, "total-pages": { "type": "integer" } } } } } } }, "varsets-response": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "description": { "type": "string" }, "global": { "type": "boolean" }, "name": { "type": "string" }, "priority": { "type": "boolean" }, "project-count": { "type": "integer" }, "updated-at": { "type": "string", "format": "date-time" }, "var-count": { "type": "integer" }, "workspace-count": { "type": "integer" } } }, "id": { "type": "string" }, "links": { "type": "object", "properties": { "self": { "type": "string" } } }, "relationships": { "type": "object", "properties": { "organization": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } } } } }, "parent": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } } } } }, "vars": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "category": { "type": "string" }, "description": { "type": "string" }, "hcl": { "type": "boolean" }, "key": { "type": "string" }, "sensitive": { "type": "boolean" }, "value": { "type": "string" } } }, "id": { "type": "string" }, "type": { "type": "string" } } } } } } } }, "type": { "type": "string" } } } } }, "vcs-connections-response": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "account_name": { "type": "string" }, "account_type": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "provider": { "type": "string" }, "token_expires_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } }, "id": { "type": "string", "format": "uuid" }, "relationships": { "type": "object", "properties": { "organization": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } } } }, "type": { "type": "string" } } } } }, "workspace-tasks-response": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "created-at": { "type": "string", "format": "date-time" }, "enforcement-level": { "type": "string" }, "stage": { "type": "string" }, "stages": { "type": "array", "items": { "type": "string" } }, "updated-at": { "type": "string", "format": "date-time" } } }, "id": { "type": "string" }, "relationships": { "type": "object", "properties": { "task": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } } } } }, "workspace": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } } } } } } }, "type": { "type": "string" } } } } }, "workspace_change_requests-collection": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "archived-at": { "nullable": true }, "archived-by": { "nullable": true }, "created-at": { "type": "string", "format": "date-time" }, "created-by": { "type": "string", "format": "uuid" }, "message": { "type": "string" }, "subject": { "type": "string" }, "updated-at": { "type": "string", "format": "date-time" }, "workspace-name": { "type": "string" } } }, "id": { "type": "string" }, "relationships": { "type": "object", "properties": { "workspace": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } } } } } } }, "type": { "type": "string" } } } }, "meta": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "current-page": { "type": "integer" }, "next-page": { "nullable": true }, "page-size": { "type": "integer" }, "prev-page": { "nullable": true }, "total-count": { "type": "integer" }, "total-pages": { "type": "integer" } } } } } } }, "workspace_change_requests-response": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "archived-at": { "type": "string", "format": "date-time" }, "archived-by": { "type": "string", "format": "uuid" }, "created-at": { "type": "string", "format": "date-time" }, "created-by": { "type": "string", "format": "uuid" }, "message": { "type": "string" }, "subject": { "type": "string" }, "updated-at": { "type": "string", "format": "date-time" } } }, "id": { "type": "string" }, "relationships": { "type": "object", "properties": { "workspace": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } } } } } } }, "type": { "type": "string" } } } } }, "workspaces-collection": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "actions": { "type": "object", "properties": { "is-destroyable": { "type": "boolean" } } }, "agent-pool-id": { "nullable": true }, "allow-destroy-plan": { "type": "boolean" }, "assessments-enabled": { "type": "boolean" }, "auto-apply": { "type": "boolean" }, "auto-apply-run-trigger": { "type": "boolean" }, "auto-queue-runs": { "type": "boolean" }, "created-at": { "type": "string", "format": "date-time" }, "description": { "type": "string" }, "environment": { "type": "string" }, "execution-mode": { "type": "string" }, "file-triggers-enabled": { "type": "boolean" }, "force-delete": { "type": "boolean" }, "global-remote-state": { "type": "boolean" }, "latest-change-at": { "type": "string", "format": "date-time" }, "locked": { "type": "boolean" }, "locked-reason": { "nullable": true }, "name": { "type": "string" }, "operations": { "type": "boolean" }, "permissions": { "type": "object", "properties": { "can-destroy": { "type": "boolean" }, "can-force-delete": { "type": "boolean" }, "can-force-unlock": { "type": "boolean" }, "can-lock": { "type": "boolean" }, "can-queue-destroy": { "type": "boolean" }, "can-queue-run": { "type": "boolean" }, "can-read-settings": { "type": "boolean" }, "can-unlock": { "type": "boolean" }, "can-update": { "type": "boolean" }, "can-update-variable": { "type": "boolean" } } }, "queue-all-runs": { "type": "boolean" }, "resource-count": { "type": "string" }, "run-timeout": { "type": "string" }, "setting-overwrites": { "type": "object", "properties": { "agent-pool": { "type": "boolean" }, "execution-mode": { "type": "boolean" } } }, "source": { "type": "string" }, "speculative-enabled": { "type": "boolean" }, "structured-run-output-enabled": { "type": "boolean" }, "tag-names": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "terraform-version": { "type": "string" }, "trigger-patterns": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "trigger-prefixes": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "updated-at": { "type": "string", "format": "date-time" }, "vcs-repo": { "nullable": true }, "working-directory": { "type": "string" } } }, "id": { "type": "string" }, "relationships": { "type": "object", "properties": { "agent-pool": { "type": "object", "properties": { "data": { "nullable": true } } }, "current-run": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } } } } }, "organization": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } } } } }, "project": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } } } }, "type": { "type": "string" } } } }, "included": { "type": "array", "items": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "completed-at": { "type": "string", "format": "date-time" }, "created-at": { "type": "string", "format": "date-time" }, "has-changes": { "type": "boolean" }, "is-destroy": { "type": "boolean" }, "operation": { "type": "string" }, "permissions": { "type": "object", "properties": { "can-apply": { "type": "boolean" } } }, "plan-only": { "type": "boolean" }, "status": { "type": "string" }, "updated-at": { "type": "string", "format": "date-time" } } }, "id": { "type": "string" }, "relationships": { "type": "object", "properties": { "workspace": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } } } } } } }, "type": { "type": "string" } } } }, "meta": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "current-page": { "type": "string" }, "next-page": { "nullable": true }, "page-size": { "type": "string" }, "prev-page": { "nullable": true }, "total-count": { "type": "string" }, "total-pages": { "type": "string" } } } } } } }, "workspaces-response": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "actions": { "type": "object", "properties": { "is-destroyable": { "type": "boolean" } } }, "agent-pool-id": { "nullable": true }, "allow-destroy-plan": { "type": "boolean" }, "assessments-enabled": { "type": "boolean" }, "auto-apply": { "type": "boolean" }, "auto-apply-run-trigger": { "type": "boolean" }, "auto-queue-runs": { "type": "boolean" }, "created-at": { "type": "string", "format": "date-time" }, "description": { "type": "string" }, "environment": { "type": "string" }, "execution-mode": { "type": "string" }, "file-triggers-enabled": { "type": "boolean" }, "force-delete": { "type": "boolean" }, "global-remote-state": { "type": "boolean" }, "latest-change-at": { "type": "string", "format": "date-time" }, "locked": { "type": "boolean" }, "locked-at": { "type": "string", "format": "date-time" }, "locked-reason": { "type": "string", "nullable": true }, "name": { "type": "string" }, "operations": { "type": "boolean" }, "permissions": { "type": "object", "properties": { "can-destroy": { "type": "boolean" }, "can-force-delete": { "type": "boolean" }, "can-force-unlock": { "type": "boolean" }, "can-lock": { "type": "boolean" }, "can-queue-destroy": { "type": "boolean" }, "can-queue-run": { "type": "boolean" }, "can-read-settings": { "type": "boolean" }, "can-unlock": { "type": "boolean" }, "can-update": { "type": "boolean" }, "can-update-variable": { "type": "boolean" } } }, "queue-all-runs": { "type": "boolean" }, "resource-count": { "type": "integer" }, "run-timeout": { "type": "integer" }, "setting-overwrites": { "type": "object", "properties": { "agent-pool": { "type": "boolean" }, "execution-mode": { "type": "boolean" } } }, "source": { "type": "string" }, "speculative-enabled": { "type": "boolean" }, "structured-run-output-enabled": { "type": "boolean" }, "tag-names": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "terraform-version": { "type": "string" }, "trigger-patterns": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "trigger-prefixes": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "updated-at": { "type": "string", "format": "date-time" }, "vcs-repo": { "nullable": true }, "working-directory": { "type": "string" } } }, "id": { "type": "string" }, "relationships": { "type": "object", "properties": { "agent-pool": { "type": "object", "properties": { "data": { "nullable": true } } }, "locked-by": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } }, "links": { "type": "object", "properties": { "related": { "type": "string" } } } } }, "organization": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } } } } }, "project": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } } } } }, "type": { "type": "string" } } } } } } }, "info": { "description": "The Stackweaver REST API. Terraform-related endpoints are wire-compatible with the Terraform Enterprise API so that terraform-provider-tfe and go-tfe work unmodified; the Ansible, registry, runner and settings surfaces are Stackweaver's own.", "license": { "name": "BUSL-1.1" }, "title": "Stackweaver API", "version": "2.0.0" }, "openapi": "3.0.3", "paths": { "/.well-known/jwks": { "get": { "description": "Not recorded by the golden harness: publishes an ephemeral per-process RSA key; the modulus differs every run", "operationId": "get--well-known-jwks", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/jwks" } } }, "description": "JSON Web Key Set for verifying workload identity tokens." } }, "summary": "GET /.well-known/jwks", "tags": [ ".well-known" ] } }, "/.well-known/openid-configuration": { "get": { "operationId": "get--well-known-openid-configuration", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/get--well-known-openid-configuration-8d57a4" } } }, "description": "Success" } }, "summary": "GET /.well-known/openid-configuration", "tags": [ ".well-known" ] } }, "/.well-known/terraform.json": { "get": { "operationId": "get--well-known-terraform-json", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/get--well-known-terraform-json-357035" } } }, "description": "Success" } }, "summary": "GET /.well-known/terraform.json", "tags": [ ".well-known" ] } }, "/api/registry/{registry}/v2/gpg-keys": { "get": { "operationId": "get-api-registry-registry-v2-gpg-keys", "parameters": [ { "in": "path", "name": "registry", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "filter[namespace]", "required": false, "schema": { "type": "string" } } ], "responses": { "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-400" } } }, "description": "Bad Request" } }, "summary": "GET /api/registry/:registry/v2/gpg-keys", "tags": [ "api" ] }, "post": { "operationId": "post-api-registry-registry-v2-gpg-keys", "parameters": [ { "in": "path", "name": "registry", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": { "attributes": { "ascii-armor": "-----BEGIN PGP PUBLIC KEY BLOCK-----\n\nxjMEas0K1hYJKwYBBAHaRw8BAQdAh01KN8xf8Ktli4eVGbLFxniuogsxNQxnkV1/\nz3D+I/zNKUV4YW1wbGUgUHVibGlzaGVyIDxwdWJsaXNoZXJAZXhhbXBsZS5jb20+\nwr0EExYIAG8FgmrNCtYCCwcJEJ/eqepw/6osNRQAAAAAABwAEHNhbHRAbm90YXRp\nb25zLm9wZW5wZ3Bqcy5vcmeSBhf5NmyOW5uc03S3sOYmAhUIAhYAAhkBApsDAh4B\nFiEE04bZtLiGDFZM0bvln96p6nD/qiwAADwPAQC8R5butyQqGWZLIfEYoWR56NTz\npEJBrNGpdUBoJ4hV9QEAvIruX8dWCXK6DYxJchtTI44QKXVPlNV14JgdX660pgPO\nOARqzQrWEgorBgEEAZdVAQUBAQdAor8PZLBVOUKLMrYzZ7Uir1rzd/QJ/l+UJV7Y\n0wnU+BADAQoJwq4EGBYIAGAFgmrNCtYJEJ/eqepw/6osNRQAAAAAABwAEHNhbHRA\nbm90YXRpb25zLm9wZW5wZ3Bqcy5vcmerHCZzfOX7oKC5zqSJn+CWApsMFiEE04bZ\ntLiGDFZM0bvln96p6nD/qiwAANStAQDdiHiEp7Zr878xnS3l66bH2QvdTy8DYoEa\nB0l9PmhDbAEAitlue+AM5KjGbnJ6GQGyMUh+rsWJbMXxX72b1pPlfg0=\n=MEZv\n-----END PGP PUBLIC KEY BLOCK-----\n", "namespace": "demo" }, "type": "gpg-keys" } }, "schema": { "$ref": "#/components/schemas/post-api-registry-registry-v2-gpg-keys-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders." }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/gpg-keys-response" } } }, "description": "Success" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "POST /api/registry/:registry/v2/gpg-keys", "tags": [ "api" ] } }, "/api/registry/{registry}/v2/gpg-keys/{namespace}/{key_id}": { "delete": { "description": "Takes no request body.", "operationId": "delete-api-registry-registry-v2-gpg-keys-namespace-key_id", "parameters": [ { "in": "path", "name": "registry", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "key_id", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success. No content." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "DELETE /api/registry/:registry/v2/gpg-keys/:namespace/:key_id", "tags": [ "api" ] }, "get": { "operationId": "get-api-registry-registry-v2-gpg-keys-namespace-key_id", "parameters": [ { "in": "path", "name": "registry", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "key_id", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "GET /api/registry/:registry/v2/gpg-keys/:namespace/:key_id", "tags": [ "api" ] }, "patch": { "description": "Takes no request body.", "operationId": "patch-api-registry-registry-v2-gpg-keys-namespace-key_id", "parameters": [ { "in": "path", "name": "registry", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "key_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/gpg-keys-response" } } }, "description": "Success" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "PATCH /api/registry/:registry/v2/gpg-keys/:namespace/:key_id", "tags": [ "api" ] } }, "/api/v2/account/details": { "get": { "operationId": "get-api-v2-account-details", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/users-response" } } }, "description": "Success" } }, "summary": "GET /api/v2/account/details", "tags": [ "account" ] } }, "/api/v2/account/update": { "patch": { "operationId": "patch-api-v2-account-update", "requestBody": { "content": { "application/json": { "example": { "data": { "attributes": { "bio": "Recorded by the golden write harness", "company": "VH \u0026 Co", "email": "golden.recorder@stackweaver.local", "location": "Antwerp, Belgium", "name": "Golden Recorder", "username": "\u003clogin-name\u003e" }, "type": "users" } }, "schema": { "$ref": "#/components/schemas/patch-api-v2-account-update-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/users-response" } } }, "description": "Success" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-403" } } }, "description": "Forbidden" } }, "summary": "PATCH /api/v2/account/update", "tags": [ "account" ] } }, "/api/v2/activities": { "get": { "operationId": "get-api-v2-activities", "parameters": [ { "in": "query", "name": "action", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "organization_id", "required": false, "schema": { "type": "string" } }, { "description": "Which page to return, 1-based.", "in": "query", "name": "page[number]", "required": false, "schema": { "type": "integer" } }, { "description": "Rows per page. Clamped to the endpoint's maximum; a value below 1 falls back to its default.", "in": "query", "name": "page[size]", "required": false, "schema": { "type": "integer" } }, { "in": "query", "name": "resource_type", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "user_id", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "workspace_id", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/get-api-v2-activities-2699a0" } } }, "description": "Success" } }, "summary": "GET /api/v2/activities", "tags": [ "activities" ] } }, "/api/v2/activities/recent": { "get": { "operationId": "get-api-v2-activities-recent", "parameters": [ { "description": "The most to return in one response.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" } }, { "in": "query", "name": "organization_id", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/get-api-v2-activities-recent-2118da" } } }, "description": "Success" } }, "summary": "GET /api/v2/activities/recent", "tags": [ "activities" ] } }, "/api/v2/admin/organizations": { "get": { "operationId": "get-api-v2-admin-organizations", "parameters": [ { "description": "Which page to return, 1-based.", "in": "query", "name": "page[number]", "required": false, "schema": { "type": "integer" } }, { "description": "Rows per page. Clamped to the endpoint's maximum; a value below 1 falls back to its default.", "in": "query", "name": "page[size]", "required": false, "schema": { "type": "integer" } }, { "in": "query", "name": "q", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "q[email]", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "q[name]", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/organizations-collection" } } }, "description": "Success" } }, "summary": "GET /api/v2/admin/organizations", "tags": [ "admin" ] } }, "/api/v2/admin/organizations/{name}": { "get": { "operationId": "get-api-v2-admin-organizations-name", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/organizations-response" } } }, "description": "Success" } }, "summary": "GET /api/v2/admin/organizations/:name", "tags": [ "admin" ] } }, "/api/v2/admin/terraform-versions": { "get": { "operationId": "get-api-v2-admin-terraform-versions", "parameters": [ { "in": "query", "name": "filter[version]", "required": false, "schema": { "type": "string" } }, { "description": "Which page to return, 1-based.", "in": "query", "name": "page[number]", "required": false, "schema": { "type": "integer" } }, { "description": "Rows per page. Clamped to the endpoint's maximum; a value below 1 falls back to its default.", "in": "query", "name": "page[size]", "required": false, "schema": { "type": "integer" } }, { "in": "query", "name": "search[version]", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/terraform-versions-collection" } } }, "description": "Success" } }, "summary": "GET /api/v2/admin/terraform-versions", "tags": [ "admin" ] }, "post": { "operationId": "post-api-v2-admin-terraform-versions", "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": { "attributes": { "archs": [ { "arch": "amd64", "os": "linux", "sha": "5f2b1c0a9d8e7f6a5b4c3d2e1f0a9b8c7d6e5f4a3b2c1d0e9f8a7b6c5d4e3f2a", "url": "https://mirror.example.com/opentofu/1.6.0-rc1/tofu_1.6.0-rc1_linux_amd64.zip" } ], "beta": true, "enabled": true, "official": false, "sha": "5f2b1c0a9d8e7f6a5b4c3d2e1f0a9b8c7d6e5f4a3b2c1d0e9f8a7b6c5d4e3f2a", "url": "https://mirror.example.com/opentofu/1.6.0-rc1/tofu_1.6.0-rc1_linux_amd64.zip", "version": "1.6.0-rc1" }, "type": "terraform-versions" } }, "schema": { "$ref": "#/components/schemas/post-api-v2-admin-terraform-versions-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders." }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/terraform-versions-response" } } }, "description": "Success" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-422" } } }, "description": "Unprocessable Entity" } }, "summary": "POST /api/v2/admin/terraform-versions", "tags": [ "admin" ] } }, "/api/v2/admin/terraform-versions/{id}": { "delete": { "description": "Takes no request body.", "operationId": "delete-api-v2-admin-terraform-versions-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success. No content." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "DELETE /api/v2/admin/terraform-versions/:id", "tags": [ "admin" ] }, "get": { "operationId": "get-api-v2-admin-terraform-versions-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/terraform-versions-response" } } }, "description": "Success" } }, "summary": "GET /api/v2/admin/terraform-versions/:id", "tags": [ "admin" ] }, "patch": { "operationId": "patch-api-v2-admin-terraform-versions-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": { "attributes": { "deprecated": true, "deprecated-reason": "Superseded by a patched release; move workspaces off this version.", "enabled": false }, "type": "terraform-versions" } }, "schema": { "$ref": "#/components/schemas/patch-api-v2-admin-terraform-versions-id-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders." }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/terraform-versions-response" } } }, "description": "Success" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "PATCH /api/v2/admin/terraform-versions/:id", "tags": [ "admin" ] } }, "/api/v2/admin/users": { "get": { "operationId": "get-api-v2-admin-users", "parameters": [ { "in": "query", "name": "filter[admin]", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "filter[suspended]", "required": false, "schema": { "type": "string" } }, { "description": "Which page to return, 1-based.", "in": "query", "name": "page[number]", "required": false, "schema": { "type": "integer" } }, { "description": "Rows per page. Clamped to the endpoint's maximum; a value below 1 falls back to its default.", "in": "query", "name": "page[size]", "required": false, "schema": { "type": "integer" } }, { "in": "query", "name": "q", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/users-collection" } } }, "description": "Success" } }, "summary": "GET /api/v2/admin/users", "tags": [ "admin" ] } }, "/api/v2/admin/users/{id}/actions/grant_admin": { "post": { "description": "Takes no request body.", "operationId": "post-api-v2-admin-users-id-actions-grant_admin", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/users-response" } } }, "description": "Success" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "POST /api/v2/admin/users/:id/actions/grant_admin", "tags": [ "admin" ] } }, "/api/v2/admin/users/{id}/actions/revoke_admin": { "post": { "description": "Takes no request body.", "operationId": "post-api-v2-admin-users-id-actions-revoke_admin", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/users-response" } } }, "description": "Success" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "POST /api/v2/admin/users/:id/actions/revoke_admin", "tags": [ "admin" ] } }, "/api/v2/agent-pools/{id}": { "delete": { "description": "Takes no request body.", "operationId": "delete-api-v2-agent-pools-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success. No content." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "DELETE /api/v2/agent-pools/:id", "tags": [ "agent-pools" ] }, "get": { "operationId": "get-api-v2-agent-pools-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent-pools-response" } } }, "description": "Success" } }, "summary": "GET /api/v2/agent-pools/:id", "tags": [ "agent-pools" ] }, "patch": { "operationId": "patch-api-v2-agent-pools-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": { "attributes": { "name": "golden-write-renamed-pool", "organization-scoped": false }, "relationships": { "allowed-projects": { "data": [ { "id": "\u003cuuid\u003e", "type": "projects" } ] } }, "type": "agent-pools" } }, "schema": { "$ref": "#/components/schemas/patch-api-v2-agent-pools-id-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent-pools-response" } } }, "description": "Success" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "PATCH /api/v2/agent-pools/:id", "tags": [ "agent-pools" ] } }, "/api/v2/agent-pools/{id}/agents": { "get": { "operationId": "get-api-v2-agent-pools-id-agents", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agents-collection" } } }, "description": "Success" } }, "summary": "GET /api/v2/agent-pools/:id/agents", "tags": [ "agent-pools" ] } }, "/api/v2/agent-pools/{id}/authentication-tokens": { "get": { "operationId": "get-api-v2-agent-pools-id-authentication-tokens", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/get-api-v2-agent-pools-id-authentication-tokens-9c3bbd" } } }, "description": "Success" } }, "summary": "GET /api/v2/agent-pools/:id/authentication-tokens", "tags": [ "agent-pools" ] }, "post": { "operationId": "post-api-v2-agent-pools-id-authentication-tokens", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": { "attributes": { "description": "Runners in the eu-west-1 build cluster" }, "type": "authentication-tokens" } }, "schema": { "$ref": "#/components/schemas/post-api-v2-agent-pools-id-authentication-tokens-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders." }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/authentication-tokens-response" } } }, "description": "Success" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "POST /api/v2/agent-pools/:id/authentication-tokens", "tags": [ "agent-pools" ] } }, "/api/v2/agent-pools/{id}/queue-depth": { "get": { "operationId": "get-api-v2-agent-pools-id-queue-depth", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/queue-depths-response" } } }, "description": "Success" } }, "summary": "GET /api/v2/agent-pools/:id/queue-depth", "tags": [ "agent-pools" ] } }, "/api/v2/ansible/collections/pre-installed": { "get": { "operationId": "get-api-v2-ansible-collections-pre-installed", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ansible-collections-collection" } } }, "description": "Success" } }, "summary": "GET /api/v2/ansible/collections/pre-installed", "tags": [ "ansible/collections" ] } }, "/api/v2/ansible/collections/search": { "get": { "operationId": "get-api-v2-ansible-collections-search", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/get-api-v2-ansible-collections-search-dd1396" } } }, "description": "Success" } }, "summary": "GET /api/v2/ansible/collections/search", "tags": [ "ansible/collections" ] } }, "/api/v2/ansible/credentials/{id}": { "delete": { "description": "Takes no request body.", "operationId": "delete-api-v2-ansible-credentials-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success. No content." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "DELETE /api/v2/ansible/credentials/:id", "tags": [ "ansible/credentials" ] }, "get": { "operationId": "get-api-v2-ansible-credentials-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ansible-credentials-response" } } }, "description": "Success" } }, "summary": "GET /api/v2/ansible/credentials/:id", "tags": [ "ansible/credentials" ] }, "patch": { "operationId": "patch-api-v2-ansible-credentials-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": { "attributes": { "description": "Updated by the golden write harness", "password": "\u003csecret\u003e", "ssh-become-user": "admin", "ssh-port": 2200, "username": "ansible" }, "type": "ansible-credentials" } }, "schema": { "$ref": "#/components/schemas/patch-api-v2-ansible-credentials-id-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders." }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ansible-credentials-response" } } }, "description": "Success" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "PATCH /api/v2/ansible/credentials/:id", "tags": [ "ansible/credentials" ] } }, "/api/v2/ansible/groups/{id}": { "delete": { "description": "Takes no request body.", "operationId": "delete-api-v2-ansible-groups-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success. No content." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "DELETE /api/v2/ansible/groups/:id", "tags": [ "ansible/groups" ] }, "get": { "operationId": "get-api-v2-ansible-groups-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ansible-groups-response" } } }, "description": "Success" } }, "summary": "GET /api/v2/ansible/groups/:id", "tags": [ "ansible/groups" ] }, "patch": { "operationId": "patch-api-v2-ansible-groups-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": { "attributes": { "description": "Updated by the golden write harness", "variables": { "http_port": 8080, "max_clients": 200 } }, "type": "ansible-groups" } }, "schema": { "$ref": "#/components/schemas/patch-api-v2-ansible-groups-id-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders." }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ansible-groups-response" } } }, "description": "Success" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "PATCH /api/v2/ansible/groups/:id", "tags": [ "ansible/groups" ] } }, "/api/v2/ansible/hosts/{id}": { "delete": { "description": "Takes no request body.", "operationId": "delete-api-v2-ansible-hosts-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success. No content." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "DELETE /api/v2/ansible/hosts/:id", "tags": [ "ansible/hosts" ] }, "get": { "operationId": "get-api-v2-ansible-hosts-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ansible-hosts-response" } } }, "description": "Success" } }, "summary": "GET /api/v2/ansible/hosts/:id", "tags": [ "ansible/hosts" ] }, "patch": { "operationId": "patch-api-v2-ansible-hosts-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": { "attributes": { "description": "Updated by the golden write harness", "enabled": false, "hostname": "10.0.1.21", "port": 2222, "variables": { "ansible_user": "deploy" } }, "type": "ansible-hosts" } }, "schema": { "$ref": "#/components/schemas/patch-api-v2-ansible-hosts-id-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders." }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ansible-hosts-response" } } }, "description": "Success" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "PATCH /api/v2/ansible/hosts/:id", "tags": [ "ansible/hosts" ] } }, "/api/v2/ansible/hosts/{id}/groups/{group_id}": { "delete": { "description": "Takes no request body.", "operationId": "delete-api-v2-ansible-hosts-id-groups-group_id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "group_id", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success. No content." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "DELETE /api/v2/ansible/hosts/:id/groups/:group_id", "tags": [ "ansible/hosts" ] }, "post": { "description": "Takes no request body.", "operationId": "post-api-v2-ansible-hosts-id-groups-group_id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "group_id", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success. No content." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "POST /api/v2/ansible/hosts/:id/groups/:group_id", "tags": [ "ansible/hosts" ] } }, "/api/v2/ansible/inventories/{id}": { "delete": { "description": "Takes no request body.", "operationId": "delete-api-v2-ansible-inventories-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "force", "required": false, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success. No content." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "DELETE /api/v2/ansible/inventories/:id", "tags": [ "ansible/inventories" ] }, "get": { "operationId": "get-api-v2-ansible-inventories-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ansible-inventories-response" } } }, "description": "Success" } }, "summary": "GET /api/v2/ansible/inventories/:id", "tags": [ "ansible/inventories" ] }, "patch": { "operationId": "patch-api-v2-ansible-inventories-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": { "attributes": { "description": "Updated by the golden write harness", "variables": { "ansible_port": 2222, "ansible_user": "deploy" } }, "type": "inventories" } }, "schema": { "$ref": "#/components/schemas/patch-api-v2-ansible-inventories-id-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders." }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ansible-inventories-response" } } }, "description": "Success" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "PATCH /api/v2/ansible/inventories/:id", "tags": [ "ansible/inventories" ] } }, "/api/v2/ansible/inventories/{id}/actions/run-command": { "post": { "operationId": "post-api-v2-ansible-inventories-id-actions-run-command", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": { "attributes": { "become-enabled": true, "credential-id": "\u003cuuid\u003e", "forks": 10, "limit": "webservers", "module": "shell", "module-args": "uptime", "verbosity": 1 }, "type": "ansible-jobs" } }, "schema": { "$ref": "#/components/schemas/post-api-v2-ansible-inventories-id-actions-run-command-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders." }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post-api-v2-ansible-inventories-id-actions-run-command-response" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-400" } } }, "description": "Bad Request" } }, "summary": "POST /api/v2/ansible/inventories/:id/actions/run-command", "tags": [ "ansible/inventories" ] } }, "/api/v2/ansible/inventories/{id}/actions/sync": { "post": { "description": "Takes no request body.", "operationId": "post-api-v2-ansible-inventories-id-actions-sync", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ansible-inventories-response" } } }, "description": "Success" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "POST /api/v2/ansible/inventories/:id/actions/sync", "tags": [ "ansible/inventories" ] } }, "/api/v2/ansible/inventories/{id}/groups": { "get": { "operationId": "get-api-v2-ansible-inventories-id-groups", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "description": "Which page to return, 1-based.", "in": "query", "name": "page[number]", "required": false, "schema": { "type": "integer" } }, { "description": "Rows per page. Clamped to the endpoint's maximum; a value below 1 falls back to its default.", "in": "query", "name": "page[size]", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ansible-groups-collection" } } }, "description": "Success" } }, "summary": "GET /api/v2/ansible/inventories/:id/groups", "tags": [ "ansible/inventories" ] }, "post": { "operationId": "post-api-v2-ansible-inventories-id-groups", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": { "attributes": { "description": "Recorded by the golden write harness", "name": "webservers-eu", "variables": { "region": "eu-west-1" } }, "relationships": { "parent": { "data": { "id": "\u003cuuid\u003e", "type": "ansible-groups" } } }, "type": "ansible-groups" } }, "schema": { "$ref": "#/components/schemas/post-api-v2-ansible-inventories-id-groups-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders." }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ansible-groups-response" } } }, "description": "Success" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "POST /api/v2/ansible/inventories/:id/groups", "tags": [ "ansible/inventories" ] } }, "/api/v2/ansible/inventories/{id}/hosts": { "get": { "operationId": "get-api-v2-ansible-inventories-id-hosts", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "description": "Which page to return, 1-based.", "in": "query", "name": "page[number]", "required": false, "schema": { "type": "integer" } }, { "description": "Rows per page. Clamped to the endpoint's maximum; a value below 1 falls back to its default.", "in": "query", "name": "page[size]", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ansible-hosts-collection" } } }, "description": "Success" } }, "summary": "GET /api/v2/ansible/inventories/:id/hosts", "tags": [ "ansible/inventories" ] }, "post": { "operationId": "post-api-v2-ansible-inventories-id-hosts", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": { "attributes": { "description": "Recorded by the golden write harness", "enabled": true, "hostname": "10.0.1.12", "name": "web-02.demo.internal", "port": 22, "variables": { "ansible_user": "deploy", "http_port": 8080 } }, "type": "ansible-hosts" } }, "schema": { "$ref": "#/components/schemas/post-api-v2-ansible-inventories-id-hosts-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders." }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ansible-hosts-response" } } }, "description": "Success" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "POST /api/v2/ansible/inventories/:id/hosts", "tags": [ "ansible/inventories" ] } }, "/api/v2/ansible/inventories/{id}/ini": { "get": { "operationId": "get-api-v2-ansible-inventories-id-ini", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "text/plain": { "schema": { "type": "string" } } }, "description": "Success" } }, "summary": "GET /api/v2/ansible/inventories/:id/ini", "tags": [ "ansible/inventories" ] } }, "/api/v2/ansible/inventories/{id}/json": { "get": { "operationId": "get-api-v2-ansible-inventories-id-json", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/get-api-v2-ansible-inventories-id-json-710cec" } } }, "description": "Success" } }, "summary": "GET /api/v2/ansible/inventories/:id/json", "tags": [ "ansible/inventories" ] } }, "/api/v2/ansible/inventories/{id}/sources": { "get": { "operationId": "get-api-v2-ansible-inventories-id-sources", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "description": "Which page to return, 1-based.", "in": "query", "name": "page[number]", "required": false, "schema": { "type": "integer" } }, { "description": "Rows per page. Clamped to the endpoint's maximum; a value below 1 falls back to its default.", "in": "query", "name": "page[size]", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inventory-sources-collection" } } }, "description": "Success" } }, "summary": "GET /api/v2/ansible/inventories/:id/sources", "tags": [ "ansible/inventories" ] }, "post": { "operationId": "post-api-v2-ansible-inventories-id-sources", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": { "attributes": { "config": { "regions": [ "eu-central-1" ] }, "credential-id": "\u003cuuid\u003e", "description": "Recorded by the golden write harness", "group-by-region": true, "group-by-tag": "Environment", "hostname-var": "private_ip", "name": "aws-eu-central-1", "overwrite": true, "source-type": "aws", "sync-schedule": "0 */6 * * *", "update-cache-timeout": 300, "update-on-launch": true }, "type": "inventory-sources" } }, "schema": { "$ref": "#/components/schemas/post-api-v2-ansible-inventories-id-sources-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders." }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inventory-sources-response" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-400" } } }, "description": "Bad Request" } }, "summary": "POST /api/v2/ansible/inventories/:id/sources", "tags": [ "ansible/inventories" ] } }, "/api/v2/ansible/inventories/{id}/syncs": { "get": { "operationId": "get-api-v2-ansible-inventories-id-syncs", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "description": "Which page to return, 1-based.", "in": "query", "name": "page[number]", "required": false, "schema": { "type": "integer" } }, { "description": "Rows per page. Clamped to the endpoint's maximum; a value below 1 falls back to its default.", "in": "query", "name": "page[size]", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inventory-syncs-collection" } } }, "description": "Success" } }, "summary": "GET /api/v2/ansible/inventories/:id/syncs", "tags": [ "ansible/inventories" ] } }, "/api/v2/ansible/inventory-sources/{source_id}": { "delete": { "description": "Takes no request body.", "operationId": "delete-api-v2-ansible-inventory-sources-source_id", "parameters": [ { "in": "path", "name": "source_id", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success. No content." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "DELETE /api/v2/ansible/inventory-sources/:source_id", "tags": [ "ansible/inventory-sources" ] }, "get": { "operationId": "get-api-v2-ansible-inventory-sources-source_id", "parameters": [ { "in": "path", "name": "source_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inventory-sources-response" } } }, "description": "Success" } }, "summary": "GET /api/v2/ansible/inventory-sources/:source_id", "tags": [ "ansible/inventory-sources" ] }, "patch": { "operationId": "patch-api-v2-ansible-inventory-sources-source_id", "parameters": [ { "in": "path", "name": "source_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": { "attributes": { "config": { "regions": [ "eu-west-1", "eu-central-1" ] }, "description": "Updated by the golden write harness", "group-by-availability-zone": true, "overwrite-vars": true, "sync-schedule": "30 2 * * *", "update-cache-timeout": 600, "verbosity": 1 }, "type": "inventory-sources" } }, "schema": { "$ref": "#/components/schemas/patch-api-v2-ansible-inventory-sources-source_id-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders." }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inventory-sources-response" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-400" } } }, "description": "Bad Request" } }, "summary": "PATCH /api/v2/ansible/inventory-sources/:source_id", "tags": [ "ansible/inventory-sources" ] } }, "/api/v2/ansible/inventory-sources/{source_id}/actions/sync": { "post": { "description": "Takes no request body.", "operationId": "post-api-v2-ansible-inventory-sources-source_id-actions-sync", "parameters": [ { "in": "path", "name": "source_id", "required": true, "schema": { "type": "string" } } ], "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inventory-sources-response" } } }, "description": "Success" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "POST /api/v2/ansible/inventory-sources/:source_id/actions/sync", "tags": [ "ansible/inventory-sources" ] } }, "/api/v2/ansible/inventory-syncs/{sync_id}": { "get": { "operationId": "get-api-v2-ansible-inventory-syncs-sync_id", "parameters": [ { "in": "path", "name": "sync_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inventory-syncs-response" } } }, "description": "Success" } }, "summary": "GET /api/v2/ansible/inventory-syncs/:sync_id", "tags": [ "ansible/inventory-syncs" ] } }, "/api/v2/ansible/job-templates/{id}": { "delete": { "description": "Takes no request body.", "operationId": "delete-api-v2-ansible-job-templates-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success. No content." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "DELETE /api/v2/ansible/job-templates/:id", "tags": [ "ansible/job-templates" ] }, "get": { "operationId": "get-api-v2-ansible-job-templates-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ansible-job-templates-response" } } }, "description": "Success" } }, "summary": "GET /api/v2/ansible/job-templates/:id", "tags": [ "ansible/job-templates" ] }, "patch": { "operationId": "patch-api-v2-ansible-job-templates-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": { "attributes": { "allow-callbacks": true, "allow-simultaneous": true, "description": "Updated by the golden write harness", "extra-vars": { "compliance_profile": "cis-level-1" }, "forks": 20, "limit": "webservers", "timeout-seconds": 1800 }, "relationships": { "credentials": { "data": [ { "id": "\u003cuuid\u003e", "type": "ansible-credentials" } ] } }, "type": "ansible-job-templates" } }, "schema": { "$ref": "#/components/schemas/patch-api-v2-ansible-job-templates-id-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders." }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ansible-job-templates-response" } } }, "description": "Success" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "PATCH /api/v2/ansible/job-templates/:id", "tags": [ "ansible/job-templates" ] } }, "/api/v2/ansible/job-templates/{id}/access": { "get": { "operationId": "get-api-v2-ansible-job-templates-id-access", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/team-access-collection" } } }, "description": "Success" } }, "summary": "GET /api/v2/ansible/job-templates/:id/access", "tags": [ "ansible/job-templates" ] } }, "/api/v2/ansible/job-templates/{id}/callback": { "post": { "operationId": "post-api-v2-ansible-job-templates-id-callback", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.api+json": { "example": { "host_config_key": "\u003csecret\u003e" }, "schema": { "$ref": "#/components/schemas/post-api-v2-ansible-job-templates-id-callback-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders." }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ansible-jobs-response" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-400" } } }, "description": "Bad Request" } }, "summary": "POST /api/v2/ansible/job-templates/:id/callback", "tags": [ "ansible/job-templates" ] } }, "/api/v2/ansible/job-templates/{id}/credentials": { "get": { "operationId": "get-api-v2-ansible-job-templates-id-credentials", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/get-api-v2-ansible-job-templates-id-credentials-10f3a1" } } }, "description": "Success" } }, "summary": "GET /api/v2/ansible/job-templates/:id/credentials", "tags": [ "ansible/job-templates" ] }, "post": { "operationId": "post-api-v2-ansible-job-templates-id-credentials", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": { "id": "\u003cuuid\u003e", "type": "ansible-credentials" } }, "schema": { "$ref": "#/components/schemas/post-api-v2-ansible-job-templates-id-credentials-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders.", "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ansible-credentials-response" } } }, "description": "Success" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "POST /api/v2/ansible/job-templates/:id/credentials", "tags": [ "ansible/job-templates" ] } }, "/api/v2/ansible/job-templates/{id}/credentials/{credential_id}": { "delete": { "description": "Takes no request body.", "operationId": "delete-api-v2-ansible-job-templates-id-credentials-credential_id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "credential_id", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success. No content." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "DELETE /api/v2/ansible/job-templates/:id/credentials/:credential_id", "tags": [ "ansible/job-templates" ] } }, "/api/v2/ansible/job-templates/{id}/launch": { "post": { "operationId": "post-api-v2-ansible-job-templates-id-launch", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": { "attributes": { "extra-vars": { "release": "1.4.2" }, "limit": "web" }, "type": "ansible-jobs" } }, "schema": { "$ref": "#/components/schemas/post-api-v2-ansible-job-templates-id-launch-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders." }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post-api-v2-ansible-job-templates-id-launch-response" } } }, "description": "Success" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "POST /api/v2/ansible/job-templates/:id/launch", "tags": [ "ansible/job-templates" ] } }, "/api/v2/ansible/job-templates/{id}/notifications": { "get": { "operationId": "get-api-v2-ansible-job-templates-id-notifications", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/get-api-v2-ansible-job-templates-id-notifications-dcfe45" } } }, "description": "Success" } }, "summary": "GET /api/v2/ansible/job-templates/:id/notifications", "tags": [ "ansible/job-templates" ] } }, "/api/v2/ansible/job-templates/{id}/variable-sets": { "get": { "operationId": "get-api-v2-ansible-job-templates-id-variable-sets", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/varsets-collection" } } }, "description": "Success" } }, "summary": "GET /api/v2/ansible/job-templates/:id/variable-sets", "tags": [ "ansible/job-templates" ] } }, "/api/v2/ansible/job-templates/{id}/vars": { "get": { "operationId": "get-api-v2-ansible-job-templates-id-vars", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/get-api-v2-ansible-job-templates-id-vars-1d29e9" } } }, "description": "Success" } }, "summary": "GET /api/v2/ansible/job-templates/:id/vars", "tags": [ "ansible/job-templates" ] }, "post": { "operationId": "post-api-v2-ansible-job-templates-id-vars", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": { "attributes": { "category": "env", "description": "Recorded by the golden write harness", "key": "app_version", "sensitive": false, "value": "1.4.2" }, "type": "vars" } }, "schema": { "$ref": "#/components/schemas/post-api-v2-ansible-job-templates-id-vars-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders." }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vars-response" } } }, "description": "Success" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "POST /api/v2/ansible/job-templates/:id/vars", "tags": [ "ansible/job-templates" ] } }, "/api/v2/ansible/job-templates/{id}/vars/{variable_id}": { "delete": { "description": "Takes no request body.", "operationId": "delete-api-v2-ansible-job-templates-id-vars-variable_id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "variable_id", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success. No content." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "DELETE /api/v2/ansible/job-templates/:id/vars/:variable_id", "tags": [ "ansible/job-templates" ] }, "patch": { "operationId": "patch-api-v2-ansible-job-templates-id-vars-variable_id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "variable_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": { "attributes": { "description": "Updated by the golden write harness", "key": "app_version", "value": "1.5.0" }, "type": "vars" } }, "schema": { "$ref": "#/components/schemas/patch-api-v2-ansible-job-templates-id-vars-variable_id-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders." }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vars-response" } } }, "description": "Success" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "PATCH /api/v2/ansible/job-templates/:id/vars/:variable_id", "tags": [ "ansible/job-templates" ] } }, "/api/v2/ansible/jobs/{id}": { "delete": { "description": "Takes no request body.", "operationId": "delete-api-v2-ansible-jobs-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success. No content." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "DELETE /api/v2/ansible/jobs/:id", "tags": [ "ansible/jobs" ] }, "get": { "operationId": "get-api-v2-ansible-jobs-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ansible-jobs-response" } } }, "description": "Success" } }, "summary": "GET /api/v2/ansible/jobs/:id", "tags": [ "ansible/jobs" ] } }, "/api/v2/ansible/jobs/{id}/actions/cancel": { "post": { "description": "Takes no request body.", "operationId": "post-api-v2-ansible-jobs-id-actions-cancel", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post-api-v2-ansible-jobs-id-actions-cancel-response" } } }, "description": "Success" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "POST /api/v2/ansible/jobs/:id/actions/cancel", "tags": [ "ansible/jobs" ] } }, "/api/v2/ansible/jobs/{id}/actions/relaunch": { "post": { "description": "Takes no request body.", "operationId": "post-api-v2-ansible-jobs-id-actions-relaunch", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post-api-v2-ansible-jobs-id-actions-relaunch-response" } } }, "description": "Success" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "POST /api/v2/ansible/jobs/:id/actions/relaunch", "tags": [ "ansible/jobs" ] } }, "/api/v2/ansible/jobs/{id}/collections": { "get": { "operationId": "get-api-v2-ansible-jobs-id-collections", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ansible-collections-collection" } } }, "description": "Success" } }, "summary": "GET /api/v2/ansible/jobs/:id/collections", "tags": [ "ansible/jobs" ] } }, "/api/v2/ansible/jobs/{id}/events": { "get": { "operationId": "get-api-v2-ansible-jobs-id-events", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "after", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "fields[events]", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "filter[counter]", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "filter[host]", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "filter[status]", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "filter[task]", "required": false, "schema": { "type": "string" } }, { "description": "Which page to return, 1-based.", "in": "query", "name": "page[number]", "required": false, "schema": { "type": "integer" } }, { "description": "Rows per page. Clamped to the endpoint's maximum; a value below 1 falls back to its default.", "in": "query", "name": "page[size]", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/get-api-v2-ansible-jobs-id-events-40dd40" } } }, "description": "Success" } }, "summary": "GET /api/v2/ansible/jobs/:id/events", "tags": [ "ansible/jobs" ] } }, "/api/v2/ansible/jobs/{id}/output": { "get": { "operationId": "get-api-v2-ansible-jobs-id-output", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/get-api-v2-ansible-jobs-id-output-02cdaf" } } }, "description": "Success" } }, "summary": "GET /api/v2/ansible/jobs/:id/output", "tags": [ "ansible/jobs" ] } }, "/api/v2/ansible/notification-templates/{id}": { "delete": { "description": "Takes no request body.", "operationId": "delete-api-v2-ansible-notification-templates-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success. No content." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "DELETE /api/v2/ansible/notification-templates/:id", "tags": [ "ansible/notification-templates" ] }, "patch": { "operationId": "patch-api-v2-ansible-notification-templates-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": { "attributes": { "config": { "method": "PUT", "skip_tls_verify": false, "url": "https://hooks.example.com/stackweaver/releases", "username": "stackweaver" }, "description": "Updated by the golden write harness", "name": "golden-write-webhook", "secret": "\u003csecret\u003e" }, "type": "ansible-notification-templates" } }, "schema": { "$ref": "#/components/schemas/patch-api-v2-ansible-notification-templates-id-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ansible-notification-templates-response" } } }, "description": "Success" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "PATCH /api/v2/ansible/notification-templates/:id", "tags": [ "ansible/notification-templates" ] } }, "/api/v2/ansible/notification-templates/{id}/test": { "post": { "description": "Takes no request body.", "operationId": "post-api-v2-ansible-notification-templates-id-test", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success. No content." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "POST /api/v2/ansible/notification-templates/:id/test", "tags": [ "ansible/notification-templates" ] } }, "/api/v2/ansible/playbooks/{id}": { "delete": { "description": "Takes no request body.", "operationId": "delete-api-v2-ansible-playbooks-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "force", "required": false, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success. No content." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "DELETE /api/v2/ansible/playbooks/:id", "tags": [ "ansible/playbooks" ] }, "get": { "operationId": "get-api-v2-ansible-playbooks-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ansible-playbooks-response" } } }, "description": "Success" } }, "summary": "GET /api/v2/ansible/playbooks/:id", "tags": [ "ansible/playbooks" ] }, "patch": { "operationId": "patch-api-v2-ansible-playbooks-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": { "attributes": { "description": "Updated by the golden write harness", "playbook-path": "playbooks/deploy-app.yml", "source-mode": "cached", "vcs-branch": "release" }, "type": "ansible-playbooks" } }, "schema": { "$ref": "#/components/schemas/patch-api-v2-ansible-playbooks-id-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders." }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ansible-playbooks-response" } } }, "description": "Success" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "PATCH /api/v2/ansible/playbooks/:id", "tags": [ "ansible/playbooks" ] } }, "/api/v2/ansible/playbooks/{id}/actions/sync": { "post": { "description": "Takes no request body.", "operationId": "post-api-v2-ansible-playbooks-id-actions-sync", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ansible-playbooks-response" } } }, "description": "Success" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "POST /api/v2/ansible/playbooks/:id/actions/sync", "tags": [ "ansible/playbooks" ] } }, "/api/v2/ansible/schedules/{schedule_id}": { "delete": { "description": "Takes no request body.", "operationId": "delete-api-v2-ansible-schedules-schedule_id", "parameters": [ { "in": "path", "name": "schedule_id", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success. No content." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "DELETE /api/v2/ansible/schedules/:schedule_id", "tags": [ "ansible/schedules" ] }, "get": { "operationId": "get-api-v2-ansible-schedules-schedule_id", "parameters": [ { "in": "path", "name": "schedule_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schedules-response" } } }, "description": "Success" } }, "summary": "GET /api/v2/ansible/schedules/:schedule_id", "tags": [ "ansible/schedules" ] }, "patch": { "operationId": "patch-api-v2-ansible-schedules-schedule_id", "parameters": [ { "in": "path", "name": "schedule_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": { "attributes": { "config": { "extra_vars": { "reboot": false } }, "cron-expression": "15 1 * * *", "description": "Updated by the golden write harness", "name": "nightly-patch-baseline", "timezone": "Europe/Brussels" }, "type": "schedules" } }, "schema": { "$ref": "#/components/schemas/patch-api-v2-ansible-schedules-schedule_id-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schedules-response" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-400" } } }, "description": "Bad Request" } }, "summary": "PATCH /api/v2/ansible/schedules/:schedule_id", "tags": [ "ansible/schedules" ] } }, "/api/v2/ansible/schedules/{schedule_id}/actions/disable": { "post": { "description": "Takes no request body.", "operationId": "post-api-v2-ansible-schedules-schedule_id-actions-disable", "parameters": [ { "in": "path", "name": "schedule_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schedules-response" } } }, "description": "Success" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "POST /api/v2/ansible/schedules/:schedule_id/actions/disable", "tags": [ "ansible/schedules" ] } }, "/api/v2/ansible/schedules/{schedule_id}/actions/enable": { "post": { "description": "Takes no request body.", "operationId": "post-api-v2-ansible-schedules-schedule_id-actions-enable", "parameters": [ { "in": "path", "name": "schedule_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schedules-response" } } }, "description": "Success" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "POST /api/v2/ansible/schedules/:schedule_id/actions/enable", "tags": [ "ansible/schedules" ] } }, "/api/v2/ansible/schedules/{schedule_id}/actions/run-now": { "post": { "description": "Takes no request body.", "operationId": "post-api-v2-ansible-schedules-schedule_id-actions-run-now", "parameters": [ { "in": "path", "name": "schedule_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schedules-response" } } }, "description": "Success" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "POST /api/v2/ansible/schedules/:schedule_id/actions/run-now", "tags": [ "ansible/schedules" ] } }, "/api/v2/ansible/workflow-edges/{id}": { "delete": { "description": "Takes no request body.", "operationId": "delete-api-v2-ansible-workflow-edges-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success. No content." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "DELETE /api/v2/ansible/workflow-edges/:id", "tags": [ "ansible/workflow-edges" ] } }, "/api/v2/ansible/workflow-jobs/{id}": { "get": { "operationId": "get-api-v2-ansible-workflow-jobs-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ansible-workflow-jobs-response" } } }, "description": "Success" } }, "summary": "GET /api/v2/ansible/workflow-jobs/:id", "tags": [ "ansible/workflow-jobs" ] } }, "/api/v2/ansible/workflow-node-jobs/{id}/approve": { "post": { "description": "Takes no request body.", "operationId": "post-api-v2-ansible-workflow-node-jobs-id-approve", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success. No content." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "POST /api/v2/ansible/workflow-node-jobs/:id/approve", "tags": [ "ansible/workflow-node-jobs" ] } }, "/api/v2/ansible/workflow-node-jobs/{id}/deny": { "post": { "description": "Takes no request body.", "operationId": "post-api-v2-ansible-workflow-node-jobs-id-deny", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success. No content." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "POST /api/v2/ansible/workflow-node-jobs/:id/deny", "tags": [ "ansible/workflow-node-jobs" ] } }, "/api/v2/ansible/workflow-nodes/{id}": { "delete": { "description": "Takes no request body.", "operationId": "delete-api-v2-ansible-workflow-nodes-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success. No content." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "DELETE /api/v2/ansible/workflow-nodes/:id", "tags": [ "ansible/workflow-nodes" ] }, "patch": { "operationId": "patch-api-v2-ansible-workflow-nodes-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": { "attributes": { "extra-vars": "{\"reboot\":false}", "limit": "webservers", "position-x": 80, "position-y": 120, "skip-tags": "slow", "verbosity": 2 }, "type": "ansible-workflow-nodes" } }, "schema": { "$ref": "#/components/schemas/patch-api-v2-ansible-workflow-nodes-id-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders." }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ansible-workflow-nodes-response" } } }, "description": "Success" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "PATCH /api/v2/ansible/workflow-nodes/:id", "tags": [ "ansible/workflow-nodes" ] } }, "/api/v2/ansible/workflows/{id}": { "delete": { "description": "Takes no request body.", "operationId": "delete-api-v2-ansible-workflows-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success. No content." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "DELETE /api/v2/ansible/workflows/:id", "tags": [ "ansible/workflows" ] }, "get": { "operationId": "get-api-v2-ansible-workflows-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ansible-workflows-response" } } }, "description": "Success" } }, "summary": "GET /api/v2/ansible/workflows/:id", "tags": [ "ansible/workflows" ] }, "patch": { "operationId": "patch-api-v2-ansible-workflows-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": { "attributes": { "allow-simultaneous": true, "ask-inventory-on-launch": true, "description": "Updated by the golden write harness", "extra-vars": "{\"environment\":\"production\",\"canary\":true}", "limit": "webservers" }, "type": "ansible-workflows" } }, "schema": { "$ref": "#/components/schemas/patch-api-v2-ansible-workflows-id-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders." }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ansible-workflows-response" } } }, "description": "Success" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "PATCH /api/v2/ansible/workflows/:id", "tags": [ "ansible/workflows" ] } }, "/api/v2/ansible/workflows/{id}/edges": { "get": { "operationId": "get-api-v2-ansible-workflows-id-edges", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/get-api-v2-ansible-workflows-id-edges-555fc9" } } }, "description": "Success" } }, "summary": "GET /api/v2/ansible/workflows/:id/edges", "tags": [ "ansible/workflows" ] }, "post": { "operationId": "post-api-v2-ansible-workflows-id-edges", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": { "attributes": { "condition": "on_success" }, "relationships": { "source-node": { "data": { "id": "\u003cuuid\u003e", "type": "ansible-workflow-nodes" } }, "target-node": { "data": { "id": "\u003cuuid\u003e", "type": "ansible-workflow-nodes" } } }, "type": "ansible-workflow-edges" } }, "schema": { "$ref": "#/components/schemas/post-api-v2-ansible-workflows-id-edges-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders." }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ansible-workflow-edges-response" } } }, "description": "Success" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "POST /api/v2/ansible/workflows/:id/edges", "tags": [ "ansible/workflows" ] } }, "/api/v2/ansible/workflows/{id}/jobs": { "get": { "operationId": "get-api-v2-ansible-workflows-id-jobs", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "description": "Which page to return, 1-based.", "in": "query", "name": "page[number]", "required": false, "schema": { "type": "integer" } }, { "description": "Rows per page. Clamped to the endpoint's maximum; a value below 1 falls back to its default.", "in": "query", "name": "page[size]", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ansible-workflow-jobs-collection" } } }, "description": "Success" } }, "summary": "GET /api/v2/ansible/workflows/:id/jobs", "tags": [ "ansible/workflows" ] } }, "/api/v2/ansible/workflows/{id}/launch": { "post": { "operationId": "post-api-v2-ansible-workflows-id-launch", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": { "attributes": { "extra-vars": { "canary": true, "release": "1.4.2" } }, "type": "ansible-workflow-jobs" } }, "schema": { "$ref": "#/components/schemas/post-api-v2-ansible-workflows-id-launch-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders.", "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ansible-workflow-jobs-response" } } }, "description": "Success" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "POST /api/v2/ansible/workflows/:id/launch", "tags": [ "ansible/workflows" ] } }, "/api/v2/ansible/workflows/{id}/nodes": { "get": { "operationId": "get-api-v2-ansible-workflows-id-nodes", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ansible-workflow-nodes-collection" } } }, "description": "Success" } }, "summary": "GET /api/v2/ansible/workflows/:id/nodes", "tags": [ "ansible/workflows" ] }, "post": { "operationId": "post-api-v2-ansible-workflows-id-nodes", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": { "attributes": { "all-parents-must-converge": true, "extra-vars": "{\"smoke_tests\":true}", "identifier": "verify", "limit": "webservers", "node-type": "job_template", "position-x": 320, "position-y": 120, "tags": "verify", "verbosity": 1 }, "relationships": { "inventory": { "data": { "id": "\u003cuuid\u003e", "type": "ansible-inventories" } }, "job-template": { "data": { "id": "\u003cuuid\u003e", "type": "ansible-job-templates" } } }, "type": "ansible-workflow-nodes" } }, "schema": { "$ref": "#/components/schemas/post-api-v2-ansible-workflows-id-nodes-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders." }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ansible-workflow-nodes-response" } } }, "description": "Success" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "POST /api/v2/ansible/workflows/:id/nodes", "tags": [ "ansible/workflows" ] } }, "/api/v2/applies/{id}": { "get": { "operationId": "get-api-v2-applies-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "GET /api/v2/applies/:id", "tags": [ "applies" ] } }, "/api/v2/authentication-tokens/{id}": { "delete": { "description": "Takes no request body.", "operationId": "delete-api-v2-authentication-tokens-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success. No content." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "DELETE /api/v2/authentication-tokens/:id", "tags": [ "authentication-tokens" ] }, "get": { "operationId": "get-api-v2-authentication-tokens-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "GET /api/v2/authentication-tokens/:id", "tags": [ "authentication-tokens" ] } }, "/api/v2/authentication-tokens/{id}/actions/rotate": { "post": { "operationId": "post-api-v2-authentication-tokens-id-actions-rotate", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": { "attributes": { "grace-period-hours": 48 }, "type": "authentication-tokens" } }, "schema": { "$ref": "#/components/schemas/post-api-v2-authentication-tokens-id-actions-rotate-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders." }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/authentication-tokens-response" } } }, "description": "Success" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "POST /api/v2/authentication-tokens/:id/actions/rotate", "tags": [ "authentication-tokens" ] } }, "/api/v2/configuration-versions/{id}": { "get": { "operationId": "get-api-v2-configuration-versions-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "GET /api/v2/configuration-versions/:id", "tags": [ "configuration-versions" ] } }, "/api/v2/configuration-versions/{id}/download": { "get": { "operationId": "get-api-v2-configuration-versions-id-download", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "GET /api/v2/configuration-versions/:id/download", "tags": [ "configuration-versions" ] } }, "/api/v2/configuration-versions/{id}/upload": { "put": { "operationId": "put-api-v2-configuration-versions-id-upload", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "token", "required": false, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/octet-stream": { "schema": { "format": "binary", "type": "string" } } }, "description": "A binary body. Its content is not described here.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/configuration-versions-response" } } }, "description": "Success" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-401" } } }, "description": "Unauthorized" } }, "summary": "PUT /api/v2/configuration-versions/:id/upload", "tags": [ "configuration-versions" ] } }, "/api/v2/dashboard/operations": { "get": { "operationId": "get-api-v2-dashboard-operations", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dashboard-operations-response" } } }, "description": "Success" } }, "summary": "GET /api/v2/dashboard/operations", "tags": [ "dashboard" ] } }, "/api/v2/dashboard/stats": { "get": { "operationId": "get-api-v2-dashboard-stats", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dashboard-stats-response" } } }, "description": "Success" } }, "summary": "GET /api/v2/dashboard/stats", "tags": [ "dashboard" ] } }, "/api/v2/notification-configurations/{id}": { "delete": { "description": "Takes no request body.", "operationId": "delete-api-v2-notification-configurations-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success. No content." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "DELETE /api/v2/notification-configurations/:id", "tags": [ "notification-configurations" ] }, "get": { "operationId": "get-api-v2-notification-configurations-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/notification-configurations-response" } } }, "description": "Success" } }, "summary": "GET /api/v2/notification-configurations/:id", "tags": [ "notification-configurations" ] }, "patch": { "operationId": "patch-api-v2-notification-configurations-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": { "attributes": { "enabled": true, "name": "run-events-signed", "token": "\u003csecret\u003e", "triggers": [ "run:needs_attention", "run:completed", "run:errored" ], "url": "https://hooks.example.com/stackweaver/runs" }, "type": "notification-configurations" } }, "schema": { "$ref": "#/components/schemas/patch-api-v2-notification-configurations-id-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders." }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/notification-configurations-response" } } }, "description": "Success" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "PATCH /api/v2/notification-configurations/:id", "tags": [ "notification-configurations" ] } }, "/api/v2/notification-configurations/{id}/actions/verify": { "post": { "description": "Takes no request body.", "operationId": "post-api-v2-notification-configurations-id-actions-verify", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post-api-v2-notification-configurations-id-actions-verify-response" } } }, "description": "Success" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "POST /api/v2/notification-configurations/:id/actions/verify", "tags": [ "notification-configurations" ] } }, "/api/v2/oauth/authorize": { "post": { "operationId": "post-api-v2-oauth-authorize", "requestBody": { "content": { "application/json": { "example": { "client_id": "terraform-cli", "code_challenge": "E9Melhoa2OwvFrEMTJguCHaoeK1t8URWbuGJSstw-cM", "code_challenge_method": "S256", "redirect_uri": "http://localhost:10000/login", "state": "9c1f6a52-terraform-login" }, "schema": { "$ref": "#/components/schemas/post-api-v2-oauth-authorize-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders." }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post-api-v2-oauth-authorize-b9fb7c" } } }, "description": "Success" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-403" } } }, "description": "Forbidden" } }, "summary": "POST /api/v2/oauth/authorize", "tags": [ "oauth" ] } }, "/api/v2/oauth/token": { "post": { "operationId": "post-api-v2-oauth-token", "requestBody": { "content": { "application/x-www-form-urlencoded": { "example": { "client_id": "terraform-cli", "code": "\u003csecret\u003e", "code_verifier": "\u003csecret\u003e", "grant_type": "authorization_code", "redirect_uri": "http://localhost:10000/login" }, "schema": { "$ref": "#/components/schemas/post-api-v2-oauth-token-request" } } }, "description": "Described from one accepted request rather than from a type: a member this example does not send may still be accepted. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders." }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post-api-v2-oauth-token-bba1e3" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post-api-v2-oauth-token-bba1e3" } } }, "description": "Bad Request" } }, "summary": "POST /api/v2/oauth/token", "tags": [ "oauth" ] } }, "/api/v2/oidc-configurations/{id}": { "delete": { "description": "Takes no request body.", "operationId": "delete-api-v2-oidc-configurations-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success. No content." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "DELETE /api/v2/oidc-configurations/:id", "tags": [ "oidc-configurations" ] }, "get": { "operationId": "get-api-v2-oidc-configurations-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "GET /api/v2/oidc-configurations/:id", "tags": [ "oidc-configurations" ] }, "patch": { "operationId": "patch-api-v2-oidc-configurations-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": { "attributes": { "service-account-email": "stackweaver-readonly@acme-platform.iam.gserviceaccount.com" }, "type": "gcp-oidc-configurations" } }, "schema": { "$ref": "#/components/schemas/patch-api-v2-oidc-configurations-id-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/gcp-oidc-configurations-response" } } }, "description": "Success" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "PATCH /api/v2/oidc-configurations/:id", "tags": [ "oidc-configurations" ] } }, "/api/v2/organization-memberships/{id}": { "delete": { "description": "Takes no request body.", "operationId": "delete-api-v2-organization-memberships-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success. No content." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "DELETE /api/v2/organization-memberships/:id", "tags": [ "organization-memberships" ] }, "get": { "operationId": "get-api-v2-organization-memberships-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "GET /api/v2/organization-memberships/:id", "tags": [ "organization-memberships" ] }, "patch": { "operationId": "patch-api-v2-organization-memberships-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": { "id": "\u003cuuid\u003e", "type": "organization-memberships" } }, "schema": { "$ref": "#/components/schemas/patch-api-v2-organization-memberships-id-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/organization-memberships-response" } } }, "description": "Success" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "PATCH /api/v2/organization-memberships/:id", "tags": [ "organization-memberships" ] } }, "/api/v2/organizations": { "get": { "operationId": "get-api-v2-organizations", "parameters": [ { "description": "An older spelling of page[number], read when page[number] is absent.", "in": "query", "name": "page", "required": false, "schema": { "type": "integer" } }, { "description": "Which page to return, 1-based.", "in": "query", "name": "page[number]", "required": false, "schema": { "type": "integer" } }, { "description": "Rows per page. Clamped to the endpoint's maximum; a value below 1 falls back to its default.", "in": "query", "name": "page[size]", "required": false, "schema": { "type": "integer" } }, { "description": "An older spelling of page[size], read when page[size] is absent.", "in": "query", "name": "per_page", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/organizations-collection" } } }, "description": "Success" } }, "summary": "GET /api/v2/organizations", "tags": [ "organizations" ] }, "post": { "operationId": "post-api-v2-organizations", "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": { "attributes": { "allow-force-delete-workspaces": true, "ansible-job-retention-days": 30, "collaborator-auth-policy": "two_factor_mandatory", "cost-estimation-enabled": true, "description": "Recorded by the golden write harness", "email": "platform-team@example.com", "name": "golden-write-org" }, "type": "organizations" } }, "schema": { "$ref": "#/components/schemas/post-api-v2-organizations-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders.", "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/organizations-response" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-400" } } }, "description": "Bad Request" } }, "summary": "POST /api/v2/organizations", "tags": [ "organizations" ] } }, "/api/v2/organizations/{name}": { "delete": { "description": "Takes no request body.", "operationId": "delete-api-v2-organizations-name", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success. No content." } }, "summary": "DELETE /api/v2/organizations/:name", "tags": [ "organizations" ] }, "get": { "operationId": "get-api-v2-organizations-name", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/organizations-response" } } }, "description": "Success" } }, "summary": "GET /api/v2/organizations/:name", "tags": [ "organizations" ] }, "patch": { "operationId": "patch-api-v2-organizations-name", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": { "attributes": { "ansible-job-retention-days": 30, "assessments-enforced": true, "collaborator-auth-policy": "two_factor_mandatory", "cost-estimation-enabled": true, "default-execution-mode": "agent", "description": "Updated by the golden write harness", "email": "platform-team@example.com", "speculative-plan-management-enabled": false }, "relationships": { "default-agent-pool": { "data": { "id": "\u003cuuid\u003e", "type": "agent-pools" } } }, "type": "organizations" } }, "schema": { "$ref": "#/components/schemas/patch-api-v2-organizations-name-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/organizations-response" } } }, "description": "Success" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "PATCH /api/v2/organizations/:name", "tags": [ "organizations" ] } }, "/api/v2/organizations/{name}/agent-pools": { "get": { "operationId": "get-api-v2-organizations-name-agent-pools", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "description": "Which page to return, 1-based.", "in": "query", "name": "page[number]", "required": false, "schema": { "type": "integer" } }, { "description": "Rows per page. Clamped to the endpoint's maximum; a value below 1 falls back to its default.", "in": "query", "name": "page[size]", "required": false, "schema": { "type": "integer" } }, { "in": "query", "name": "q", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "sort", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent-pools-collection" } } }, "description": "Success" } }, "summary": "GET /api/v2/organizations/:name/agent-pools", "tags": [ "agent-pools" ] }, "post": { "operationId": "post-api-v2-organizations-name-agent-pools", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": { "attributes": { "name": "golden-write-pool", "organization-scoped": false }, "relationships": { "allowed-workspaces": { "data": [ { "id": "\u003cid\u003e", "type": "workspaces" } ] } }, "type": "agent-pools" } }, "schema": { "$ref": "#/components/schemas/post-api-v2-organizations-name-agent-pools-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders.", "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent-pools-response" } } }, "description": "Success" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "POST /api/v2/organizations/:name/agent-pools", "tags": [ "agent-pools" ] } }, "/api/v2/organizations/{name}/analytics": { "get": { "operationId": "get-api-v2-organizations-name-analytics", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "since", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "until", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/analytics-response" } } }, "description": "Success" } }, "summary": "GET /api/v2/organizations/:name/analytics", "tags": [ "analytics" ] } }, "/api/v2/organizations/{name}/analytics/executions": { "get": { "operationId": "get-api-v2-organizations-name-analytics-executions", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "outcome", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "platform", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "since", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "until", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/analytics-executions-response" } } }, "description": "Success" } }, "summary": "GET /api/v2/organizations/:name/analytics/executions", "tags": [ "analytics" ] } }, "/api/v2/organizations/{name}/ansible-config": { "delete": { "description": "Takes no request body.", "operationId": "delete-api-v2-organizations-name-ansible-config", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success. No content." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "DELETE /api/v2/organizations/:name/ansible-config", "tags": [ "ansible-config" ] }, "get": { "operationId": "get-api-v2-organizations-name-ansible-config", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "GET /api/v2/organizations/:name/ansible-config", "tags": [ "ansible-config" ] }, "put": { "operationId": "put-api-v2-organizations-name-ansible-config", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": { "attributes": { "config-content": "[defaults]\nforks = 20\nhost_key_checking = False\ntimeout = 30\n\n[ssh_connection]\npipelining = True\n" }, "type": "ansible-configs" } }, "schema": { "$ref": "#/components/schemas/put-api-v2-organizations-name-ansible-config-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ansible-configs-response" } } }, "description": "Success" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "PUT /api/v2/organizations/:name/ansible-config", "tags": [ "ansible-config" ] } }, "/api/v2/organizations/{name}/ansible-config/effective": { "get": { "operationId": "get-api-v2-organizations-name-ansible-config-effective", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "project_id", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "workspace_id", "required": false, "schema": { "type": "string" } } ], "responses": { "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "GET /api/v2/organizations/:name/ansible-config/effective", "tags": [ "ansible-config" ] } }, "/api/v2/organizations/{name}/ansible/adhoc-modules": { "get": { "operationId": "get-api-v2-organizations-name-ansible-adhoc-modules", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/adhoc-modules-response" } } }, "description": "Success" } }, "summary": "GET /api/v2/organizations/:name/ansible/adhoc-modules", "tags": [ "ansible/adhoc-modules" ] } }, "/api/v2/organizations/{name}/ansible/credentials": { "get": { "operationId": "get-api-v2-organizations-name-ansible-credentials", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "filter[type]", "required": false, "schema": { "type": "string" } }, { "description": "Which page to return, 1-based.", "in": "query", "name": "page[number]", "required": false, "schema": { "type": "integer" } }, { "description": "Rows per page. Clamped to the endpoint's maximum; a value below 1 falls back to its default.", "in": "query", "name": "page[size]", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ansible-credentials-collection" } } }, "description": "Success" } }, "summary": "GET /api/v2/organizations/:name/ansible/credentials", "tags": [ "ansible/credentials" ] }, "post": { "operationId": "post-api-v2-organizations-name-ansible-credentials", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": { "attributes": { "become-password": "\u003csecret\u003e", "credential-type": "ssh", "description": "Recorded by the golden write harness", "name": "golden-write-ssh", "ssh-become-user": "root", "ssh-passphrase": "\u003csecret\u003e", "ssh-port": 2222, "ssh-private-key": "\u003csecret\u003e", "username": "deploy" }, "relationships": { "project": { "data": { "id": "\u003cuuid\u003e", "type": "projects" } } }, "type": "ansible-credentials" } }, "schema": { "$ref": "#/components/schemas/post-api-v2-organizations-name-ansible-credentials-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders." }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ansible-credentials-response" } } }, "description": "Success" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "POST /api/v2/organizations/:name/ansible/credentials", "tags": [ "ansible/credentials" ] } }, "/api/v2/organizations/{name}/ansible/inventories": { "get": { "operationId": "get-api-v2-organizations-name-ansible-inventories", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "description": "Which page to return, 1-based.", "in": "query", "name": "page[number]", "required": false, "schema": { "type": "integer" } }, { "description": "Rows per page. Clamped to the endpoint's maximum; a value below 1 falls back to its default.", "in": "query", "name": "page[size]", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ansible-inventories-collection" } } }, "description": "Success" } }, "summary": "GET /api/v2/organizations/:name/ansible/inventories", "tags": [ "ansible/inventories" ] }, "post": { "operationId": "post-api-v2-organizations-name-ansible-inventories", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": { "attributes": { "description": "Recorded by the golden write harness", "inventory-type": "static", "name": "golden-write-inventory", "variables": { "ansible_user": "deploy", "ntp_server": "time.example.com" } }, "relationships": { "project": { "data": { "id": "\u003cuuid\u003e", "type": "projects" } } }, "type": "inventories" } }, "schema": { "$ref": "#/components/schemas/post-api-v2-organizations-name-ansible-inventories-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders." }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ansible-inventories-response" } } }, "description": "Success" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "POST /api/v2/organizations/:name/ansible/inventories", "tags": [ "ansible/inventories" ] } }, "/api/v2/organizations/{name}/ansible/job-templates": { "get": { "operationId": "get-api-v2-organizations-name-ansible-job-templates", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "description": "Which page to return, 1-based.", "in": "query", "name": "page[number]", "required": false, "schema": { "type": "integer" } }, { "description": "Rows per page. Clamped to the endpoint's maximum; a value below 1 falls back to its default.", "in": "query", "name": "page[size]", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ansible-job-templates-collection" } } }, "description": "Success" } }, "summary": "GET /api/v2/organizations/:name/ansible/job-templates", "tags": [ "ansible/job-templates" ] }, "post": { "operationId": "post-api-v2-organizations-name-ansible-job-templates", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": { "attributes": { "become-enabled": true, "description": "Recorded by the golden write harness", "diff-mode": true, "extra-vars": { "app_version": "1.4.2", "rolling_update": true }, "forks": 10, "job-slice-count": 2, "limit": "webservers", "name": "golden-write-template", "retention-days": 30, "skip-tags": "slow", "tags": "deploy,config", "timeout-seconds": 3600, "verbosity": 1 }, "relationships": { "credentials": { "data": [ { "id": "\u003cuuid\u003e", "type": "ansible-credentials" } ] }, "inventory": { "data": { "id": "\u003cuuid\u003e", "type": "ansible-inventories" } }, "playbook": { "data": { "id": "\u003cuuid\u003e", "type": "ansible-playbooks" } }, "project": { "data": { "id": "\u003cuuid\u003e", "type": "projects" } } }, "type": "ansible-job-templates" } }, "schema": { "$ref": "#/components/schemas/post-api-v2-organizations-name-ansible-job-templates-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders." }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ansible-job-templates-response" } } }, "description": "Success" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "POST /api/v2/organizations/:name/ansible/job-templates", "tags": [ "ansible/job-templates" ] } }, "/api/v2/organizations/{name}/ansible/jobs": { "get": { "operationId": "get-api-v2-organizations-name-ansible-jobs", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "description": "Which page to return, 1-based.", "in": "query", "name": "page[number]", "required": false, "schema": { "type": "integer" } }, { "description": "Rows per page. Clamped to the endpoint's maximum; a value below 1 falls back to its default.", "in": "query", "name": "page[size]", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ansible-jobs-collection" } } }, "description": "Success" } }, "summary": "GET /api/v2/organizations/:name/ansible/jobs", "tags": [ "ansible/jobs" ] }, "post": { "operationId": "post-api-v2-organizations-name-ansible-jobs", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": { "attributes": { "become-enabled": true, "diff-mode": true, "extra-vars": { "release": "1.4.2" }, "forks": 10, "job-type": "check", "limit": "webservers", "name": "golden-write-job", "tags": "deploy", "verbosity": 1 }, "relationships": { "credentials": { "data": [ { "id": "\u003cuuid\u003e", "type": "ansible-credentials" } ] }, "inventory": { "data": { "id": "\u003cuuid\u003e", "type": "ansible-inventories" } }, "playbook": { "data": { "id": "\u003cuuid\u003e", "type": "ansible-playbooks" } }, "project": { "data": { "id": "\u003cuuid\u003e", "type": "projects" } } }, "type": "ansible-jobs" } }, "schema": { "$ref": "#/components/schemas/post-api-v2-organizations-name-ansible-jobs-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders." }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post-api-v2-organizations-name-ansible-jobs-response" } } }, "description": "Success" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "POST /api/v2/organizations/:name/ansible/jobs", "tags": [ "ansible/jobs" ] } }, "/api/v2/organizations/{name}/ansible/jobs/queue": { "get": { "operationId": "get-api-v2-organizations-name-ansible-jobs-queue", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "description": "Which page to return, 1-based.", "in": "query", "name": "page[number]", "required": false, "schema": { "type": "integer" } }, { "description": "Rows per page. Clamped to the endpoint's maximum; a value below 1 falls back to its default.", "in": "query", "name": "page[size]", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ansible-jobs-collection" } } }, "description": "Success" } }, "summary": "GET /api/v2/organizations/:name/ansible/jobs/queue", "tags": [ "ansible/jobs" ] } }, "/api/v2/organizations/{name}/ansible/notification-attachments": { "post": { "operationId": "post-api-v2-organizations-name-ansible-notification-attachments", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": { "attributes": { "on-failure": true, "on-started": true, "on-success": false }, "relationships": { "job-template": { "data": { "id": "\u003cuuid\u003e", "type": "ansible-job-templates" } }, "notification-template": { "data": { "id": "\u003cuuid\u003e", "type": "ansible-notification-templates" } } }, "type": "ansible-notification-attachments" } }, "schema": { "$ref": "#/components/schemas/post-api-v2-organizations-name-ansible-notification-attachments-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders.", "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ansible-notification-attachments-response" } } }, "description": "Success" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "POST /api/v2/organizations/:name/ansible/notification-attachments", "tags": [ "ansible/notification-attachments" ] } }, "/api/v2/organizations/{name}/ansible/notification-attachments/{attachment_id}": { "delete": { "description": "Takes no request body.", "operationId": "delete-api-v2-organizations-name-ansible-notification-attachments-attachment_id", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "attachment_id", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success. No content." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "DELETE /api/v2/organizations/:name/ansible/notification-attachments/:attachment_id", "tags": [ "ansible/notification-attachments" ] } }, "/api/v2/organizations/{name}/ansible/notification-templates": { "get": { "operationId": "get-api-v2-organizations-name-ansible-notification-templates", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/get-api-v2-organizations-name-ansible-notification-templates-9820ac" } } }, "description": "Success" } }, "summary": "GET /api/v2/organizations/:name/ansible/notification-templates", "tags": [ "ansible/notification-templates" ] }, "post": { "operationId": "post-api-v2-organizations-name-ansible-notification-templates", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": { "attributes": { "config": { "headers": { "X-Source": "stackweaver" }, "method": "POST", "url": "https://hooks.example.com/stackweaver/deploys", "username": "stackweaver" }, "description": "Recorded by the golden write harness", "name": "golden-write-deploy-hook", "notification-type": "webhook", "secret": "\u003csecret\u003e" }, "type": "ansible-notification-templates" } }, "schema": { "$ref": "#/components/schemas/post-api-v2-organizations-name-ansible-notification-templates-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders.", "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ansible-notification-templates-response" } } }, "description": "Success" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "POST /api/v2/organizations/:name/ansible/notification-templates", "tags": [ "ansible/notification-templates" ] } }, "/api/v2/organizations/{name}/ansible/playbooks": { "get": { "operationId": "get-api-v2-organizations-name-ansible-playbooks", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "description": "Which page to return, 1-based.", "in": "query", "name": "page[number]", "required": false, "schema": { "type": "integer" } }, { "description": "Rows per page. Clamped to the endpoint's maximum; a value below 1 falls back to its default.", "in": "query", "name": "page[size]", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ansible-playbooks-collection" } } }, "description": "Success" } }, "summary": "GET /api/v2/organizations/:name/ansible/playbooks", "tags": [ "ansible/playbooks" ] }, "post": { "operationId": "post-api-v2-organizations-name-ansible-playbooks", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": { "attributes": { "description": "Recorded by the golden write harness", "name": "golden-write-playbook", "playbook-path": "playbooks/site.yml", "source-mode": "fresh", "vcs-branch": "main", "vcs-repository": "stackweaver-demo/ansible-playbooks" }, "relationships": { "project": { "data": { "id": "\u003cuuid\u003e", "type": "projects" } }, "vcs-connection": { "data": { "id": "\u003cuuid\u003e", "type": "vcs-connections" } } }, "type": "ansible-playbooks" } }, "schema": { "$ref": "#/components/schemas/post-api-v2-organizations-name-ansible-playbooks-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders." }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ansible-playbooks-response" } } }, "description": "Success" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "POST /api/v2/organizations/:name/ansible/playbooks", "tags": [ "ansible/playbooks" ] } }, "/api/v2/organizations/{name}/ansible/playbooks/actions/bulk-import": { "post": { "operationId": "post-api-v2-organizations-name-ansible-playbooks-actions-bulk-import", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": { "attributes": { "branch": "main", "playbooks": [ { "name": "golden-write-webservers", "path": "playbooks/webservers.yml" }, { "name": "golden-write-databases", "path": "playbooks/databases.yml" } ], "project-id": "\u003cuuid\u003e", "repository": "stackweaver-demo/ansible-playbooks", "source-mode": "cached", "vcs-connection-id": "\u003cuuid\u003e" }, "type": "ansible-playbooks" } }, "schema": { "$ref": "#/components/schemas/post-api-v2-organizations-name-ansible-playbooks-actions-bulk-import-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ansible-playbooks-collection" } } }, "description": "Success" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "POST /api/v2/organizations/:name/ansible/playbooks/actions/bulk-import", "tags": [ "ansible/playbooks" ] } }, "/api/v2/organizations/{name}/ansible/playbooks/actions/find-or-create": { "post": { "operationId": "post-api-v2-organizations-name-ansible-playbooks-actions-find-or-create", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": { "attributes": { "branch": "main", "name": "golden-write-hardening", "path": "playbooks/hardening.yml", "project-id": "\u003cuuid\u003e", "repository": "stackweaver-demo/ansible-playbooks", "source-mode": "fresh", "vcs-connection-id": "\u003cuuid\u003e" }, "type": "ansible-playbooks" } }, "schema": { "$ref": "#/components/schemas/post-api-v2-organizations-name-ansible-playbooks-actions-find-or-create-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders.", "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ansible-playbooks-response" } } }, "description": "Success" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "POST /api/v2/organizations/:name/ansible/playbooks/actions/find-or-create", "tags": [ "ansible/playbooks" ] } }, "/api/v2/organizations/{name}/ansible/schedules": { "get": { "operationId": "get-api-v2-organizations-name-ansible-schedules", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "description": "Which page to return, 1-based.", "in": "query", "name": "page[number]", "required": false, "schema": { "type": "integer" } }, { "description": "Rows per page. Clamped to the endpoint's maximum; a value below 1 falls back to its default.", "in": "query", "name": "page[size]", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schedules-collection" } } }, "description": "Success" } }, "summary": "GET /api/v2/organizations/:name/ansible/schedules", "tags": [ "ansible/schedules" ] }, "post": { "operationId": "post-api-v2-organizations-name-ansible-schedules", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": { "attributes": { "config": { "extra_vars": { "compliance_profile": "cis-level-1" } }, "cron-expression": "30 3 * * 1-5", "description": "Recorded by the golden write harness", "end-date-time": "\u003ctimestamp\u003e", "job-template-id": "\u003cuuid\u003e", "name": "golden-write-schedule", "schedule-type": "job_template", "start-date-time": "\u003ctimestamp\u003e", "timezone": "Europe/Brussels" }, "type": "schedules" } }, "schema": { "$ref": "#/components/schemas/post-api-v2-organizations-name-ansible-schedules-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders.", "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schedules-response" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-400" } } }, "description": "Bad Request" } }, "summary": "POST /api/v2/organizations/:name/ansible/schedules", "tags": [ "ansible/schedules" ] } }, "/api/v2/organizations/{name}/ansible/vcs-playbook-files": { "get": { "operationId": "get-api-v2-organizations-name-ansible-vcs-playbook-files", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "branch", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "path", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "repository", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "vcs_connection_id", "required": false, "schema": { "type": "string" } } ], "responses": { "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-400" } } }, "description": "Bad Request" } }, "summary": "GET /api/v2/organizations/:name/ansible/vcs-playbook-files", "tags": [ "ansible/vcs-playbook-files" ] } }, "/api/v2/organizations/{name}/ansible/workflows": { "get": { "operationId": "get-api-v2-organizations-name-ansible-workflows", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "description": "Which page to return, 1-based.", "in": "query", "name": "page[number]", "required": false, "schema": { "type": "integer" } }, { "description": "Rows per page. Clamped to the endpoint's maximum; a value below 1 falls back to its default.", "in": "query", "name": "page[size]", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ansible-workflows-collection" } } }, "description": "Success" } }, "summary": "GET /api/v2/organizations/:name/ansible/workflows", "tags": [ "ansible/workflows" ] }, "post": { "operationId": "post-api-v2-organizations-name-ansible-workflows", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": { "attributes": { "allow-simultaneous": true, "ask-limit-on-launch": true, "ask-variables-on-launch": true, "description": "Recorded by the golden write harness", "extra-vars": "{\"environment\":\"staging\"}", "limit": "webservers", "name": "golden-write-workflow" }, "relationships": { "inventory": { "data": { "id": "\u003cuuid\u003e", "type": "ansible-inventories" } }, "project": { "data": { "id": "\u003cuuid\u003e", "type": "projects" } } }, "type": "ansible-workflows" } }, "schema": { "$ref": "#/components/schemas/post-api-v2-organizations-name-ansible-workflows-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders." }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ansible-workflows-response" } } }, "description": "Success" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "POST /api/v2/organizations/:name/ansible/workflows", "tags": [ "ansible/workflows" ] } }, "/api/v2/organizations/{name}/authentication-token": { "delete": { "description": "Takes no request body.", "operationId": "delete-api-v2-organizations-name-authentication-token", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "token", "required": false, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success. No content." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "DELETE /api/v2/organizations/:name/authentication-token", "tags": [ "authentication-token" ] }, "get": { "operationId": "get-api-v2-organizations-name-authentication-token", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "token", "required": false, "schema": { "type": "string" } } ], "responses": { "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "GET /api/v2/organizations/:name/authentication-token", "tags": [ "authentication-token" ] }, "post": { "operationId": "post-api-v2-organizations-name-authentication-token", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "token", "required": false, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": { "attributes": { "expired-at": "\u003ctimestamp\u003e" }, "type": "authentication-tokens" } }, "schema": { "$ref": "#/components/schemas/post-api-v2-organizations-name-authentication-token-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders." }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/authentication-tokens-response" } } }, "description": "Success" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "POST /api/v2/organizations/:name/authentication-token", "tags": [ "authentication-token" ] } }, "/api/v2/organizations/{name}/change-requests": { "get": { "operationId": "get-api-v2-organizations-name-change-requests", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "description": "Which page to return, 1-based.", "in": "query", "name": "page[number]", "required": false, "schema": { "type": "integer" } }, { "description": "Rows per page. Clamped to the endpoint's maximum; a value below 1 falls back to its default.", "in": "query", "name": "page[size]", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workspace_change_requests-collection" } } }, "description": "Success" } }, "summary": "GET /api/v2/organizations/:name/change-requests", "tags": [ "change-requests" ] } }, "/api/v2/organizations/{name}/effective-permissions": { "get": { "operationId": "get-api-v2-organizations-name-effective-permissions", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/effective-permissions-response" } } }, "description": "Success" } }, "summary": "GET /api/v2/organizations/:name/effective-permissions", "tags": [ "effective-permissions" ] } }, "/api/v2/organizations/{name}/entitlement-set": { "get": { "operationId": "get-api-v2-organizations-name-entitlement-set", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/entitlement-sets-response" } } }, "description": "Success" } }, "summary": "GET /api/v2/organizations/:name/entitlement-set", "tags": [ "entitlement-set" ] } }, "/api/v2/organizations/{name}/explorer/bulk-actions": { "post": { "operationId": "post-api-v2-organizations-name-explorer-bulk-actions", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": { "attributes": { "action_inputs": { "message": "The 5.x line stops receiving fixes next quarter. Bump the provider constraint, run a plan and confirm it is clean.", "subject": "Upgrade the AWS provider to 6.x" }, "action_type": "change_requests", "target_ids": [ "\u003cid\u003e", "\u003cid\u003e" ] }, "type": "bulk_actions" } }, "schema": { "$ref": "#/components/schemas/post-api-v2-organizations-name-explorer-bulk-actions-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders." }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bulk_actions-response" } } }, "description": "Success" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "POST /api/v2/organizations/:name/explorer/bulk-actions", "tags": [ "explorer" ] } }, "/api/v2/organizations/{name}/oidc-configurations": { "get": { "operationId": "get-api-v2-organizations-name-oidc-configurations", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/get-api-v2-organizations-name-oidc-configurations-c28ef5" } } }, "description": "Success" } }, "summary": "GET /api/v2/organizations/:name/oidc-configurations", "tags": [ "oidc-configurations" ] }, "post": { "operationId": "post-api-v2-organizations-name-oidc-configurations", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": { "attributes": { "project-number": "123456789012", "service-account-email": "stackweaver-deployer@acme-platform.iam.gserviceaccount.com", "workload-provider-name": "projects/123456789012/locations/global/workloadIdentityPools/stackweaver/providers/stackweaver-oidc" }, "type": "gcp-oidc-configurations" } }, "schema": { "$ref": "#/components/schemas/post-api-v2-organizations-name-oidc-configurations-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders.", "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/gcp-oidc-configurations-response" } } }, "description": "Success" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "POST /api/v2/organizations/:name/oidc-configurations", "tags": [ "oidc-configurations" ] } }, "/api/v2/organizations/{name}/organization-memberships": { "get": { "operationId": "get-api-v2-organizations-name-organization-memberships", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "filter[email]", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "filter[status]", "required": false, "schema": { "type": "string" } }, { "description": "Which page to return, 1-based.", "in": "query", "name": "page[number]", "required": false, "schema": { "type": "integer" } }, { "description": "Rows per page. Clamped to the endpoint's maximum; a value below 1 falls back to its default.", "in": "query", "name": "page[size]", "required": false, "schema": { "type": "integer" } }, { "in": "query", "name": "q", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/organization-memberships-collection" } } }, "description": "Success" } }, "summary": "GET /api/v2/organizations/:name/organization-memberships", "tags": [ "organization-memberships" ] }, "post": { "operationId": "post-api-v2-organizations-name-organization-memberships", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": { "attributes": { "email": "new.hire@example.com" }, "type": "organization-memberships" } }, "schema": { "$ref": "#/components/schemas/post-api-v2-organizations-name-organization-memberships-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders.", "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/organization-memberships-response" } } }, "description": "Success" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "POST /api/v2/organizations/:name/organization-memberships", "tags": [ "organization-memberships" ] } }, "/api/v2/organizations/{name}/projects": { "get": { "operationId": "get-api-v2-organizations-name-projects", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "description": "An older spelling of page[number], read when page[number] is absent.", "in": "query", "name": "page", "required": false, "schema": { "type": "integer" } }, { "description": "Which page to return, 1-based.", "in": "query", "name": "page[number]", "required": false, "schema": { "type": "integer" } }, { "description": "Rows per page. Clamped to the endpoint's maximum; a value below 1 falls back to its default.", "in": "query", "name": "page[size]", "required": false, "schema": { "type": "integer" } }, { "description": "An older spelling of page[size], read when page[size] is absent.", "in": "query", "name": "per_page", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/projects-collection" } } }, "description": "Success" } }, "summary": "GET /api/v2/organizations/:name/projects", "tags": [ "projects" ] }, "post": { "operationId": "post-api-v2-organizations-name-projects", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": { "attributes": { "description": "Recorded by the golden write harness", "name": "golden-write-project" }, "relationships": { "tag-bindings": { "data": [ { "attributes": { "key": "environment", "value": "staging" }, "type": "tag-bindings" }, { "attributes": { "key": "cost-center", "value": "platform-1042" }, "type": "tag-bindings" } ] } }, "type": "projects" } }, "schema": { "$ref": "#/components/schemas/post-api-v2-organizations-name-projects-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders.", "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/projects-response" } } }, "description": "Success" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "POST /api/v2/organizations/:name/projects", "tags": [ "projects" ] } }, "/api/v2/organizations/{name}/projects/{project_name}": { "delete": { "description": "Takes no request body.", "operationId": "delete-api-v2-organizations-name-projects-project_name", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "project_name", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success. No content." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "DELETE /api/v2/organizations/:name/projects/:project_name", "tags": [ "projects" ] }, "get": { "operationId": "get-api-v2-organizations-name-projects-project_name", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "project_name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/projects-response" } } }, "description": "Success" } }, "summary": "GET /api/v2/organizations/:name/projects/:project_name", "tags": [ "projects" ] }, "patch": { "operationId": "patch-api-v2-organizations-name-projects-project_name", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "project_name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": { "attributes": { "default-agent-pool-id": "\u003cuuid\u003e", "default-execution-mode": "agent", "description": "Updated by the golden write harness" }, "type": "projects" } }, "schema": { "$ref": "#/components/schemas/patch-api-v2-organizations-name-projects-project_name-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/projects-response" } } }, "description": "Success" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "PATCH /api/v2/organizations/:name/projects/:project_name", "tags": [ "projects" ] } }, "/api/v2/organizations/{name}/registry-providers": { "get": { "operationId": "get-api-v2-organizations-name-registry-providers", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "filter[registry_name]", "required": false, "schema": { "type": "string" } }, { "description": "Which page to return, 1-based.", "in": "query", "name": "page[number]", "required": false, "schema": { "type": "integer" } }, { "description": "Rows per page. Clamped to the endpoint's maximum; a value below 1 falls back to its default.", "in": "query", "name": "page[size]", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/registry-providers-collection" } } }, "description": "Success" } }, "summary": "GET /api/v2/organizations/:name/registry-providers", "tags": [ "registry-providers" ] }, "post": { "operationId": "post-api-v2-organizations-name-registry-providers", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": { "attributes": { "name": "golden-write", "namespace": "demo", "registry-name": "private" }, "type": "registry-providers" } }, "schema": { "$ref": "#/components/schemas/post-api-v2-organizations-name-registry-providers-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders." }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/registry-providers-response" } } }, "description": "Success" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "POST /api/v2/organizations/:name/registry-providers", "tags": [ "registry-providers" ] } }, "/api/v2/organizations/{name}/registry-providers/{registry_name}/{namespace}/{provider_name}": { "delete": { "description": "Takes no request body.", "operationId": "delete-api-v2-organizations-name-registry-providers-registry_name-namespace-provider_name", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "registry_name", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "provider_name", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success. No content." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "DELETE /api/v2/organizations/:name/registry-providers/:registry_name/:namespace/:provider_name", "tags": [ "registry-providers" ] }, "get": { "operationId": "get-api-v2-organizations-name-registry-providers-registry_name-namespace-provider_name", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "registry_name", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "provider_name", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "GET /api/v2/organizations/:name/registry-providers/:registry_name/:namespace/:provider_name", "tags": [ "registry-providers" ] } }, "/api/v2/organizations/{name}/registry-providers/{registry_name}/{namespace}/{provider_name}/versions/{version}/platforms": { "post": { "operationId": "post-api-v2-organizations-name-registry-providers-registry_name-namespace-provider_name-versions-version-platforms", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "registry_name", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "provider_name", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "version", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "example": { "arch": "amd64", "file": "\u003cfile\u003e", "key_id": "9FDEA9EA70FFAA2C", "os": "linux", "protocols": "5.0,6.0", "shasums": "\u003cfile\u003e", "shasums_sig": "\u003cfile\u003e" }, "schema": { "$ref": "#/components/schemas/post-api-v2-organizations-name-registry-providers-registry_name-namespace-provider_name-versions-version-platforms-request" } } }, "description": "Described from one accepted request rather than from a type: a member this example does not send may still be accepted. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders." }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/registry-provider-platforms-response" } } }, "description": "Success" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "POST /api/v2/organizations/:name/registry-providers/:registry_name/:namespace/:provider_name/versions/:version/platforms", "tags": [ "registry-providers" ] } }, "/api/v2/organizations/{name}/registry/modules": { "delete": { "description": "Takes no request body.", "operationId": "delete-api-v2-organizations-name-registry-modules", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success. No content." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "DELETE /api/v2/organizations/:name/registry/modules", "tags": [ "registry" ] }, "get": { "operationId": "get-api-v2-organizations-name-registry-modules", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "description": "Which page to return, 1-based.", "in": "query", "name": "page[number]", "required": false, "schema": { "type": "integer" } }, { "description": "Rows per page. Clamped to the endpoint's maximum; a value below 1 falls back to its default.", "in": "query", "name": "page[size]", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/registry-modules-collection" } } }, "description": "Success" } }, "summary": "GET /api/v2/organizations/:name/registry/modules", "tags": [ "registry" ] }, "post": { "operationId": "post-api-v2-organizations-name-registry-modules", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": { "attributes": { "auto_publish_tags": false, "description": "Recorded by the golden write harness", "name": "golden-write", "provider": "aws" }, "type": "registry-modules" } }, "schema": { "$ref": "#/components/schemas/post-api-v2-organizations-name-registry-modules-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders.", "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/registry-modules-response" } } }, "description": "Success" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "POST /api/v2/organizations/:name/registry/modules", "tags": [ "registry" ] } }, "/api/v2/organizations/{name}/registry/modules/{module_name}/{provider}": { "delete": { "description": "Takes no request body.", "operationId": "delete-api-v2-organizations-name-registry-modules-module_name-provider", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "module_name", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "provider", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success. No content." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "DELETE /api/v2/organizations/:name/registry/modules/:module_name/:provider", "tags": [ "registry" ] }, "get": { "operationId": "get-api-v2-organizations-name-registry-modules-module_name-provider", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "module_name", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "provider", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/registry-modules-response" } } }, "description": "Success" } }, "summary": "GET /api/v2/organizations/:name/registry/modules/:module_name/:provider", "tags": [ "registry" ] } }, "/api/v2/organizations/{name}/registry/modules/{module_name}/{provider}/versions": { "get": { "operationId": "get-api-v2-organizations-name-registry-modules-module_name-provider-versions", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "module_name", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "provider", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/module-versions-collection" } } }, "description": "Success" } }, "summary": "GET /api/v2/organizations/:name/registry/modules/:module_name/:provider/versions", "tags": [ "registry" ] }, "post": { "operationId": "post-api-v2-organizations-name-registry-modules-module_name-provider-versions", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "module_name", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "provider", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "example": { "file": "\u003cfile\u003e", "version": "3.0.0" }, "schema": { "$ref": "#/components/schemas/post-api-v2-organizations-name-registry-modules-module_name-provider-versions-request" } } }, "description": "Described from one accepted request rather than from a type: a member this example does not send may still be accepted. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders." }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/registry-module-versions-response" } } }, "description": "Success" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "POST /api/v2/organizations/:name/registry/modules/:module_name/:provider/versions", "tags": [ "registry" ] } }, "/api/v2/organizations/{name}/registry/modules/{module_name}/{provider}/versions/{version}": { "delete": { "description": "Takes no request body.", "operationId": "delete-api-v2-organizations-name-registry-modules-module_name-provider-versions-version", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "module_name", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "provider", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "version", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success. No content." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "DELETE /api/v2/organizations/:name/registry/modules/:module_name/:provider/versions/:version", "tags": [ "registry" ] } }, "/api/v2/organizations/{name}/runners": { "get": { "operationId": "get-api-v2-organizations-name-runners", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "filter[agent_pool_id]", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "filter[runner_type]", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "filter[status]", "required": false, "schema": { "type": "string" } }, { "description": "Which page to return, 1-based.", "in": "query", "name": "page[number]", "required": false, "schema": { "type": "integer" } }, { "description": "Rows per page. Clamped to the endpoint's maximum; a value below 1 falls back to its default.", "in": "query", "name": "page[size]", "required": false, "schema": { "type": "integer" } }, { "in": "query", "name": "q", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "sort", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runners-collection" } } }, "description": "Success" } }, "summary": "GET /api/v2/organizations/:name/runners", "tags": [ "runners" ] } }, "/api/v2/organizations/{name}/runners/stats": { "get": { "operationId": "get-api-v2-organizations-name-runners-stats", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runner-stats-response" } } }, "description": "Success" } }, "summary": "GET /api/v2/organizations/:name/runners/stats", "tags": [ "runners" ] } }, "/api/v2/organizations/{name}/runs": { "get": { "operationId": "get-api-v2-organizations-name-runs", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "description": "An older spelling of page[number], read when page[number] is absent.", "in": "query", "name": "page", "required": false, "schema": { "type": "integer" } }, { "description": "Which page to return, 1-based.", "in": "query", "name": "page[number]", "required": false, "schema": { "type": "integer" } }, { "description": "Rows per page. Clamped to the endpoint's maximum; a value below 1 falls back to its default.", "in": "query", "name": "page[size]", "required": false, "schema": { "type": "integer" } }, { "description": "An older spelling of page[size], read when page[size] is absent.", "in": "query", "name": "per_page", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runs-collection" } } }, "description": "Success" } }, "summary": "GET /api/v2/organizations/:name/runs", "tags": [ "runs" ] } }, "/api/v2/organizations/{name}/runs/queue": { "get": { "operationId": "get-api-v2-organizations-name-runs-queue", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/get-api-v2-organizations-name-runs-queue-1bb141" } } }, "description": "Success" } }, "summary": "GET /api/v2/organizations/:name/runs/queue", "tags": [ "runs" ] } }, "/api/v2/organizations/{name}/tasks": { "get": { "operationId": "get-api-v2-organizations-name-tasks", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "description": "Which page to return, 1-based.", "in": "query", "name": "page[number]", "required": false, "schema": { "type": "integer" } }, { "description": "Rows per page. Clamped to the endpoint's maximum; a value below 1 falls back to its default.", "in": "query", "name": "page[size]", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tasks-collection" } } }, "description": "Success" } }, "summary": "GET /api/v2/organizations/:name/tasks", "tags": [ "tasks" ] }, "post": { "operationId": "post-api-v2-organizations-name-tasks", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": { "attributes": { "category": "task", "description": "Recorded by the golden write harness", "enabled": true, "global-configuration": { "enabled": true, "enforcement-level": "advisory", "stages": [ "post_plan" ] }, "hmac-key": "\u003csecret\u003e", "name": "cost-estimate", "url": "https://run-tasks.example.com/run-tasks/cost-estimate" }, "type": "tasks" } }, "schema": { "$ref": "#/components/schemas/post-api-v2-organizations-name-tasks-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders." }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post-api-v2-organizations-name-tasks-response" } } }, "description": "Success" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "POST /api/v2/organizations/:name/tasks", "tags": [ "tasks" ] } }, "/api/v2/organizations/{name}/teams": { "get": { "operationId": "get-api-v2-organizations-name-teams", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "description": "Which page to return, 1-based.", "in": "query", "name": "page[number]", "required": false, "schema": { "type": "integer" } }, { "description": "Rows per page. Clamped to the endpoint's maximum; a value below 1 falls back to its default.", "in": "query", "name": "page[size]", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/teams-collection" } } }, "description": "Success" } }, "summary": "GET /api/v2/organizations/:name/teams", "tags": [ "teams" ] }, "post": { "operationId": "post-api-v2-organizations-name-teams", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": { "attributes": { "allow-member-token-management": false, "description": "Recorded by the golden write harness", "name": "golden-write-team", "organization-access": { "manage-modules": true, "manage-workspaces": true, "read-ansible": true, "read-projects": true }, "visibility": "organization" }, "type": "teams" } }, "schema": { "$ref": "#/components/schemas/post-api-v2-organizations-name-teams-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders.", "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/teams-response" } } }, "description": "Success" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "POST /api/v2/organizations/:name/teams", "tags": [ "teams" ] } }, "/api/v2/organizations/{name}/teams/{teamName}": { "delete": { "description": "Takes no request body.", "operationId": "delete-api-v2-organizations-name-teams-teamName", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "teamName", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success. No content." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "DELETE /api/v2/organizations/:name/teams/:teamName", "tags": [ "teams" ] }, "get": { "operationId": "get-api-v2-organizations-name-teams-teamName", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "teamName", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/teams-response" } } }, "description": "Success" } }, "summary": "GET /api/v2/organizations/:name/teams/:teamName", "tags": [ "teams" ] }, "patch": { "operationId": "patch-api-v2-organizations-name-teams-teamName", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "teamName", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": { "attributes": { "description": "Updated by the golden write harness", "organization-access": { "manage-run-tasks": true, "manage-workspaces": false, "read-workspaces": true }, "visibility": "organization" }, "type": "teams" } }, "schema": { "$ref": "#/components/schemas/patch-api-v2-organizations-name-teams-teamName-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/teams-response" } } }, "description": "Success" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "PATCH /api/v2/organizations/:name/teams/:teamName", "tags": [ "teams" ] } }, "/api/v2/organizations/{name}/varsets": { "get": { "operationId": "get-api-v2-organizations-name-varsets", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/varsets-collection" } } }, "description": "Success" } }, "summary": "GET /api/v2/organizations/:name/varsets", "tags": [ "varsets" ] }, "post": { "operationId": "post-api-v2-organizations-name-varsets", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": { "attributes": { "description": "Recorded by the golden write harness", "global": false, "name": "golden-write-varset", "priority": true }, "relationships": { "projects": { "data": [ { "id": "\u003cuuid\u003e", "type": "projects" } ] }, "vars": { "data": [ { "attributes": { "category": "terraform", "description": "Region every workspace deploys to.", "key": "region", "value": "eu-west-1" }, "type": "vars" }, { "attributes": { "category": "env", "key": "DEPLOY_TOKEN", "sensitive": true, "value": "\u003csecret\u003e" }, "type": "vars" } ] }, "workspaces": { "data": [ { "id": "\u003cid\u003e", "type": "workspaces" } ] } }, "type": "varsets" } }, "schema": { "$ref": "#/components/schemas/post-api-v2-organizations-name-varsets-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders.", "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/varsets-response" } } }, "description": "Success" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "POST /api/v2/organizations/:name/varsets", "tags": [ "varsets" ] } }, "/api/v2/organizations/{name}/varsets/{id}": { "delete": { "description": "Takes no request body.", "operationId": "delete-api-v2-organizations-name-varsets-id", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success. No content." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "DELETE /api/v2/organizations/:name/varsets/:id", "tags": [ "varsets" ] }, "get": { "operationId": "get-api-v2-organizations-name-varsets-id", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/varsets-response" } } }, "description": "Success" } }, "summary": "GET /api/v2/organizations/:name/varsets/:id", "tags": [ "varsets" ] }, "patch": { "operationId": "patch-api-v2-organizations-name-varsets-id", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": { "attributes": { "description": "Updated by the golden write harness", "global": false, "name": "golden-write-renamed", "priority": true }, "type": "varsets" } }, "schema": { "$ref": "#/components/schemas/patch-api-v2-organizations-name-varsets-id-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/varsets-response" } } }, "description": "Success" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "PATCH /api/v2/organizations/:name/varsets/:id", "tags": [ "varsets" ] } }, "/api/v2/organizations/{name}/varsets/{id}/relationships/projects": { "delete": { "operationId": "delete-api-v2-organizations-name-varsets-id-relationships-projects", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": [ { "id": "\u003cuuid\u003e", "type": "projects" } ] }, "schema": { "$ref": "#/components/schemas/delete-api-v2-organizations-name-varsets-id-relationships-projects-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders." }, "responses": { "204": { "description": "Success. No content." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "DELETE /api/v2/organizations/:name/varsets/:id/relationships/projects", "tags": [ "varsets" ] }, "post": { "operationId": "post-api-v2-organizations-name-varsets-id-relationships-projects", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": [ { "id": "\u003cuuid\u003e", "type": "projects" } ] }, "schema": { "$ref": "#/components/schemas/post-api-v2-organizations-name-varsets-id-relationships-projects-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders." }, "responses": { "204": { "description": "Success. No content." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "POST /api/v2/organizations/:name/varsets/:id/relationships/projects", "tags": [ "varsets" ] } }, "/api/v2/organizations/{name}/varsets/{id}/relationships/vars": { "get": { "operationId": "get-api-v2-organizations-name-varsets-id-relationships-vars", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vars-collection" } } }, "description": "Success" } }, "summary": "GET /api/v2/organizations/:name/varsets/:id/relationships/vars", "tags": [ "varsets" ] }, "post": { "operationId": "post-api-v2-organizations-name-varsets-id-relationships-vars", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": { "attributes": { "category": "env", "description": "Recorded by the golden write harness", "hcl": false, "key": "AWS_SESSION_TOKEN", "sensitive": true, "value": "\u003csecret\u003e" }, "type": "vars" } }, "schema": { "$ref": "#/components/schemas/post-api-v2-organizations-name-varsets-id-relationships-vars-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders.", "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vars-response" } } }, "description": "Success" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "POST /api/v2/organizations/:name/varsets/:id/relationships/vars", "tags": [ "varsets" ] } }, "/api/v2/organizations/{name}/varsets/{id}/relationships/vars/{variable_id}": { "delete": { "description": "Takes no request body.", "operationId": "delete-api-v2-organizations-name-varsets-id-relationships-vars-variable_id", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "variable_id", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success. No content." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "DELETE /api/v2/organizations/:name/varsets/:id/relationships/vars/:variable_id", "tags": [ "varsets" ] }, "get": { "operationId": "get-api-v2-organizations-name-varsets-id-relationships-vars-variable_id", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "variable_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vars-response" } } }, "description": "Success" } }, "summary": "GET /api/v2/organizations/:name/varsets/:id/relationships/vars/:variable_id", "tags": [ "varsets" ] }, "patch": { "operationId": "patch-api-v2-organizations-name-varsets-id-relationships-vars-variable_id", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "variable_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": { "attributes": { "category": "env", "description": "Updated by the golden write harness", "key": "AWS_DEFAULT_REGION", "sensitive": false, "value": "eu-central-1" }, "type": "vars" } }, "schema": { "$ref": "#/components/schemas/patch-api-v2-organizations-name-varsets-id-relationships-vars-variable_id-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vars-response" } } }, "description": "Success" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "PATCH /api/v2/organizations/:name/varsets/:id/relationships/vars/:variable_id", "tags": [ "varsets" ] } }, "/api/v2/organizations/{name}/varsets/{id}/relationships/workspaces": { "delete": { "operationId": "delete-api-v2-organizations-name-varsets-id-relationships-workspaces", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": [ { "id": "\u003cid\u003e", "type": "workspaces" } ] }, "schema": { "$ref": "#/components/schemas/delete-api-v2-organizations-name-varsets-id-relationships-workspaces-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders." }, "responses": { "204": { "description": "Success. No content." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "DELETE /api/v2/organizations/:name/varsets/:id/relationships/workspaces", "tags": [ "varsets" ] }, "post": { "operationId": "post-api-v2-organizations-name-varsets-id-relationships-workspaces", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": [ { "id": "\u003cid\u003e", "type": "workspaces" } ] }, "schema": { "$ref": "#/components/schemas/post-api-v2-organizations-name-varsets-id-relationships-workspaces-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders." }, "responses": { "204": { "description": "Success. No content." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "POST /api/v2/organizations/:name/varsets/:id/relationships/workspaces", "tags": [ "varsets" ] } }, "/api/v2/organizations/{name}/vcs-connections": { "get": { "operationId": "get-api-v2-organizations-name-vcs-connections", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/get-api-v2-organizations-name-vcs-connections-e028b0" } } }, "description": "Success" } }, "summary": "GET /api/v2/organizations/:name/vcs-connections", "tags": [ "vcs-connections" ] }, "post": { "operationId": "post-api-v2-organizations-name-vcs-connections", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": { "attributes": { "access_token": "\u003csecret\u003e", "account_name": "acme-platform", "account_type": "organization", "provider": "azure_devops", "refresh_token": "\u003csecret\u003e", "token_expires_at": "\u003ctimestamp\u003e" }, "type": "vcs-connections" } }, "schema": { "$ref": "#/components/schemas/post-api-v2-organizations-name-vcs-connections-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders.", "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vcs-connections-response" } } }, "description": "Success" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "POST /api/v2/organizations/:name/vcs-connections", "tags": [ "vcs-connections" ] } }, "/api/v2/organizations/{name}/vcs-connections/azure-devops/install": { "get": { "operationId": "get-api-v2-organizations-name-vcs-connections-azure-devops-install", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "ado_org", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "return", "required": false, "schema": { "type": "string" } } ], "responses": { "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-500" } } }, "description": "Server Error" } }, "summary": "GET /api/v2/organizations/:name/vcs-connections/azure-devops/install", "tags": [ "vcs-connections" ] } }, "/api/v2/organizations/{name}/vcs-connections/github/install": { "get": { "operationId": "get-api-v2-organizations-name-vcs-connections-github-install", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "redirect", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "return", "required": false, "schema": { "type": "string" } } ], "responses": { "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-500" } } }, "description": "Server Error" } }, "summary": "GET /api/v2/organizations/:name/vcs-connections/github/install", "tags": [ "vcs-connections" ] } }, "/api/v2/organizations/{name}/vcs-connections/github/installations/{installation_id}": { "post": { "description": "Not recorded: a successful call needs a system outside the machine. The server exchanges the code GitHub issued when a person authorized the GitHub App, confirms with GitHub that the person can access the installation, and asks GitHub which account the installation belongs to before it stores the connection. Success needs a browser sign-in at GitHub, a real installation of that App and GitHub to answer for it. No request was sent, so this operation's request body and success response are not described.", "operationId": "post-api-v2-organizations-name-vcs-connections-github-installations-installation_id", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "installation_id", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "state", "required": false, "schema": { "type": "string" } } ], "responses": { "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "POST /api/v2/organizations/:name/vcs-connections/github/installations/:installation_id", "tags": [ "vcs-connections" ] } }, "/api/v2/organizations/{name}/vcs-connections/github/installations/{installation_id}/authorize": { "get": { "operationId": "get-api-v2-organizations-name-vcs-connections-github-installations-installation_id-authorize", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "installation_id", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "state", "required": false, "schema": { "type": "string" } } ], "responses": { "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-403" } } }, "description": "Forbidden" } }, "summary": "GET /api/v2/organizations/:name/vcs-connections/github/installations/:installation_id/authorize", "tags": [ "vcs-connections" ] } }, "/api/v2/organizations/{name}/webhook-events": { "get": { "operationId": "get-api-v2-organizations-name-webhook-events", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "description": "Which page to return, 1-based.", "in": "query", "name": "page[number]", "required": false, "schema": { "type": "integer" } }, { "description": "Rows per page. Clamped to the endpoint's maximum; a value below 1 falls back to its default.", "in": "query", "name": "page[size]", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/get-api-v2-organizations-name-webhook-events-49a8f6" } } }, "description": "Success" } }, "summary": "GET /api/v2/organizations/:name/webhook-events", "tags": [ "webhook-events" ] } }, "/api/v2/organizations/{name}/workspaces": { "get": { "operationId": "get-api-v2-organizations-name-workspaces", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "description": "The key of a tag the result must carry. Tag filters are numbered pairs starting at 0 with no gaps: filter[tagged][1][key] is the second.", "in": "query", "name": "filter[tagged][0][key]", "required": false, "schema": { "type": "string" } }, { "description": "The value the tag named by filter[tagged][0][key] must have. Leave it out to match the key alone.", "in": "query", "name": "filter[tagged][0][value]", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "include", "required": false, "schema": { "type": "string" } }, { "description": "Which page to return, 1-based.", "in": "query", "name": "page[number]", "required": false, "schema": { "type": "integer" } }, { "description": "Rows per page. Clamped to the endpoint's maximum; a value below 1 falls back to its default.", "in": "query", "name": "page[size]", "required": false, "schema": { "type": "integer" } }, { "in": "query", "name": "search[exclude-tags]", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "search[tags]", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workspaces-collection" } } }, "description": "Success" } }, "summary": "GET /api/v2/organizations/:name/workspaces", "tags": [ "workspaces" ] }, "post": { "operationId": "post-api-v2-organizations-name-workspaces", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": { "attributes": { "allow-destroy-plan": false, "auto-apply": false, "description": "Recorded by the golden write harness", "execution-mode": "remote", "file-triggers-enabled": true, "name": "golden-write-workspace", "queue-all-runs": false, "run-timeout": 3600, "speculative-enabled": true, "terraform-version": "1.10.6", "trigger-patterns": [ "modules/**", "environments/production/**" ], "working-directory": "environments/production" }, "relationships": { "project": { "data": { "id": "\u003cuuid\u003e", "type": "projects" } }, "tag-bindings": { "data": [ { "attributes": { "key": "environment", "value": "production" }, "type": "tag-bindings" }, { "attributes": { "key": "team", "value": "platform" }, "type": "tag-bindings" } ] } }, "type": "workspaces" } }, "schema": { "$ref": "#/components/schemas/post-api-v2-organizations-name-workspaces-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders." }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post-api-v2-organizations-name-workspaces-response" } } }, "description": "Success" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "POST /api/v2/organizations/:name/workspaces", "tags": [ "workspaces" ] } }, "/api/v2/organizations/{name}/workspaces/{workspace_name}": { "delete": { "description": "Takes no request body.", "operationId": "delete-api-v2-organizations-name-workspaces-workspace_name", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "workspace_name", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "force", "required": false, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success. No content." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "DELETE /api/v2/organizations/:name/workspaces/:workspace_name", "tags": [ "workspaces" ] }, "get": { "operationId": "get-api-v2-organizations-name-workspaces-workspace_name", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "workspace_name", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "include", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workspaces-response" } } }, "description": "Success" } }, "summary": "GET /api/v2/organizations/:name/workspaces/:workspace_name", "tags": [ "workspaces" ] }, "patch": { "operationId": "patch-api-v2-organizations-name-workspaces-workspace_name", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "workspace_name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": { "attributes": { "auto-apply": true, "description": "Updated by the golden write harness", "execution-mode": "remote", "run-timeout": 5400, "tag-names": [ "production", "platform" ], "terraform-version": "1.10.6", "trigger-prefixes": [ "modules/network", "modules/compute" ], "working-directory": "environments/production" }, "type": "workspaces" } }, "schema": { "$ref": "#/components/schemas/patch-api-v2-organizations-name-workspaces-workspace_name-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders." }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/patch-api-v2-organizations-name-workspaces-workspace_name-response" } } }, "description": "Success" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "PATCH /api/v2/organizations/:name/workspaces/:workspace_name", "tags": [ "workspaces" ] } }, "/api/v2/organizations/{name}/workspaces/{workspace_name}/actions/safe-delete": { "post": { "description": "Takes no request body.", "operationId": "post-api-v2-organizations-name-workspaces-workspace_name-actions-safe-delete", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "workspace_name", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "force", "required": false, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success. No content." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "POST /api/v2/organizations/:name/workspaces/:workspace_name/actions/safe-delete", "tags": [ "workspaces" ] } }, "/api/v2/ping": { "get": { "operationId": "get-api-v2-ping", "responses": { "200": { "content": { "text/plain": { "schema": { "type": "string" } } }, "description": "Success" } }, "summary": "GET /api/v2/ping", "tags": [ "ping" ] } }, "/api/v2/plans/{id}": { "get": { "operationId": "get-api-v2-plans-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "GET /api/v2/plans/:id", "tags": [ "plans" ] } }, "/api/v2/plans/{id}/json-output": { "get": { "operationId": "get-api-v2-plans-id-json-output", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "GET /api/v2/plans/:id/json-output", "tags": [ "plans" ] } }, "/api/v2/platform/settings": { "get": { "operationId": "get-api-v2-platform-settings", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/platform-settings-response" } } }, "description": "Success" } }, "summary": "GET /api/v2/platform/settings", "tags": [ "platform" ] } }, "/api/v2/projects/{id}": { "delete": { "description": "Takes no request body.", "operationId": "delete-api-v2-projects-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success. No content." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "DELETE /api/v2/projects/:id", "tags": [ "projects" ] }, "get": { "operationId": "get-api-v2-projects-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "include", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/projects-response" } } }, "description": "Success" } }, "summary": "GET /api/v2/projects/:id", "tags": [ "projects" ] }, "patch": { "operationId": "patch-api-v2-projects-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": { "attributes": { "description": "Updated by the golden write harness", "name": "golden-write-renamed" }, "relationships": { "tag-bindings": { "data": [ { "attributes": { "key": "environment", "value": "production" }, "type": "tag-bindings" } ] } }, "type": "projects" } }, "schema": { "$ref": "#/components/schemas/patch-api-v2-projects-id-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/projects-response" } } }, "description": "Success" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "PATCH /api/v2/projects/:id", "tags": [ "projects" ] } }, "/api/v2/projects/{id}/ansible-config": { "delete": { "description": "Takes no request body.", "operationId": "delete-api-v2-projects-id-ansible-config", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success. No content." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "DELETE /api/v2/projects/:id/ansible-config", "tags": [ "ansible-config" ] }, "get": { "operationId": "get-api-v2-projects-id-ansible-config", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "GET /api/v2/projects/:id/ansible-config", "tags": [ "ansible-config" ] }, "put": { "operationId": "put-api-v2-projects-id-ansible-config", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": { "attributes": { "config-content": "[defaults]\nforks = 20\nhost_key_checking = False\ntimeout = 30\n\n[ssh_connection]\npipelining = True\n" }, "type": "ansible-configs" } }, "schema": { "$ref": "#/components/schemas/put-api-v2-projects-id-ansible-config-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ansible-configs-response" } } }, "description": "Success" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "PUT /api/v2/projects/:id/ansible-config", "tags": [ "ansible-config" ] } }, "/api/v2/projects/{id}/ansible/job-templates": { "get": { "operationId": "get-api-v2-projects-id-ansible-job-templates", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "description": "Which page to return, 1-based.", "in": "query", "name": "page[number]", "required": false, "schema": { "type": "integer" } }, { "description": "Rows per page. Clamped to the endpoint's maximum; a value below 1 falls back to its default.", "in": "query", "name": "page[size]", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/get-api-v2-projects-id-ansible-job-templates-cbfd6b" } } }, "description": "Success" } }, "summary": "GET /api/v2/projects/:id/ansible/job-templates", "tags": [ "ansible/job-templates" ] } }, "/api/v2/projects/{id}/ansible/jobs": { "get": { "operationId": "get-api-v2-projects-id-ansible-jobs", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "filter[slice-group-id]", "required": false, "schema": { "type": "string" } }, { "description": "Which page to return, 1-based.", "in": "query", "name": "page[number]", "required": false, "schema": { "type": "integer" } }, { "description": "Rows per page. Clamped to the endpoint's maximum; a value below 1 falls back to its default.", "in": "query", "name": "page[size]", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/get-api-v2-projects-id-ansible-jobs-9e8c35" } } }, "description": "Success" } }, "summary": "GET /api/v2/projects/:id/ansible/jobs", "tags": [ "ansible/jobs" ] } }, "/api/v2/projects/{id}/ansible/playbooks": { "get": { "operationId": "get-api-v2-projects-id-ansible-playbooks", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "description": "Which page to return, 1-based.", "in": "query", "name": "page[number]", "required": false, "schema": { "type": "integer" } }, { "description": "Rows per page. Clamped to the endpoint's maximum; a value below 1 falls back to its default.", "in": "query", "name": "page[size]", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/get-api-v2-projects-id-ansible-playbooks-1a3a16" } } }, "description": "Success" } }, "summary": "GET /api/v2/projects/:id/ansible/playbooks", "tags": [ "ansible/playbooks" ] } }, "/api/v2/projects/{id}/effective-tag-bindings": { "get": { "operationId": "get-api-v2-projects-id-effective-tag-bindings", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/get-api-v2-projects-id-effective-tag-bindings-39b35b" } } }, "description": "Success" } }, "summary": "GET /api/v2/projects/:id/effective-tag-bindings", "tags": [ "effective-tag-bindings" ] } }, "/api/v2/projects/{id}/notification-configurations": { "get": { "operationId": "get-api-v2-projects-id-notification-configurations", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/get-api-v2-projects-id-notification-configurations-d73ecb" } } }, "description": "Success" } }, "summary": "GET /api/v2/projects/:id/notification-configurations", "tags": [ "notification-configurations" ] }, "post": { "operationId": "post-api-v2-projects-id-notification-configurations", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": { "attributes": { "destination-type": "generic", "enabled": true, "name": "golden-write-run-events", "token": "\u003csecret\u003e", "triggers": [ "run:needs_attention", "run:completed", "run:errored" ], "url": "https://hooks.example.com/stackweaver/runs" }, "type": "notification-configurations" } }, "schema": { "$ref": "#/components/schemas/post-api-v2-projects-id-notification-configurations-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders." }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/notification-configurations-response" } } }, "description": "Success" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "POST /api/v2/projects/:id/notification-configurations", "tags": [ "notification-configurations" ] } }, "/api/v2/projects/{id}/relationships/team-access": { "get": { "operationId": "get-api-v2-projects-id-relationships-team-access", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "filter[project][id]", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/team-projects-collection" } } }, "description": "Success" } }, "summary": "GET /api/v2/projects/:id/relationships/team-access", "tags": [ "team-access" ] }, "post": { "operationId": "post-api-v2-projects-id-relationships-team-access", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": { "attributes": { "access": "read" }, "relationships": { "team": { "data": { "id": "\u003cuuid\u003e", "type": "teams" } } }, "type": "team-projects" } }, "schema": { "$ref": "#/components/schemas/post-api-v2-projects-id-relationships-team-access-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders.", "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/team-projects-response" } } }, "description": "Success" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "POST /api/v2/projects/:id/relationships/team-access", "tags": [ "team-access" ] } }, "/api/v2/projects/{id}/relationships/team-access/{access_id}": { "delete": { "description": "Takes no request body.", "operationId": "delete-api-v2-projects-id-relationships-team-access-access_id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "access_id", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success. No content." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "DELETE /api/v2/projects/:id/relationships/team-access/:access_id", "tags": [ "team-access" ] }, "get": { "operationId": "get-api-v2-projects-id-relationships-team-access-access_id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "access_id", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "GET /api/v2/projects/:id/relationships/team-access/:access_id", "tags": [ "team-access" ] }, "patch": { "operationId": "patch-api-v2-projects-id-relationships-team-access-access_id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "access_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": { "attributes": { "access": "write" }, "type": "team-projects" } }, "schema": { "$ref": "#/components/schemas/patch-api-v2-projects-id-relationships-team-access-access_id-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/team-projects-response" } } }, "description": "Success" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "PATCH /api/v2/projects/:id/relationships/team-access/:access_id", "tags": [ "team-access" ] } }, "/api/v2/projects/{id}/tag-bindings": { "get": { "operationId": "get-api-v2-projects-id-tag-bindings", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/get-api-v2-projects-id-tag-bindings-164f21" } } }, "description": "Success" } }, "summary": "GET /api/v2/projects/:id/tag-bindings", "tags": [ "tag-bindings" ] }, "patch": { "operationId": "patch-api-v2-projects-id-tag-bindings", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": [ { "attributes": { "key": "environment", "value": "production" }, "type": "tag-bindings" }, { "attributes": { "key": "owner", "value": "platform-engineering" }, "type": "tag-bindings" } ] }, "schema": { "$ref": "#/components/schemas/patch-api-v2-projects-id-tag-bindings-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders." }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tag-bindings-collection" } } }, "description": "Success" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "PATCH /api/v2/projects/:id/tag-bindings", "tags": [ "tag-bindings" ] } }, "/api/v2/registry-providers/{id}": { "delete": { "description": "Takes no request body.", "operationId": "delete-api-v2-registry-providers-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success. No content." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "DELETE /api/v2/registry-providers/:id", "tags": [ "registry-providers" ] }, "get": { "operationId": "get-api-v2-registry-providers-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/registry-providers-response" } } }, "description": "Success" } }, "summary": "GET /api/v2/registry-providers/:id", "tags": [ "registry-providers" ] } }, "/api/v2/run-triggers/{id}": { "delete": { "description": "Takes no request body.", "operationId": "delete-api-v2-run-triggers-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success. No content." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "DELETE /api/v2/run-triggers/:id", "tags": [ "run-triggers" ] }, "get": { "operationId": "get-api-v2-run-triggers-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/run-triggers-response" } } }, "description": "Success" } }, "summary": "GET /api/v2/run-triggers/:id", "tags": [ "run-triggers" ] } }, "/api/v2/runner/deregister": { "post": { "operationId": "post-api-v2-runner-deregister", "requestBody": { "content": { "application/json": { "example": { "runner_id": "\u003cuuid\u003e" }, "schema": { "$ref": "#/components/schemas/post-api-v2-runner-deregister-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders." }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post-api-v2-runner-deregister-491424" } } }, "description": "Success" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-403" } } }, "description": "Forbidden" } }, "summary": "POST /api/v2/runner/deregister", "tags": [ "runner" ] } }, "/api/v2/runner/heartbeat": { "post": { "operationId": "post-api-v2-runner-heartbeat", "requestBody": { "content": { "application/json": { "example": { "available_capacity": 2, "current_jobs": 0, "runner_id": "\u003cuuid\u003e", "status": "online" }, "schema": { "$ref": "#/components/schemas/post-api-v2-runner-heartbeat-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post-api-v2-runner-heartbeat-b955dc" } } }, "description": "Success" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-403" } } }, "description": "Forbidden" } }, "summary": "POST /api/v2/runner/heartbeat", "tags": [ "runner" ] } }, "/api/v2/runner/jobs/{id}/artifacts": { "get": { "operationId": "get-api-v2-runner-jobs-id-artifacts", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-403" } } }, "description": "Forbidden" } }, "summary": "GET /api/v2/runner/jobs/:id/artifacts", "tags": [ "runner" ] } }, "/api/v2/runner/jobs/{id}/complete": { "post": { "operationId": "post-api-v2-runner-jobs-id-complete", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "exit_code": 0, "has_changes": true, "output_changes": 0, "plan_json": "{\"format_version\":\"1.2\",\"resource_changes\":[{\"address\":\"null_resource.example\",\"mode\":\"managed\",\"type\":\"null_resource\",\"name\":\"example\",\"change\":{\"actions\":[\"create\"]}}]}", "resource_additions": 1, "resource_changes": 0, "resource_destructions": 0, "runner_id": "\u003cuuid\u003e", "status": "completed" }, "schema": { "$ref": "#/components/schemas/post-api-v2-runner-jobs-id-complete-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post-api-v2-runner-jobs-id-complete-5a9aa4" } } }, "description": "Success" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-403" } } }, "description": "Forbidden" } }, "summary": "POST /api/v2/runner/jobs/:id/complete", "tags": [ "runner" ] } }, "/api/v2/runner/jobs/{id}/events": { "post": { "operationId": "post-api-v2-runner-jobs-id-events", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "event": "galaxy_install", "failed": false, "stderr": "", "stdout": "Starting galaxy collection install process\ncommunity.general:9.4.0 was installed successfully\n", "task": "Install collections from requirements.yml" }, "schema": { "$ref": "#/components/schemas/post-api-v2-runner-jobs-id-events-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders." }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post-api-v2-runner-jobs-id-events-041bf4" } } }, "description": "Success" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-403" } } }, "description": "Forbidden" } }, "summary": "POST /api/v2/runner/jobs/:id/events", "tags": [ "runner" ] } }, "/api/v2/runner/jobs/{id}/output": { "post": { "operationId": "post-api-v2-runner-jobs-id-output", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "output": "OpenTofu will perform the following actions:\n\n # null_resource.example will be created\n\nPlan: 1 to add, 0 to change, 0 to destroy.\n", "runner_id": "\u003cuuid\u003e", "stream": "plan" }, "schema": { "$ref": "#/components/schemas/post-api-v2-runner-jobs-id-output-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post-api-v2-runner-jobs-id-output-0fcec5" } } }, "description": "Success" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-403" } } }, "description": "Forbidden" } }, "summary": "POST /api/v2/runner/jobs/:id/output", "tags": [ "runner" ] } }, "/api/v2/runner/jobs/{id}/playbook-snapshot": { "get": { "operationId": "get-api-v2-runner-jobs-id-playbook-snapshot", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-403" } } }, "description": "Forbidden" } }, "summary": "GET /api/v2/runner/jobs/:id/playbook-snapshot", "tags": [ "runner" ] } }, "/api/v2/runner/jobs/{id}/start": { "post": { "operationId": "post-api-v2-runner-jobs-id-start", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "runner_id": "\u003cuuid\u003e" }, "schema": { "$ref": "#/components/schemas/post-api-v2-runner-jobs-id-start-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post-api-v2-runner-jobs-id-start-f47007" } } }, "description": "Success" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-403" } } }, "description": "Forbidden" } }, "summary": "POST /api/v2/runner/jobs/:id/start", "tags": [ "runner" ] } }, "/api/v2/runner/jobs/{id}/state": { "post": { "operationId": "post-api-v2-runner-jobs-id-state", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "runner_id": "\u003cuuid\u003e", "state": "eyJ2ZXJzaW9uIjo0LCJ0ZXJyYWZvcm1fdmVyc2lvbiI6IjEuOS4wIiwic2VyaWFsIjoxLCJsaW5lYWdlIjoiZ29sZGVuLXdyaXRlLWxpbmVhZ2UiLCJvdXRwdXRzIjp7ImVuZHBvaW50Ijp7InZhbHVlIjoiaHR0cHM6Ly9zZXJ2aWNlLmV4YW1wbGUuY29tIiwidHlwZSI6InN0cmluZyJ9fSwicmVzb3VyY2VzIjpbXX0=" }, "schema": { "$ref": "#/components/schemas/post-api-v2-runner-jobs-id-state-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders." }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post-api-v2-runner-jobs-id-state-562204" } } }, "description": "Success" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-403" } } }, "description": "Forbidden" } }, "summary": "POST /api/v2/runner/jobs/:id/state", "tags": [ "runner" ] } }, "/api/v2/runner/jobs/{id}/status": { "get": { "operationId": "get-api-v2-runner-jobs-id-status", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-403" } } }, "description": "Forbidden" } }, "summary": "GET /api/v2/runner/jobs/:id/status", "tags": [ "runner" ] } }, "/api/v2/runner/register": { "post": { "operationId": "post-api-v2-runner-register", "requestBody": { "content": { "application/json": { "example": { "agent_pool_id": "\u003cuuid\u003e", "agent_version": "1.4.2", "ansible_version": "2.17.4", "available_collections": [ "ansible.posix", "community.general" ], "hostname": "runner-01.internal.example.com", "labels": [ "region:eu-west-1", "gpu" ], "max_concurrent_jobs": 2, "name": "golden-write-runner", "os_type": "linux", "os_version": "Ubuntu 24.04", "tofu_version": "1.9.0" }, "schema": { "$ref": "#/components/schemas/post-api-v2-runner-register-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders.", "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post-api-v2-runner-register-1039b3" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-400" } } }, "description": "Bad Request" } }, "summary": "POST /api/v2/runner/register", "tags": [ "runner" ] } }, "/api/v2/runners/{id}": { "delete": { "description": "Takes no request body.", "operationId": "delete-api-v2-runners-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success. No content." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "DELETE /api/v2/runners/:id", "tags": [ "runners" ] }, "get": { "operationId": "get-api-v2-runners-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runners-response" } } }, "description": "Success" } }, "summary": "GET /api/v2/runners/:id", "tags": [ "runners" ] }, "patch": { "operationId": "patch-api-v2-runners-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": { "attributes": { "description": "Build capacity for non-production workspaces", "labels": [ "region:eu-west-1", "tier:build" ] }, "type": "runners" } }, "schema": { "$ref": "#/components/schemas/patch-api-v2-runners-id-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders." }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/patch-api-v2-runners-id-response" } } }, "description": "Success" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "PATCH /api/v2/runners/:id", "tags": [ "runners" ] } }, "/api/v2/runs": { "post": { "operationId": "post-api-v2-runs", "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": { "attributes": { "message": "Recorded by the golden write harness", "plan-only": true }, "relationships": { "workspace": { "data": { "id": "\u003cid\u003e", "type": "workspaces" } } }, "type": "runs" } }, "schema": { "$ref": "#/components/schemas/post-api-v2-runs-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders.", "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runs-response" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-400" } } }, "description": "Bad Request" } }, "summary": "POST /api/v2/runs", "tags": [ "runs" ] } }, "/api/v2/runs/{id}": { "get": { "operationId": "get-api-v2-runs-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runs-response" } } }, "description": "Success" } }, "summary": "GET /api/v2/runs/:id", "tags": [ "runs" ] } }, "/api/v2/runs/{id}/actions/apply": { "post": { "description": "Takes no request body.", "operationId": "post-api-v2-runs-id-actions-apply", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runs-response" } } }, "description": "Success" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "POST /api/v2/runs/:id/actions/apply", "tags": [ "runs" ] } }, "/api/v2/runs/{id}/actions/cancel": { "post": { "description": "Takes no request body.", "operationId": "post-api-v2-runs-id-actions-cancel", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "202": { "description": "Success. No content." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "POST /api/v2/runs/:id/actions/cancel", "tags": [ "runs" ] } }, "/api/v2/runs/{id}/actions/discard": { "post": { "description": "Takes no request body.", "operationId": "post-api-v2-runs-id-actions-discard", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "202": { "description": "Success. No content." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "POST /api/v2/runs/:id/actions/discard", "tags": [ "runs" ] } }, "/api/v2/runs/{id}/actions/force-cancel": { "post": { "description": "Takes no request body.", "operationId": "post-api-v2-runs-id-actions-force-cancel", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "202": { "description": "Success. No content." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "POST /api/v2/runs/:id/actions/force-cancel", "tags": [ "runs" ] } }, "/api/v2/runs/{id}/actions/force-execute": { "post": { "description": "Takes no request body.", "operationId": "post-api-v2-runs-id-actions-force-execute", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "202": { "description": "Success. No content." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "POST /api/v2/runs/:id/actions/force-execute", "tags": [ "runs" ] } }, "/api/v2/runs/{id}/logs": { "get": { "description": "Not recorded by the golden harness: needs the Redis log buffer and object storage, which the harness does not stand up", "operationId": "get-api-v2-runs-id-logs", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "description": "The most to return in one response.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" } }, { "description": "How far in to start, counted from 0.", "in": "query", "name": "offset", "required": false, "schema": { "type": "integer" } }, { "in": "query", "name": "phase", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "token", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "text/plain": { "schema": { "type": "string" } } }, "description": "Raw run log output. Supports the offset and limit query parameters." } }, "summary": "GET /api/v2/runs/:id/logs", "tags": [ "runs" ] } }, "/api/v2/runs/{id}/logs/apply": { "get": { "description": "Not recorded by the golden harness: same log backend as /logs; recovers to a 500 with an empty body", "operationId": "get-api-v2-runs-id-logs-apply", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "description": "The most to return in one response.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" } }, { "description": "How far in to start, counted from 0.", "in": "query", "name": "offset", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "text/plain": { "schema": { "type": "string" } } }, "description": "Raw run log output. Supports the offset and limit query parameters." } }, "summary": "GET /api/v2/runs/:id/logs/apply", "tags": [ "runs" ] } }, "/api/v2/runs/{id}/logs/plan": { "get": { "description": "Not recorded by the golden harness: same log backend as /logs; recovers to a 500 with an empty body", "operationId": "get-api-v2-runs-id-logs-plan", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "description": "The most to return in one response.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" } }, { "description": "How far in to start, counted from 0.", "in": "query", "name": "offset", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "text/plain": { "schema": { "type": "string" } } }, "description": "Raw run log output. Supports the offset and limit query parameters." } }, "summary": "GET /api/v2/runs/:id/logs/plan", "tags": [ "runs" ] } }, "/api/v2/runs/{id}/outputs": { "get": { "operationId": "get-api-v2-runs-id-outputs", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "GET /api/v2/runs/:id/outputs", "tags": [ "runs" ] } }, "/api/v2/runs/{id}/plan": { "get": { "operationId": "get-api-v2-runs-id-plan", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plans-response" } } }, "description": "Success" } }, "summary": "GET /api/v2/runs/:id/plan", "tags": [ "runs" ] } }, "/api/v2/runs/{id}/task-stages": { "get": { "operationId": "get-api-v2-runs-id-task-stages", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "description": "Which page to return, 1-based.", "in": "query", "name": "page[number]", "required": false, "schema": { "type": "integer" } }, { "description": "Rows per page. Clamped to the endpoint's maximum; a value below 1 falls back to its default.", "in": "query", "name": "page[size]", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/get-api-v2-runs-id-task-stages-c0bd83" } } }, "description": "Success" } }, "summary": "GET /api/v2/runs/:id/task-stages", "tags": [ "runs" ] } }, "/api/v2/settings/2fa": { "delete": { "description": "Takes no request body.", "operationId": "delete-api-v2-settings-2fa", "responses": { "204": { "description": "Success. No content." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-403" } } }, "description": "Forbidden" } }, "summary": "DELETE /api/v2/settings/2fa", "tags": [ "settings" ] } }, "/api/v2/settings/2fa/start": { "post": { "description": "Takes no request body.", "operationId": "post-api-v2-settings-2fa-start", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post-api-v2-settings-2fa-start-meta" } } }, "description": "Success" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-403" } } }, "description": "Forbidden" } }, "summary": "POST /api/v2/settings/2fa/start", "tags": [ "settings" ] } }, "/api/v2/settings/2fa/status": { "get": { "operationId": "get-api-v2-settings-2fa-status", "responses": { "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-403" } } }, "description": "Forbidden" } }, "summary": "GET /api/v2/settings/2fa/status", "tags": [ "settings" ] } }, "/api/v2/settings/2fa/verify": { "post": { "operationId": "post-api-v2-settings-2fa-verify", "requestBody": { "content": { "application/json": { "example": { "data": { "attributes": { "code": "\u003csecret\u003e" }, "type": "two-factor" } }, "schema": { "$ref": "#/components/schemas/post-api-v2-settings-2fa-verify-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/two-factor-response" } } }, "description": "Success" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-403" } } }, "description": "Forbidden" } }, "summary": "POST /api/v2/settings/2fa/verify", "tags": [ "settings" ] } }, "/api/v2/settings/api-keys": { "get": { "operationId": "get-api-v2-settings-api-keys", "responses": { "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-403" } } }, "description": "Forbidden" } }, "summary": "GET /api/v2/settings/api-keys", "tags": [ "settings" ] }, "post": { "operationId": "post-api-v2-settings-api-keys", "requestBody": { "content": { "application/json": { "example": { "data": { "attributes": { "expires-at": "\u003ctimestamp\u003e", "name": "ci-pipeline", "scopes": [ "org:\u003cuuid\u003e:read", "org:\u003cuuid\u003e:write" ] }, "type": "api-keys" } }, "schema": { "$ref": "#/components/schemas/post-api-v2-settings-api-keys-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders.", "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api-keys-response" } } }, "description": "Success" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-403" } } }, "description": "Forbidden" } }, "summary": "POST /api/v2/settings/api-keys", "tags": [ "settings" ] } }, "/api/v2/settings/api-keys/{id}": { "delete": { "description": "Takes no request body.", "operationId": "delete-api-v2-settings-api-keys-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success. No content." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-403" } } }, "description": "Forbidden" } }, "summary": "DELETE /api/v2/settings/api-keys/:id", "tags": [ "settings" ] } }, "/api/v2/settings/mfa-devices": { "get": { "operationId": "get-api-v2-settings-mfa-devices", "responses": { "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-403" } } }, "description": "Forbidden" } }, "summary": "GET /api/v2/settings/mfa-devices", "tags": [ "settings" ] } }, "/api/v2/settings/password": { "post": { "operationId": "post-api-v2-settings-password", "requestBody": { "content": { "application/json": { "example": { "data": { "attributes": { "current-password": "\u003csecret\u003e", "new-password": "\u003csecret\u003e" }, "type": "users" } }, "schema": { "$ref": "#/components/schemas/post-api-v2-settings-password-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders.", "required": true }, "responses": { "204": { "description": "Success. No content." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-403" } } }, "description": "Forbidden" } }, "summary": "POST /api/v2/settings/password", "tags": [ "settings" ] } }, "/api/v2/settings/sessions": { "get": { "operationId": "get-api-v2-settings-sessions", "responses": { "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-403" } } }, "description": "Forbidden" } }, "summary": "GET /api/v2/settings/sessions", "tags": [ "settings" ] } }, "/api/v2/settings/sessions/{sessionId}": { "delete": { "description": "Takes no request body.", "operationId": "delete-api-v2-settings-sessions-sessionId", "parameters": [ { "in": "path", "name": "sessionId", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success. No content." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-403" } } }, "description": "Forbidden" } }, "summary": "DELETE /api/v2/settings/sessions/:sessionId", "tags": [ "settings" ] } }, "/api/v2/state-versions/{id}": { "delete": { "description": "Takes no request body.", "operationId": "delete-api-v2-state-versions-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success. No content." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "DELETE /api/v2/state-versions/:id", "tags": [ "state-versions" ] }, "get": { "operationId": "get-api-v2-state-versions-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "GET /api/v2/state-versions/:id", "tags": [ "state-versions" ] } }, "/api/v2/state-versions/{id}/download": { "get": { "operationId": "get-api-v2-state-versions-id-download", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "GET /api/v2/state-versions/:id/download", "tags": [ "state-versions" ] } }, "/api/v2/state-versions/{id}/outputs": { "get": { "operationId": "get-api-v2-state-versions-id-outputs", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "GET /api/v2/state-versions/:id/outputs", "tags": [ "state-versions" ] } }, "/api/v2/task-result-outcomes/{id}": { "get": { "operationId": "get-api-v2-task-result-outcomes-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "GET /api/v2/task-result-outcomes/:id", "tags": [ "task-result-outcomes" ] } }, "/api/v2/task-results/{id}": { "get": { "operationId": "get-api-v2-task-results-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/task-results-response" } } }, "description": "Success" } }, "summary": "GET /api/v2/task-results/:id", "tags": [ "task-results" ] } }, "/api/v2/task-results/{id}/callback": { "patch": { "operationId": "patch-api-v2-task-results-id-callback", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": { "attributes": { "message": "No drift detected in 14 resources.", "status": "passed", "url": "https://tasks.example.com/drift/results/1042" }, "type": "task-results" }, "included": [ { "attributes": { "body": "## Drift scan\n\n14 resources checked, 0 drifted.", "description": "All managed resources match their recorded state.", "outcome-id": "DRIFT-001", "tags": { "Severity": [ { "label": "None" } ], "Status": [ { "label": "Passed", "level": "info" } ] }, "url": "https://tasks.example.com/drift/results/1042#DRIFT-001" }, "type": "task-result-outcomes" } ] }, "schema": { "$ref": "#/components/schemas/patch-api-v2-task-results-id-callback-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders." }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/task-results-response" } } }, "description": "Success" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-401" } } }, "description": "Unauthorized" } }, "summary": "PATCH /api/v2/task-results/:id/callback", "tags": [ "task-results" ] } }, "/api/v2/task-results/{id}/outcomes": { "get": { "operationId": "get-api-v2-task-results-id-outcomes", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "description": "Which page to return, 1-based.", "in": "query", "name": "page[number]", "required": false, "schema": { "type": "integer" } }, { "description": "Rows per page. Clamped to the endpoint's maximum; a value below 1 falls back to its default.", "in": "query", "name": "page[size]", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/get-api-v2-task-results-id-outcomes-0445e7" } } }, "description": "Success" } }, "summary": "GET /api/v2/task-results/:id/outcomes", "tags": [ "task-results" ] } }, "/api/v2/task-stages/{id}": { "get": { "operationId": "get-api-v2-task-stages-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "include", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/task-stages-response" } } }, "description": "Success" } }, "summary": "GET /api/v2/task-stages/:id", "tags": [ "task-stages" ] } }, "/api/v2/task-stages/{id}/actions/override": { "post": { "operationId": "post-api-v2-task-stages-id-actions-override", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.api+json": { "example": { "comment": "Reviewed with the platform team: the reported drift is expected." }, "schema": { "$ref": "#/components/schemas/post-api-v2-task-stages-id-actions-override-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders." }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/task-stages-response" } } }, "description": "Success" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "POST /api/v2/task-stages/:id/actions/override", "tags": [ "task-stages" ] } }, "/api/v2/tasks/{id}": { "delete": { "description": "Takes no request body.", "operationId": "delete-api-v2-tasks-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success. No content." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "DELETE /api/v2/tasks/:id", "tags": [ "tasks" ] }, "get": { "operationId": "get-api-v2-tasks-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "include", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tasks-response" } } }, "description": "Success" } }, "summary": "GET /api/v2/tasks/:id", "tags": [ "tasks" ] }, "patch": { "operationId": "patch-api-v2-tasks-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": { "attributes": { "category": "task", "description": "Updated by the golden write harness", "enabled": false, "global-configuration": { "enabled": true, "enforcement-level": "advisory", "stages": [ "post_plan", "pre_apply" ] }, "name": "drift-scanner" }, "type": "tasks" } }, "schema": { "$ref": "#/components/schemas/patch-api-v2-tasks-id-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders." }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/patch-api-v2-tasks-id-response" } } }, "description": "Success" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "PATCH /api/v2/tasks/:id", "tags": [ "tasks" ] } }, "/api/v2/team-projects": { "get": { "operationId": "get-api-v2-team-projects", "parameters": [ { "in": "query", "name": "filter[project][id]", "required": false, "schema": { "type": "string" } } ], "responses": { "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-400" } } }, "description": "Bad Request" } }, "summary": "GET /api/v2/team-projects", "tags": [ "team-projects" ] }, "post": { "operationId": "post-api-v2-team-projects", "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": { "attributes": { "access": "custom", "project-access": { "settings": "read", "teams": "none", "variable-sets": "read" }, "workspace-access": { "create": true, "delete": false, "locking": true, "move": false, "run-tasks": false, "runs": "apply", "sentinel-mocks": "none", "state-versions": "read-outputs", "variables": "write" } }, "relationships": { "project": { "data": { "id": "\u003cuuid\u003e", "type": "projects" } }, "team": { "data": { "id": "\u003cuuid\u003e", "type": "teams" } } }, "type": "team-projects" } }, "schema": { "$ref": "#/components/schemas/post-api-v2-team-projects-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders.", "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/team-projects-response" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-400" } } }, "description": "Bad Request" } }, "summary": "POST /api/v2/team-projects", "tags": [ "team-projects" ] } }, "/api/v2/team-projects/{id}": { "delete": { "description": "Takes no request body.", "operationId": "delete-api-v2-team-projects-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success. No content." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "DELETE /api/v2/team-projects/:id", "tags": [ "team-projects" ] }, "get": { "operationId": "get-api-v2-team-projects-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/team-projects-response" } } }, "description": "Success" } }, "summary": "GET /api/v2/team-projects/:id", "tags": [ "team-projects" ] }, "patch": { "operationId": "patch-api-v2-team-projects-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": { "attributes": { "access": "maintain" }, "type": "team-projects" } }, "schema": { "$ref": "#/components/schemas/patch-api-v2-team-projects-id-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/team-projects-response" } } }, "description": "Success" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "PATCH /api/v2/team-projects/:id", "tags": [ "team-projects" ] } }, "/api/v2/team-workspaces": { "get": { "operationId": "get-api-v2-team-workspaces", "parameters": [ { "in": "query", "name": "filter[workspace][id]", "required": false, "schema": { "type": "string" } } ], "responses": { "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "GET /api/v2/team-workspaces", "tags": [ "team-workspaces" ] }, "post": { "operationId": "post-api-v2-team-workspaces", "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": { "attributes": { "access": "custom", "run-tasks": false, "runs": "apply", "sentinel-mocks": "none", "state-versions": "read-outputs", "variables": "write", "workspace-locking": true }, "relationships": { "team": { "data": { "id": "\u003cuuid\u003e", "type": "teams" } }, "workspace": { "data": { "id": "\u003cid\u003e", "type": "workspaces" } } }, "type": "team-workspaces" } }, "schema": { "$ref": "#/components/schemas/post-api-v2-team-workspaces-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders.", "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/team-workspaces-response" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-400" } } }, "description": "Bad Request" } }, "summary": "POST /api/v2/team-workspaces", "tags": [ "team-workspaces" ] } }, "/api/v2/team-workspaces/{id}": { "delete": { "description": "Takes no request body.", "operationId": "delete-api-v2-team-workspaces-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success. No content." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "DELETE /api/v2/team-workspaces/:id", "tags": [ "team-workspaces" ] }, "get": { "operationId": "get-api-v2-team-workspaces-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/team-workspaces-response" } } }, "description": "Success" } }, "summary": "GET /api/v2/team-workspaces/:id", "tags": [ "team-workspaces" ] }, "patch": { "operationId": "patch-api-v2-team-workspaces-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": { "attributes": { "access": "admin" }, "type": "team-workspaces" } }, "schema": { "$ref": "#/components/schemas/patch-api-v2-team-workspaces-id-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/team-workspaces-response" } } }, "description": "Success" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "PATCH /api/v2/team-workspaces/:id", "tags": [ "team-workspaces" ] } }, "/api/v2/teams/{id}": { "delete": { "description": "Takes no request body.", "operationId": "delete-api-v2-teams-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success. No content." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "DELETE /api/v2/teams/:id", "tags": [ "teams" ] }, "get": { "operationId": "get-api-v2-teams-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "include", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/teams-response" } } }, "description": "Success" } }, "summary": "GET /api/v2/teams/:id", "tags": [ "teams" ] }, "patch": { "operationId": "patch-api-v2-teams-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": { "attributes": { "allow-member-token-management": false, "description": "Updated by the golden write harness", "name": "golden-write-renamed", "sso-team-id": "golden-write-idp-group", "visibility": "secret" }, "type": "teams" } }, "schema": { "$ref": "#/components/schemas/patch-api-v2-teams-id-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/teams-response" } } }, "description": "Success" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "PATCH /api/v2/teams/:id", "tags": [ "teams" ] } }, "/api/v2/teams/{id}/authentication-token": { "delete": { "description": "Takes no request body.", "operationId": "delete-api-v2-teams-id-authentication-token", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success. No content." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "DELETE /api/v2/teams/:id/authentication-token", "tags": [ "teams" ] }, "get": { "operationId": "get-api-v2-teams-id-authentication-token", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "GET /api/v2/teams/:id/authentication-token", "tags": [ "teams" ] }, "post": { "operationId": "post-api-v2-teams-id-authentication-token", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": { "attributes": { "expired-at": "\u003ctimestamp\u003e" }, "type": "authentication-tokens" } }, "schema": { "$ref": "#/components/schemas/post-api-v2-teams-id-authentication-token-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders." }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/authentication-tokens-response" } } }, "description": "Success" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "POST /api/v2/teams/:id/authentication-token", "tags": [ "teams" ] } }, "/api/v2/teams/{id}/notification-configurations": { "get": { "operationId": "get-api-v2-teams-id-notification-configurations", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/get-api-v2-teams-id-notification-configurations-cc06a2" } } }, "description": "Success" } }, "summary": "GET /api/v2/teams/:id/notification-configurations", "tags": [ "teams" ] }, "post": { "operationId": "post-api-v2-teams-id-notification-configurations", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": { "attributes": { "destination-type": "email", "email-addresses": [ "platform-team@example.com", "on-call@example.com" ], "enabled": true, "name": "golden-write-change-requests", "triggers": [ "change_request:created" ] }, "type": "notification-configurations" } }, "schema": { "$ref": "#/components/schemas/post-api-v2-teams-id-notification-configurations-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders." }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post-api-v2-teams-id-notification-configurations-response" } } }, "description": "Success" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "POST /api/v2/teams/:id/notification-configurations", "tags": [ "teams" ] } }, "/api/v2/teams/{id}/relationships/organization-memberships": { "delete": { "operationId": "delete-api-v2-teams-id-relationships-organization-memberships", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": [ { "id": "\u003cuuid\u003e", "type": "organization-memberships" } ] }, "schema": { "$ref": "#/components/schemas/delete-api-v2-teams-id-relationships-organization-memberships-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders.", "required": true }, "responses": { "204": { "description": "Success. No content." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "DELETE /api/v2/teams/:id/relationships/organization-memberships", "tags": [ "teams" ] }, "get": { "operationId": "get-api-v2-teams-id-relationships-organization-memberships", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/organization-memberships-collection" } } }, "description": "Success" } }, "summary": "GET /api/v2/teams/:id/relationships/organization-memberships", "tags": [ "teams" ] }, "post": { "operationId": "post-api-v2-teams-id-relationships-organization-memberships", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": [ { "id": "\u003cuuid\u003e", "type": "organization-memberships" } ] }, "schema": { "$ref": "#/components/schemas/post-api-v2-teams-id-relationships-organization-memberships-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders.", "required": true }, "responses": { "204": { "description": "Success. No content." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "POST /api/v2/teams/:id/relationships/organization-memberships", "tags": [ "teams" ] } }, "/api/v2/teams/{id}/relationships/users": { "delete": { "operationId": "delete-api-v2-teams-id-relationships-users", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": [ { "id": "priya.raman@example.com", "type": "users" } ] }, "schema": { "$ref": "#/components/schemas/delete-api-v2-teams-id-relationships-users-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders.", "required": true }, "responses": { "204": { "description": "Success. No content." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "DELETE /api/v2/teams/:id/relationships/users", "tags": [ "teams" ] }, "post": { "operationId": "post-api-v2-teams-id-relationships-users", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": [ { "id": "lena.fischer@example.com", "type": "users" } ] }, "schema": { "$ref": "#/components/schemas/post-api-v2-teams-id-relationships-users-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders.", "required": true }, "responses": { "204": { "description": "Success. No content." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "POST /api/v2/teams/:id/relationships/users", "tags": [ "teams" ] } }, "/api/v2/terraform-versions": { "get": { "operationId": "get-api-v2-terraform-versions", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/terraform-versions-collection" } } }, "description": "Success" } }, "summary": "GET /api/v2/terraform-versions", "tags": [ "terraform-versions" ] } }, "/api/v2/terraform/workspaces/{id}": { "get": { "operationId": "get-api-v2-terraform-workspaces-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "include", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workspaces-response" } } }, "description": "Success" } }, "summary": "GET /api/v2/terraform/workspaces/:id", "tags": [ "terraform" ] } }, "/api/v2/tokens": { "get": { "operationId": "get-api-v2-tokens", "responses": { "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-403" } } }, "description": "Forbidden" } }, "summary": "GET /api/v2/tokens", "tags": [ "tokens" ] }, "post": { "operationId": "post-api-v2-tokens", "requestBody": { "content": { "application/json": { "example": { "data": { "attributes": { "description": "Laptop CLI", "expires_at": "\u003ctimestamp\u003e", "platform_admin": true }, "type": "tokens" } }, "schema": { "$ref": "#/components/schemas/post-api-v2-tokens-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders.", "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tokens-response" } } }, "description": "Success" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-403" } } }, "description": "Forbidden" } }, "summary": "POST /api/v2/tokens", "tags": [ "tokens" ] } }, "/api/v2/tokens/{id}": { "delete": { "description": "Takes no request body.", "operationId": "delete-api-v2-tokens-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success. No content." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-403" } } }, "description": "Forbidden" } }, "summary": "DELETE /api/v2/tokens/:id", "tags": [ "tokens" ] } }, "/api/v2/varsets/{id}": { "delete": { "description": "Takes no request body.", "operationId": "delete-api-v2-varsets-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success. No content." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "DELETE /api/v2/varsets/:id", "tags": [ "varsets" ] }, "get": { "operationId": "get-api-v2-varsets-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/varsets-response" } } }, "description": "Success" } }, "summary": "GET /api/v2/varsets/:id", "tags": [ "varsets" ] }, "patch": { "operationId": "patch-api-v2-varsets-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": { "attributes": { "description": "Updated by the golden write harness", "global": false, "name": "golden-write-renamed", "priority": true }, "type": "varsets" } }, "schema": { "$ref": "#/components/schemas/patch-api-v2-varsets-id-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/varsets-response" } } }, "description": "Success" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "PATCH /api/v2/varsets/:id", "tags": [ "varsets" ] } }, "/api/v2/varsets/{id}/relationships/projects": { "delete": { "operationId": "delete-api-v2-varsets-id-relationships-projects", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": [ { "id": "\u003cuuid\u003e", "type": "projects" } ] }, "schema": { "$ref": "#/components/schemas/delete-api-v2-varsets-id-relationships-projects-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders." }, "responses": { "204": { "description": "Success. No content." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "DELETE /api/v2/varsets/:id/relationships/projects", "tags": [ "varsets" ] }, "post": { "operationId": "post-api-v2-varsets-id-relationships-projects", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": [ { "id": "\u003cuuid\u003e", "type": "projects" } ] }, "schema": { "$ref": "#/components/schemas/post-api-v2-varsets-id-relationships-projects-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders." }, "responses": { "204": { "description": "Success. No content." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "POST /api/v2/varsets/:id/relationships/projects", "tags": [ "varsets" ] } }, "/api/v2/varsets/{id}/relationships/vars": { "get": { "operationId": "get-api-v2-varsets-id-relationships-vars", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vars-collection" } } }, "description": "Success" } }, "summary": "GET /api/v2/varsets/:id/relationships/vars", "tags": [ "varsets" ] }, "post": { "operationId": "post-api-v2-varsets-id-relationships-vars", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": { "attributes": { "category": "env", "description": "Recorded by the golden write harness", "hcl": false, "key": "AWS_SESSION_TOKEN", "sensitive": true, "value": "\u003csecret\u003e" }, "type": "vars" } }, "schema": { "$ref": "#/components/schemas/post-api-v2-varsets-id-relationships-vars-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders.", "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vars-response" } } }, "description": "Success" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "POST /api/v2/varsets/:id/relationships/vars", "tags": [ "varsets" ] } }, "/api/v2/varsets/{id}/relationships/vars/{variable_id}": { "delete": { "description": "Takes no request body.", "operationId": "delete-api-v2-varsets-id-relationships-vars-variable_id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "variable_id", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success. No content." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "DELETE /api/v2/varsets/:id/relationships/vars/:variable_id", "tags": [ "varsets" ] }, "get": { "operationId": "get-api-v2-varsets-id-relationships-vars-variable_id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "variable_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vars-response" } } }, "description": "Success" } }, "summary": "GET /api/v2/varsets/:id/relationships/vars/:variable_id", "tags": [ "varsets" ] }, "patch": { "operationId": "patch-api-v2-varsets-id-relationships-vars-variable_id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "variable_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": { "attributes": { "category": "env", "description": "Updated by the golden write harness", "key": "AWS_DEFAULT_REGION", "sensitive": false, "value": "eu-central-1" }, "type": "vars" } }, "schema": { "$ref": "#/components/schemas/patch-api-v2-varsets-id-relationships-vars-variable_id-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vars-response" } } }, "description": "Success" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "PATCH /api/v2/varsets/:id/relationships/vars/:variable_id", "tags": [ "varsets" ] } }, "/api/v2/varsets/{id}/relationships/workspaces": { "delete": { "operationId": "delete-api-v2-varsets-id-relationships-workspaces", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": [ { "id": "\u003cid\u003e", "type": "workspaces" } ] }, "schema": { "$ref": "#/components/schemas/delete-api-v2-varsets-id-relationships-workspaces-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders." }, "responses": { "204": { "description": "Success. No content." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "DELETE /api/v2/varsets/:id/relationships/workspaces", "tags": [ "varsets" ] }, "post": { "operationId": "post-api-v2-varsets-id-relationships-workspaces", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": [ { "id": "\u003cid\u003e", "type": "workspaces" } ] }, "schema": { "$ref": "#/components/schemas/post-api-v2-varsets-id-relationships-workspaces-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders." }, "responses": { "204": { "description": "Success. No content." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "POST /api/v2/varsets/:id/relationships/workspaces", "tags": [ "varsets" ] } }, "/api/v2/vcs-connections/azure-devops/callback": { "post": { "description": "Not recorded: a successful call needs a system outside the machine. The server exchanges the authorization code with Microsoft Entra ID and then checks the token it gets against the Azure DevOps organization. Success needs a code Entra ID issued for a browser sign-in and both services to answer. No request was sent, so this operation's request body and success response are not described.", "operationId": "post-api-v2-vcs-connections-azure-devops-callback", "parameters": [ { "in": "query", "name": "code", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "state", "required": false, "schema": { "type": "string" } } ], "responses": { "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-400" } } }, "description": "Bad Request" } }, "summary": "POST /api/v2/vcs-connections/azure-devops/callback", "tags": [ "vcs-connections" ] } }, "/api/v2/vcs-connections/azure-devops/webhook": { "post": { "operationId": "post-api-v2-vcs-connections-azure-devops-webhook", "requestBody": { "content": { "application/json": { "example": { "eventType": "git.push", "notificationId": 14, "publisherId": "tfs", "resource": { "commits": [ { "author": { "email": "avery.diaz@example.com", "name": "Avery Diaz" }, "comment": "Open the admin port to the bastion subnet", "commitId": "33b55f7cb7e7e245323987634f960cf4a6e6bc74" } ], "refUpdates": [ { "name": "refs/heads/main", "newObjectId": "33b55f7cb7e7e245323987634f960cf4a6e6bc74", "oldObjectId": "aad331d8d3b131fa9ae03cf5e53965b51942618a" } ], "repository": { "name": "network", "project": { "name": "Infrastructure" }, "remoteUrl": "https://dev.azure.com/acme-platform/Infrastructure/_git/network" } }, "subscriptionId": "\u003cuuid\u003e" }, "schema": { "$ref": "#/components/schemas/post-api-v2-vcs-connections-azure-devops-webhook-request" } } }, "description": "Described from one accepted request rather than from a type: a member this example does not send may still be accepted. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders." }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post-api-v2-vcs-connections-azure-devops-webhook-c11ee6" } } }, "description": "Success" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-401" } } }, "description": "Unauthorized" } }, "summary": "POST /api/v2/vcs-connections/azure-devops/webhook", "tags": [ "vcs-connections" ] } }, "/api/v2/vcs-connections/{id}": { "delete": { "description": "Takes no request body.", "operationId": "delete-api-v2-vcs-connections-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success. No content." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "DELETE /api/v2/vcs-connections/:id", "tags": [ "vcs-connections" ] }, "get": { "operationId": "get-api-v2-vcs-connections-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "GET /api/v2/vcs-connections/:id", "tags": [ "vcs-connections" ] } }, "/api/v2/vcs-connections/{id}/projects": { "get": { "operationId": "get-api-v2-vcs-connections-id-projects", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "description": "An older spelling of page[number], read when page[number] is absent.", "in": "query", "name": "page", "required": false, "schema": { "type": "integer" } }, { "description": "Which page to return, 1-based.", "in": "query", "name": "page[number]", "required": false, "schema": { "type": "integer" } }, { "description": "Rows per page. Clamped to the endpoint's maximum; a value below 1 falls back to its default.", "in": "query", "name": "page[size]", "required": false, "schema": { "type": "integer" } }, { "description": "An older spelling of page[size], read when page[size] is absent.", "in": "query", "name": "per_page", "required": false, "schema": { "type": "integer" } } ], "responses": { "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "GET /api/v2/vcs-connections/:id/projects", "tags": [ "vcs-connections" ] } }, "/api/v2/vcs-connections/{id}/repositories": { "get": { "operationId": "get-api-v2-vcs-connections-id-repositories", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "description": "An older spelling of page[number], read when page[number] is absent.", "in": "query", "name": "page", "required": false, "schema": { "type": "integer" } }, { "description": "Which page to return, 1-based.", "in": "query", "name": "page[number]", "required": false, "schema": { "type": "integer" } }, { "description": "Rows per page. Clamped to the endpoint's maximum; a value below 1 falls back to its default.", "in": "query", "name": "page[size]", "required": false, "schema": { "type": "integer" } }, { "description": "An older spelling of page[size], read when page[size] is absent.", "in": "query", "name": "per_page", "required": false, "schema": { "type": "integer" } }, { "in": "query", "name": "project", "required": false, "schema": { "type": "string" } } ], "responses": { "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "GET /api/v2/vcs-connections/:id/repositories", "tags": [ "vcs-connections" ] } }, "/api/v2/vcs-connections/{id}/repositories/{owner}/{repo}/branches": { "get": { "operationId": "get-api-v2-vcs-connections-id-repositories-owner-repo-branches", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "owner", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "repo", "required": true, "schema": { "type": "string" } }, { "description": "An older spelling of page[number], read when page[number] is absent.", "in": "query", "name": "page", "required": false, "schema": { "type": "integer" } }, { "description": "Which page to return, 1-based.", "in": "query", "name": "page[number]", "required": false, "schema": { "type": "integer" } }, { "description": "Rows per page. Clamped to the endpoint's maximum; a value below 1 falls back to its default.", "in": "query", "name": "page[size]", "required": false, "schema": { "type": "integer" } }, { "description": "An older spelling of page[size], read when page[size] is absent.", "in": "query", "name": "per_page", "required": false, "schema": { "type": "integer" } } ], "responses": { "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "GET /api/v2/vcs-connections/:id/repositories/:owner/:repo/branches", "tags": [ "vcs-connections" ] } }, "/api/v2/vcs-connections/{id}/repositories/{owner}/{repo}/contents/{path}": { "get": { "operationId": "get-api-v2-vcs-connections-id-repositories-owner-repo-contents-path", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "owner", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "repo", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "path", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "ref", "required": false, "schema": { "type": "string" } } ], "responses": { "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "GET /api/v2/vcs-connections/:id/repositories/:owner/:repo/contents/*path", "tags": [ "vcs-connections" ] } }, "/api/v2/vcs-connections/{id}/repositories/{owner}/{repo}/inventory-files": { "get": { "operationId": "get-api-v2-vcs-connections-id-repositories-owner-repo-inventory-files", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "owner", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "repo", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "path", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "ref", "required": false, "schema": { "type": "string" } } ], "responses": { "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "GET /api/v2/vcs-connections/:id/repositories/:owner/:repo/inventory-files", "tags": [ "vcs-connections" ] } }, "/api/v2/vcs-connections/{id}/repositories/{owner}/{repo}/yaml-files": { "get": { "operationId": "get-api-v2-vcs-connections-id-repositories-owner-repo-yaml-files", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "owner", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "repo", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "ref", "required": false, "schema": { "type": "string" } } ], "responses": { "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "GET /api/v2/vcs-connections/:id/repositories/:owner/:repo/yaml-files", "tags": [ "vcs-connections" ] } }, "/api/v2/workspaces/change-requests/{id}": { "delete": { "description": "Takes no request body.", "operationId": "delete-api-v2-workspaces-change-requests-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success. No content." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "DELETE /api/v2/workspaces/change-requests/:id", "tags": [ "workspaces" ] }, "get": { "operationId": "get-api-v2-workspaces-change-requests-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workspace_change_requests-response" } } }, "description": "Success" } }, "summary": "GET /api/v2/workspaces/change-requests/:id", "tags": [ "workspaces" ] }, "patch": { "description": "Takes no request body.", "operationId": "patch-api-v2-workspaces-change-requests-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workspace_change_requests-response" } } }, "description": "Success" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "PATCH /api/v2/workspaces/change-requests/:id", "tags": [ "workspaces" ] }, "post": { "description": "Takes no request body.", "operationId": "post-api-v2-workspaces-change-requests-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workspace_change_requests-response" } } }, "description": "Success" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "POST /api/v2/workspaces/change-requests/:id", "tags": [ "workspaces" ] } }, "/api/v2/workspaces/{id}": { "delete": { "description": "Takes no request body.", "operationId": "delete-api-v2-workspaces-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success. No content." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "DELETE /api/v2/workspaces/:id", "tags": [ "workspaces" ] }, "get": { "operationId": "get-api-v2-workspaces-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "include", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workspaces-response" } } }, "description": "Success" } }, "summary": "GET /api/v2/workspaces/:id", "tags": [ "workspaces" ] }, "patch": { "operationId": "patch-api-v2-workspaces-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "include", "required": false, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": { "attributes": { "allow-destroy-plan": false, "assessments-enabled": true, "auto-apply": true, "description": "Updated by the golden write harness", "file-triggers-enabled": true, "global-remote-state": true, "trigger-patterns": [ "modules/**" ] }, "relationships": { "tag-bindings": { "data": [ { "attributes": { "key": "environment", "value": "production" }, "type": "tag-bindings" } ] } }, "type": "workspaces" } }, "schema": { "$ref": "#/components/schemas/patch-api-v2-workspaces-id-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders." }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/patch-api-v2-workspaces-id-response" } } }, "description": "Success" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "PATCH /api/v2/workspaces/:id", "tags": [ "workspaces" ] } }, "/api/v2/workspaces/{id}/actions/force-unlock": { "post": { "description": "Takes no request body.", "operationId": "post-api-v2-workspaces-id-actions-force-unlock", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workspaces-response" } } }, "description": "Success" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "POST /api/v2/workspaces/:id/actions/force-unlock", "tags": [ "workspaces" ] } }, "/api/v2/workspaces/{id}/actions/lock": { "post": { "operationId": "post-api-v2-workspaces-id-actions-lock", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.api+json": { "example": { "reason": "Maintenance window: migrating the network module" }, "schema": { "$ref": "#/components/schemas/post-api-v2-workspaces-id-actions-lock-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders." }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workspaces-response" } } }, "description": "Success" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "POST /api/v2/workspaces/:id/actions/lock", "tags": [ "workspaces" ] } }, "/api/v2/workspaces/{id}/actions/safe-delete": { "post": { "description": "Takes no request body.", "operationId": "post-api-v2-workspaces-id-actions-safe-delete", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success. No content." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "POST /api/v2/workspaces/:id/actions/safe-delete", "tags": [ "workspaces" ] } }, "/api/v2/workspaces/{id}/actions/unlock": { "post": { "description": "Takes no request body.", "operationId": "post-api-v2-workspaces-id-actions-unlock", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workspaces-response" } } }, "description": "Success" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "POST /api/v2/workspaces/:id/actions/unlock", "tags": [ "workspaces" ] } }, "/api/v2/workspaces/{id}/change-requests": { "get": { "operationId": "get-api-v2-workspaces-id-change-requests", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "filter[archived]", "required": false, "schema": { "type": "string" } }, { "description": "Which page to return, 1-based.", "in": "query", "name": "page[number]", "required": false, "schema": { "type": "integer" } }, { "description": "Rows per page. Clamped to the endpoint's maximum; a value below 1 falls back to its default.", "in": "query", "name": "page[size]", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/get-api-v2-workspaces-id-change-requests-1d148b" } } }, "description": "Success" } }, "summary": "GET /api/v2/workspaces/:id/change-requests", "tags": [ "workspaces" ] } }, "/api/v2/workspaces/{id}/configuration-versions": { "get": { "operationId": "get-api-v2-workspaces-id-configuration-versions", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/get-api-v2-workspaces-id-configuration-versions-940185" } } }, "description": "Success" } }, "summary": "GET /api/v2/workspaces/:id/configuration-versions", "tags": [ "workspaces" ] }, "post": { "operationId": "post-api-v2-workspaces-id-configuration-versions", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": { "attributes": { "auto-queue-runs": false, "speculative": true }, "type": "configuration-versions" } }, "schema": { "$ref": "#/components/schemas/post-api-v2-workspaces-id-configuration-versions-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders." }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/configuration-versions-response" } } }, "description": "Success" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "POST /api/v2/workspaces/:id/configuration-versions", "tags": [ "workspaces" ] } }, "/api/v2/workspaces/{id}/current-state-version": { "get": { "operationId": "get-api-v2-workspaces-id-current-state-version", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "GET /api/v2/workspaces/:id/current-state-version", "tags": [ "workspaces" ] } }, "/api/v2/workspaces/{id}/current-state-version-outputs": { "get": { "operationId": "get-api-v2-workspaces-id-current-state-version-outputs", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "GET /api/v2/workspaces/:id/current-state-version-outputs", "tags": [ "workspaces" ] } }, "/api/v2/workspaces/{id}/current-state-version-resources": { "get": { "operationId": "get-api-v2-workspaces-id-current-state-version-resources", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "mode", "required": false, "schema": { "type": "string" } } ], "responses": { "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "GET /api/v2/workspaces/:id/current-state-version-resources", "tags": [ "workspaces" ] } }, "/api/v2/workspaces/{id}/effective-tag-bindings": { "get": { "operationId": "get-api-v2-workspaces-id-effective-tag-bindings", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/get-api-v2-workspaces-id-effective-tag-bindings-9c10a3" } } }, "description": "Success" } }, "summary": "GET /api/v2/workspaces/:id/effective-tag-bindings", "tags": [ "workspaces" ] } }, "/api/v2/workspaces/{id}/notification-configurations": { "get": { "operationId": "get-api-v2-workspaces-id-notification-configurations", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/get-api-v2-workspaces-id-notification-configurations-8cab3c" } } }, "description": "Success" } }, "summary": "GET /api/v2/workspaces/:id/notification-configurations", "tags": [ "workspaces" ] }, "post": { "operationId": "post-api-v2-workspaces-id-notification-configurations", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": { "attributes": { "destination-type": "generic", "enabled": true, "name": "golden-write-notifications", "token": "\u003csecret\u003e", "triggers": [ "run:created", "run:needs_attention", "run:completed", "run:errored" ], "url": "https://hooks.example.com/stackweaver/runs" }, "type": "notification-configurations" } }, "schema": { "$ref": "#/components/schemas/post-api-v2-workspaces-id-notification-configurations-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders." }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/notification-configurations-response" } } }, "description": "Success" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "POST /api/v2/workspaces/:id/notification-configurations", "tags": [ "workspaces" ] } }, "/api/v2/workspaces/{id}/platform-variables": { "get": { "operationId": "get-api-v2-workspaces-id-platform-variables", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/get-api-v2-workspaces-id-platform-variables-meta" } } }, "description": "Success" } }, "summary": "GET /api/v2/workspaces/:id/platform-variables", "tags": [ "workspaces" ] } }, "/api/v2/workspaces/{id}/relationships/team-access": { "get": { "operationId": "get-api-v2-workspaces-id-relationships-team-access", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "filter[workspace][id]", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/get-api-v2-workspaces-id-relationships-team-access-361c17" } } }, "description": "Success" } }, "summary": "GET /api/v2/workspaces/:id/relationships/team-access", "tags": [ "workspaces" ] }, "post": { "operationId": "post-api-v2-workspaces-id-relationships-team-access", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": { "attributes": { "access": "write" }, "relationships": { "team": { "data": { "id": "\u003cuuid\u003e", "type": "teams" } } }, "type": "team-workspaces" } }, "schema": { "$ref": "#/components/schemas/post-api-v2-workspaces-id-relationships-team-access-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders.", "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/team-workspaces-response" } } }, "description": "Success" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "POST /api/v2/workspaces/:id/relationships/team-access", "tags": [ "workspaces" ] } }, "/api/v2/workspaces/{id}/relationships/team-access/{access_id}": { "delete": { "description": "Takes no request body.", "operationId": "delete-api-v2-workspaces-id-relationships-team-access-access_id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "access_id", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success. No content." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "DELETE /api/v2/workspaces/:id/relationships/team-access/:access_id", "tags": [ "workspaces" ] }, "get": { "operationId": "get-api-v2-workspaces-id-relationships-team-access-access_id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "access_id", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "GET /api/v2/workspaces/:id/relationships/team-access/:access_id", "tags": [ "workspaces" ] }, "patch": { "operationId": "patch-api-v2-workspaces-id-relationships-team-access-access_id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "access_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": { "attributes": { "access": "admin" }, "type": "team-workspaces" } }, "schema": { "$ref": "#/components/schemas/patch-api-v2-workspaces-id-relationships-team-access-access_id-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/team-workspaces-response" } } }, "description": "Success" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "PATCH /api/v2/workspaces/:id/relationships/team-access/:access_id", "tags": [ "workspaces" ] } }, "/api/v2/workspaces/{id}/run-triggers": { "get": { "operationId": "get-api-v2-workspaces-id-run-triggers", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "filter[run-trigger][type]", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/get-api-v2-workspaces-id-run-triggers-2fbe10" } } }, "description": "Success" } }, "summary": "GET /api/v2/workspaces/:id/run-triggers", "tags": [ "workspaces" ] }, "post": { "operationId": "post-api-v2-workspaces-id-run-triggers", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": { "relationships": { "sourceable": { "data": { "id": "\u003cid\u003e", "type": "workspaces" } } }, "type": "run-triggers" } }, "schema": { "$ref": "#/components/schemas/post-api-v2-workspaces-id-run-triggers-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders." }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/run-triggers-response" } } }, "description": "Success" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "POST /api/v2/workspaces/:id/run-triggers", "tags": [ "workspaces" ] } }, "/api/v2/workspaces/{id}/runs": { "get": { "operationId": "get-api-v2-workspaces-id-runs", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "description": "An older spelling of page[number], read when page[number] is absent.", "in": "query", "name": "page", "required": false, "schema": { "type": "integer" } }, { "description": "Which page to return, 1-based.", "in": "query", "name": "page[number]", "required": false, "schema": { "type": "integer" } }, { "description": "Rows per page. Clamped to the endpoint's maximum; a value below 1 falls back to its default.", "in": "query", "name": "page[size]", "required": false, "schema": { "type": "integer" } }, { "description": "An older spelling of page[size], read when page[size] is absent.", "in": "query", "name": "per_page", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runs-collection" } } }, "description": "Success" } }, "summary": "GET /api/v2/workspaces/:id/runs", "tags": [ "workspaces" ] } }, "/api/v2/workspaces/{id}/state-versions": { "get": { "operationId": "get-api-v2-workspaces-id-state-versions", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "description": "An older spelling of page[number], read when page[number] is absent.", "in": "query", "name": "page", "required": false, "schema": { "type": "integer" } }, { "description": "Which page to return, 1-based.", "in": "query", "name": "page[number]", "required": false, "schema": { "type": "integer" } }, { "description": "Rows per page. Clamped to the endpoint's maximum; a value below 1 falls back to its default.", "in": "query", "name": "page[size]", "required": false, "schema": { "type": "integer" } }, { "description": "An older spelling of page[size], read when page[size] is absent.", "in": "query", "name": "per_page", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/get-api-v2-workspaces-id-state-versions-84983e" } } }, "description": "Success" } }, "summary": "GET /api/v2/workspaces/:id/state-versions", "tags": [ "workspaces" ] }, "post": { "operationId": "post-api-v2-workspaces-id-state-versions", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": { "attributes": { "lineage": "\u003cuuid\u003e", "md5": "c860b089b9b156aa1496134c8f4782d0", "serial": 1, "state": "eyJsaW5lYWdlIjoiOGYyYzFkN2UtM2I0YS00YzVkLTllNmYtMGExYjJjM2Q0ZTVmIiwib3V0cHV0cyI6eyJlbmRwb2ludCI6eyJ0eXBlIjoic3RyaW5nIiwidmFsdWUiOiJodHRwczovL3dhcmVob3VzZS5leGFtcGxlLmNvbSJ9fSwicmVzb3VyY2VzIjpbeyJpbnN0YW5jZXMiOlt7ImF0dHJpYnV0ZXMiOnsiaWQiOiI1NTc3MDA2NzkxOTQ3Nzc5NDEwIiwidHJpZ2dlcnMiOm51bGx9LCJzY2hlbWFfdmVyc2lvbiI6MH1dLCJtb2RlIjoibWFuYWdlZCIsIm5hbWUiOiJleGFtcGxlIiwicHJvdmlkZXIiOiJwcm92aWRlcltcInJlZ2lzdHJ5Lm9wZW50b2Z1Lm9yZy9oYXNoaWNvcnAvbnVsbFwiXSIsInR5cGUiOiJudWxsX3Jlc291cmNlIn1dLCJzZXJpYWwiOjEsInRlcnJhZm9ybV92ZXJzaW9uIjoiMS4xMC42IiwidmVyc2lvbiI6NH0=" }, "type": "state-versions" } }, "schema": { "$ref": "#/components/schemas/post-api-v2-workspaces-id-state-versions-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders.", "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/state-versions-response" } } }, "description": "Success" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "POST /api/v2/workspaces/:id/state-versions", "tags": [ "workspaces" ] } }, "/api/v2/workspaces/{id}/state-versions/remove-resource": { "post": { "operationId": "post-api-v2-workspaces-id-state-versions-remove-resource", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": { "attributes": { "address": "null_resource.example" }, "type": "state-versions" } }, "schema": { "$ref": "#/components/schemas/post-api-v2-workspaces-id-state-versions-remove-resource-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders.", "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/state-versions-response" } } }, "description": "Success" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "POST /api/v2/workspaces/:id/state-versions/remove-resource", "tags": [ "workspaces" ] } }, "/api/v2/workspaces/{id}/tag-bindings": { "get": { "operationId": "get-api-v2-workspaces-id-tag-bindings", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/get-api-v2-workspaces-id-tag-bindings-268911" } } }, "description": "Success" } }, "summary": "GET /api/v2/workspaces/:id/tag-bindings", "tags": [ "workspaces" ] }, "patch": { "operationId": "patch-api-v2-workspaces-id-tag-bindings", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": [ { "attributes": { "key": "environment", "value": "production" }, "type": "tag-bindings" }, { "attributes": { "key": "cost-center", "value": "platform-1042" }, "type": "tag-bindings" } ] }, "schema": { "$ref": "#/components/schemas/patch-api-v2-workspaces-id-tag-bindings-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders." }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tag-bindings-collection" } } }, "description": "Success" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "PATCH /api/v2/workspaces/:id/tag-bindings", "tags": [ "workspaces" ] } }, "/api/v2/workspaces/{id}/tasks": { "get": { "operationId": "get-api-v2-workspaces-id-tasks", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "description": "Which page to return, 1-based.", "in": "query", "name": "page[number]", "required": false, "schema": { "type": "integer" } }, { "description": "Rows per page. Clamped to the endpoint's maximum; a value below 1 falls back to its default.", "in": "query", "name": "page[size]", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/get-api-v2-workspaces-id-tasks-68d8f2" } } }, "description": "Success" } }, "summary": "GET /api/v2/workspaces/:id/tasks", "tags": [ "workspaces" ] }, "post": { "operationId": "post-api-v2-workspaces-id-tasks", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": { "attributes": { "enforcement-level": "mandatory", "stages": [ "post_plan", "pre_apply" ] }, "relationships": { "task": { "data": { "id": "\u003cid\u003e", "type": "tasks" } } }, "type": "workspace-tasks" } }, "schema": { "$ref": "#/components/schemas/post-api-v2-workspaces-id-tasks-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders." }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workspace-tasks-response" } } }, "description": "Success" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "POST /api/v2/workspaces/:id/tasks", "tags": [ "workspaces" ] } }, "/api/v2/workspaces/{id}/tasks/{tid}": { "delete": { "description": "Takes no request body.", "operationId": "delete-api-v2-workspaces-id-tasks-tid", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "tid", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success. No content." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "DELETE /api/v2/workspaces/:id/tasks/:tid", "tags": [ "workspaces" ] }, "get": { "operationId": "get-api-v2-workspaces-id-tasks-tid", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "tid", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "GET /api/v2/workspaces/:id/tasks/:tid", "tags": [ "workspaces" ] }, "patch": { "operationId": "patch-api-v2-workspaces-id-tasks-tid", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "tid", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": { "attributes": { "enforcement-level": "mandatory", "stages": [ "pre_plan", "post_plan" ] }, "type": "workspace-tasks" } }, "schema": { "$ref": "#/components/schemas/patch-api-v2-workspaces-id-tasks-tid-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders." }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workspace-tasks-response" } } }, "description": "Success" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "PATCH /api/v2/workspaces/:id/tasks/:tid", "tags": [ "workspaces" ] } }, "/api/v2/workspaces/{id}/vars": { "get": { "operationId": "get-api-v2-workspaces-id-vars", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vars-collection" } } }, "description": "Success" } }, "summary": "GET /api/v2/workspaces/:id/vars", "tags": [ "workspaces" ] }, "post": { "operationId": "post-api-v2-workspaces-id-vars", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": { "attributes": { "category": "env", "description": "Recorded by the golden write harness", "hcl": false, "key": "DATABASE_PASSWORD", "sensitive": true, "value": "\u003csecret\u003e" }, "type": "vars" } }, "schema": { "$ref": "#/components/schemas/post-api-v2-workspaces-id-vars-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders." }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vars-response" } } }, "description": "Success" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "POST /api/v2/workspaces/:id/vars", "tags": [ "workspaces" ] } }, "/api/v2/workspaces/{id}/vars/{variable_id}": { "delete": { "description": "Takes no request body.", "operationId": "delete-api-v2-workspaces-id-vars-variable_id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "variable_id", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success. No content." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "DELETE /api/v2/workspaces/:id/vars/:variable_id", "tags": [ "workspaces" ] }, "get": { "operationId": "get-api-v2-workspaces-id-vars-variable_id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "variable_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vars-response" } } }, "description": "Success" } }, "summary": "GET /api/v2/workspaces/:id/vars/:variable_id", "tags": [ "workspaces" ] }, "patch": { "operationId": "patch-api-v2-workspaces-id-vars-variable_id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "variable_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": { "attributes": { "category": "terraform", "description": "Updated by the golden write harness", "hcl": false, "key": "instance_type", "sensitive": false, "value": "t3.large" }, "id": "\u003cid\u003e", "type": "vars" } }, "schema": { "$ref": "#/components/schemas/patch-api-v2-workspaces-id-vars-variable_id-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders." }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vars-response" } } }, "description": "Success" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "PATCH /api/v2/workspaces/:id/vars/:variable_id", "tags": [ "workspaces" ] } }, "/api/v2/zitadel/actions/complement-token": { "post": { "operationId": "post-api-v2-zitadel-actions-complement-token", "requestBody": { "content": { "application/json": { "example": { "function": "function/preaccesstoken", "org": { "id": "312909075212042520", "name": "acme-platform" }, "user": { "id": "312912345678901234", "preferred_login_name": "avery.diaz@example.com" }, "user_metadata": [ { "key": "sso_groups", "value": "WyJwbGF0Zm9ybS1lbmdpbmVlcmluZyIsInNlY3VyaXR5Il0=" } ] }, "schema": { "$ref": "#/components/schemas/post-api-v2-zitadel-actions-complement-token-request" } } }, "description": "Described from one accepted request rather than from a type: a member this example does not send may still be accepted. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders." }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post-api-v2-zitadel-actions-complement-token-55ebdc" } } }, "description": "Success" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-401" } } }, "description": "Unauthorized" } }, "summary": "POST /api/v2/zitadel/actions/complement-token", "tags": [ "zitadel" ] } }, "/api/v2/zitadel/actions/idp-sync": { "post": { "operationId": "post-api-v2-zitadel-actions-idp-sync", "requestBody": { "content": { "application/json": { "example": { "fullMethod": "/zitadel.user.v2.UserService/RetrieveIdentityProviderIntent", "instanceID": "312909075211976984", "orgID": "312909075212042520", "request": { "idpIntentId": "312911568405479384" }, "response": { "addHumanUser": { "email": { "email": "avery.diaz@example.com", "isVerified": true }, "profile": { "familyName": "Diaz", "givenName": "Avery" } }, "details": { "resourceOwner": "312909075211976984", "sequence": "599" }, "idpInformation": { "idpId": "312910411843633176", "rawInformation": { "email": "avery.diaz@example.com", "groups": [ "platform-engineering", "security" ], "sub": "00u1a2b3c4d5e6f7g8h9" } } } }, "schema": { "$ref": "#/components/schemas/post-api-v2-zitadel-actions-idp-sync-request" } } }, "description": "Described from one accepted request rather than from a type: a member this example does not send may still be accepted. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders." }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post-api-v2-zitadel-actions-idp-sync-2976f5" } } }, "description": "Success" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-401" } } }, "description": "Unauthorized" } }, "summary": "POST /api/v2/zitadel/actions/idp-sync", "tags": [ "zitadel" ] } }, "/auth/health/auth-proxy": { "get": { "operationId": "get-auth-health-auth-proxy", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/get-auth-health-auth-proxy-3b225d" } } }, "description": "Success" } }, "summary": "GET /auth/health/auth-proxy", "tags": [ "auth" ] } }, "/auth/idp/complete/{intentId}": { "post": { "description": "Not recorded: a successful call needs a system outside the machine. The intent in the path and the `idpIntentToken` in the body are handed to the browser by the external identity provider's callback, after a person has signed in there. Success needs that sign-in to have happened. No request was sent, so this operation's request body and success response are not described.", "operationId": "post-auth-idp-complete-intentId", "parameters": [ { "in": "path", "name": "intentId", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post-auth-idp-complete-intentId-e5e263" } } }, "description": "Unauthorized" } }, "summary": "POST /auth/idp/complete/:intentId", "tags": [ "auth" ] } }, "/auth/idp/providers": { "get": { "operationId": "get-auth-idp-providers", "responses": { "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/get-auth-idp-providers-adcc06" } } }, "description": "Unauthorized" } }, "summary": "GET /auth/idp/providers", "tags": [ "auth" ] } }, "/auth/idp/start": { "post": { "description": "Not recorded: a successful call needs an instance-wide identity-provider setting changed. The body names an external identity provider (`idpId`), and the answer is the address at that provider the browser is sent to. Success needs an administrator to have set such a provider up at the identity provider, where it is offered to everyone who signs in to the instance. No request was sent, so this operation's request body and success response are not described.", "operationId": "post-auth-idp-start", "responses": { "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-400" } } }, "description": "Bad Request" } }, "summary": "POST /auth/idp/start", "tags": [ "auth" ] } }, "/auth/oidc/auth-requests/{id}": { "get": { "operationId": "get-auth-oidc-auth-requests-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/get-auth-oidc-auth-requests-id-282c21" } } }, "description": "Unauthorized" } }, "summary": "GET /auth/oidc/auth-requests/:id", "tags": [ "auth" ] } }, "/auth/oidc/authorize": { "get": { "description": "The query string is passed to the identity provider as it arrives, so no query parameters are declared here: the ones that have an effect are the identity provider's.", "operationId": "get-auth-oidc-authorize", "responses": { "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-400" } } }, "description": "Bad Request" } }, "summary": "GET /auth/oidc/authorize", "tags": [ "auth" ] } }, "/auth/oidc/discovery": { "get": { "operationId": "get-auth-oidc-discovery", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/get-auth-oidc-discovery-19247f" } } }, "description": "Success" } }, "summary": "GET /auth/oidc/discovery", "tags": [ "auth" ] } }, "/auth/oidc/end-session": { "get": { "description": "The query string is passed to the identity provider as it arrives, so no query parameters are declared here: the ones that have an effect are the identity provider's.", "operationId": "get-auth-oidc-end-session", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/get-auth-oidc-end-session-ee5f9e" } } }, "description": "Success" } }, "summary": "GET /auth/oidc/end-session", "tags": [ "auth" ] }, "post": { "description": "The query string is passed to the identity provider as it arrives, so no query parameters are declared here: the ones that have an effect are the identity provider's.", "operationId": "post-auth-oidc-end-session", "requestBody": { "content": { "application/x-www-form-urlencoded": { "example": { "client_id": "\u003cbff-client-id\u003e", "post_logout_redirect_uri": "http://localhost:5173", "state": "golden-write" }, "schema": { "$ref": "#/components/schemas/post-auth-oidc-end-session-request" } } }, "description": "Described from one accepted request rather than from a type: a member this example does not send may still be accepted. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders." }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post-auth-oidc-end-session-e13077" } } }, "description": "Success" } }, "summary": "POST /auth/oidc/end-session", "tags": [ "auth" ] } }, "/auth/oidc/finalize": { "post": { "operationId": "post-auth-oidc-finalize", "requestBody": { "content": { "application/json": { "example": { "authRequestId": "\u003cauth-request-id\u003e", "sessionId": "\u003csession-id\u003e", "sessionToken": "\u003csecret\u003e" }, "schema": { "$ref": "#/components/schemas/post-auth-oidc-finalize-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders." }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post-auth-oidc-finalize-d63267" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-400" } } }, "description": "Bad Request" } }, "summary": "POST /auth/oidc/finalize", "tags": [ "auth" ] } }, "/auth/oidc/keys": { "get": { "operationId": "get-auth-oidc-keys", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/get-auth-oidc-keys-1193ff" } } }, "description": "Success" } }, "summary": "GET /auth/oidc/keys", "tags": [ "auth" ] } }, "/auth/orgs/by-domain": { "get": { "operationId": "get-auth-orgs-by-domain", "parameters": [ { "in": "query", "name": "domain", "required": false, "schema": { "type": "string" } } ], "responses": { "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-400" } } }, "description": "Bad Request" } }, "summary": "GET /auth/orgs/by-domain", "tags": [ "auth" ] } }, "/auth/session": { "get": { "operationId": "get-auth-session", "responses": { "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-401" } } }, "description": "Unauthorized" } }, "summary": "GET /auth/session", "tags": [ "auth" ] }, "post": { "operationId": "post-auth-session", "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": { "attributes": { "code": "\u003csecret\u003e", "state": "\u003csecret\u003e" }, "type": "sessions" } }, "schema": { "$ref": "#/components/schemas/post-auth-session-request" } } }, "description": "Described from the type the server decodes this body into: every member it accepts is listed, and a member is marked required where that type requires it. A rule the server enforces in code is not shown. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders.", "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sessions-response" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-400" } } }, "description": "Bad Request" } }, "summary": "POST /auth/session", "tags": [ "auth" ] } }, "/auth/session/end": { "post": { "description": "Takes no request body.", "operationId": "post-auth-session-end", "responses": { "303": { "description": "See Other. No content." } }, "summary": "POST /auth/session/end", "tags": [ "auth" ] } }, "/auth/session/touch": { "post": { "description": "Takes no request body.", "operationId": "post-auth-session-touch", "responses": { "204": { "description": "Success. No content." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-401" } } }, "description": "Unauthorized" } }, "summary": "POST /auth/session/touch", "tags": [ "auth" ] } }, "/auth/sessions": { "post": { "operationId": "post-auth-sessions", "requestBody": { "content": { "application/json": { "example": { "checks": { "password": { "password": "\u003csecret\u003e" }, "user": { "loginName": "\u003clogin-name\u003e" } } }, "schema": { "$ref": "#/components/schemas/post-auth-sessions-request" } } }, "description": "Described from one accepted request rather than from a type: a member this example does not send may still be accepted. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders." }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post-auth-sessions-response" } } }, "description": "Success" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post-auth-sessions-0a2e24" } } }, "description": "Unauthorized" } }, "summary": "POST /auth/sessions", "tags": [ "auth" ] } }, "/auth/sessions/search": { "post": { "operationId": "post-auth-sessions-search", "requestBody": { "content": { "application/json": { "example": { "query": { "asc": true, "limit": 20 }, "sortingColumn": "SESSION_FIELD_NAME_CREATION_DATE" }, "schema": { "$ref": "#/components/schemas/post-auth-sessions-search-request" } } }, "description": "Described from one accepted request rather than from a type: a member this example does not send may still be accepted. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders." }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post-auth-sessions-search-0f5a16" } } }, "description": "Success" } }, "summary": "POST /auth/sessions/search", "tags": [ "auth" ] } }, "/auth/sessions/{id}": { "delete": { "description": "Takes no request body.", "operationId": "delete-auth-sessions-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/delete-auth-sessions-id-8440a0" } } }, "description": "Success" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-403" } } }, "description": "Forbidden" } }, "summary": "DELETE /auth/sessions/:id", "tags": [ "auth" ] }, "get": { "operationId": "get-auth-sessions-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-403" } } }, "description": "Forbidden" } }, "summary": "GET /auth/sessions/:id", "tags": [ "auth" ] }, "patch": { "operationId": "patch-auth-sessions-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "checks": { "password": { "password": "\u003csecret\u003e" } } }, "schema": { "$ref": "#/components/schemas/patch-auth-sessions-id-request" } } }, "description": "Described from one accepted request rather than from a type: a member this example does not send may still be accepted. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders." }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/patch-auth-sessions-id-a0576c" } } }, "description": "Success" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-403" } } }, "description": "Forbidden" } }, "summary": "PATCH /auth/sessions/:id", "tags": [ "auth" ] } }, "/auth/settings/branding": { "get": { "operationId": "get-auth-settings-branding", "parameters": [ { "in": "query", "name": "ctx.orgId", "required": false, "schema": { "type": "string" } } ], "responses": { "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/get-auth-settings-branding-58406b" } } }, "description": "Unauthorized" } }, "summary": "GET /auth/settings/branding", "tags": [ "auth" ] } }, "/auth/settings/legal": { "get": { "operationId": "get-auth-settings-legal", "parameters": [ { "in": "query", "name": "ctx.orgId", "required": false, "schema": { "type": "string" } } ], "responses": { "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/get-auth-settings-legal-fd2ce8" } } }, "description": "Unauthorized" } }, "summary": "GET /auth/settings/legal", "tags": [ "auth" ] } }, "/auth/settings/lockout": { "get": { "operationId": "get-auth-settings-lockout", "parameters": [ { "in": "query", "name": "ctx.orgId", "required": false, "schema": { "type": "string" } } ], "responses": { "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/get-auth-settings-lockout-8df1d0" } } }, "description": "Unauthorized" } }, "summary": "GET /auth/settings/lockout", "tags": [ "auth" ] } }, "/auth/settings/login": { "get": { "operationId": "get-auth-settings-login", "parameters": [ { "in": "query", "name": "ctx.orgId", "required": false, "schema": { "type": "string" } } ], "responses": { "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/get-auth-settings-login-6e1460" } } }, "description": "Unauthorized" } }, "summary": "GET /auth/settings/login", "tags": [ "auth" ] } }, "/auth/settings/password-complexity": { "get": { "operationId": "get-auth-settings-password-complexity", "parameters": [ { "in": "query", "name": "ctx.orgId", "required": false, "schema": { "type": "string" } } ], "responses": { "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/get-auth-settings-password-complexity-e836cc" } } }, "description": "Unauthorized" } }, "summary": "GET /auth/settings/password-complexity", "tags": [ "auth" ] } }, "/auth/settings/password-expiry": { "get": { "operationId": "get-auth-settings-password-expiry", "parameters": [ { "in": "query", "name": "ctx.orgId", "required": false, "schema": { "type": "string" } } ], "responses": { "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/get-auth-settings-password-expiry-c5ddde" } } }, "description": "Unauthorized" } }, "summary": "GET /auth/settings/password-expiry", "tags": [ "auth" ] } }, "/auth/settings/security": { "get": { "operationId": "get-auth-settings-security", "parameters": [ { "in": "query", "name": "ctx.orgId", "required": false, "schema": { "type": "string" } } ], "responses": { "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/get-auth-settings-security-a814c5" } } }, "description": "Unauthorized" } }, "summary": "GET /auth/settings/security", "tags": [ "auth" ] } }, "/auth/users": { "post": { "description": "Not recorded: a successful call needs an instance-wide identity-provider setting changed. Self sign-up is accepted only while the login policy of the identity provider allows registration, a setting shared by everyone who signs in to the instance. Success needs that setting to allow it, and creates an account that only an administrator of the identity provider can remove. No request was sent, so this operation's request body and success response are not described.", "operationId": "post-auth-users", "responses": { "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-403" } } }, "description": "Forbidden" } }, "summary": "POST /auth/users", "tags": [ "auth" ] } }, "/auth/users/{id}": { "get": { "operationId": "get-auth-users-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-403" } } }, "description": "Forbidden" } }, "summary": "GET /auth/users/:id", "tags": [ "auth" ] } }, "/auth/users/{id}/authentication_methods": { "get": { "operationId": "get-auth-users-id-authentication_methods", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-403" } } }, "description": "Forbidden" } }, "summary": "GET /auth/users/:id/authentication_methods", "tags": [ "auth" ] } }, "/auth/users/{id}/email": { "post": { "operationId": "post-auth-users-id-email", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "verificationCode": "\u003csecret\u003e" }, "schema": { "$ref": "#/components/schemas/post-auth-users-id-email-request" } } }, "description": "Described from one accepted request rather than from a type: a member this example does not send may still be accepted. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders." }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post-auth-users-id-email-response" } } }, "description": "Success" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post-auth-users-id-email-23776e" } } }, "description": "Unauthorized" } }, "summary": "POST /auth/users/:id/email", "tags": [ "auth" ] } }, "/auth/users/{id}/invite-code/verify": { "post": { "operationId": "post-auth-users-id-invite-code-verify", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "verificationCode": "\u003csecret\u003e" }, "schema": { "$ref": "#/components/schemas/post-auth-users-id-invite-code-verify-request" } } }, "description": "Described from one accepted request rather than from a type: a member this example does not send may still be accepted. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders." }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post-auth-users-id-invite-code-verify-response" } } }, "description": "Success" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post-auth-users-id-invite-code-verify-6c612e" } } }, "description": "Unauthorized" } }, "summary": "POST /auth/users/:id/invite-code/verify", "tags": [ "auth" ] } }, "/auth/users/{id}/otp-email": { "post": { "description": "Takes no request body.", "operationId": "post-auth-users-id-otp-email", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post-auth-users-id-otp-email-231926" } } }, "description": "Success" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-403" } } }, "description": "Forbidden" } }, "summary": "POST /auth/users/:id/otp-email", "tags": [ "auth" ] } }, "/auth/users/{id}/otp-sms": { "post": { "description": "Takes no request body.", "operationId": "post-auth-users-id-otp-sms", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post-auth-users-id-otp-sms-fc5cd4" } } }, "description": "Success" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-403" } } }, "description": "Forbidden" } }, "summary": "POST /auth/users/:id/otp-sms", "tags": [ "auth" ] } }, "/auth/users/{id}/passkeys": { "post": { "operationId": "post-auth-users-id-passkeys", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "authenticator": "PASSKEY_AUTHENTICATOR_UNSPECIFIED", "domain": "localhost" }, "schema": { "$ref": "#/components/schemas/post-auth-users-id-passkeys-request" } } }, "description": "Described from one accepted request rather than from a type: a member this example does not send may still be accepted. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders." }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post-auth-users-id-passkeys-d33f79" } } }, "description": "Success" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-403" } } }, "description": "Forbidden" } }, "summary": "POST /auth/users/:id/passkeys", "tags": [ "auth" ] } }, "/auth/users/{id}/passkeys/{pkId}": { "post": { "description": "Not recorded: a successful call needs a physical authenticator. The body is the credential an authenticator creates for the challenge that `POST /auth/users/{id}/passkeys` returned, signed by the authenticator. Success needs a passkey to produce it. No request was sent, so this operation's request body and success response are not described.", "operationId": "post-auth-users-id-passkeys-pkId", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "pkId", "required": true, "schema": { "type": "string" } } ], "responses": { "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-403" } } }, "description": "Forbidden" } }, "summary": "POST /auth/users/:id/passkeys/:pkId", "tags": [ "auth" ] } }, "/auth/users/{id}/password": { "post": { "operationId": "post-auth-users-id-password", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "currentPassword": "\u003csecret\u003e", "newPassword": { "changeRequired": false, "password": "\u003csecret\u003e" } }, "schema": { "$ref": "#/components/schemas/post-auth-users-id-password-request" } } }, "description": "Described from one accepted request rather than from a type: a member this example does not send may still be accepted. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders." }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post-auth-users-id-password-response" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post-auth-users-id-password-2c5511" } } }, "description": "Bad Request" } }, "summary": "POST /auth/users/:id/password", "tags": [ "auth" ] } }, "/auth/users/{id}/password-reset": { "post": { "description": "Takes no request body.", "operationId": "post-auth-users-id-password-reset", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post-auth-users-id-password-reset-response" } } }, "description": "Success" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post-auth-users-id-password-reset-7b52f6" } } }, "description": "Unauthorized" } }, "summary": "POST /auth/users/:id/password-reset", "tags": [ "auth" ] } }, "/auth/users/{id}/totp": { "post": { "description": "Takes no request body.", "operationId": "post-auth-users-id-totp", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post-auth-users-id-totp-52a611" } } }, "description": "Success" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-403" } } }, "description": "Forbidden" } }, "summary": "POST /auth/users/:id/totp", "tags": [ "auth" ] } }, "/auth/users/{id}/totp/verify": { "post": { "operationId": "post-auth-users-id-totp-verify", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "code": "\u003csecret\u003e" }, "schema": { "$ref": "#/components/schemas/post-auth-users-id-totp-verify-request" } } }, "description": "Described from one accepted request rather than from a type: a member this example does not send may still be accepted. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders." }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post-auth-users-id-totp-verify-b94c95" } } }, "description": "Success" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-403" } } }, "description": "Forbidden" } }, "summary": "POST /auth/users/:id/totp/verify", "tags": [ "auth" ] } }, "/auth/users/{id}/u2f": { "post": { "operationId": "post-auth-users-id-u2f", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "domain": "localhost" }, "schema": { "$ref": "#/components/schemas/post-auth-users-id-u2f-request" } } }, "description": "Described from one accepted request rather than from a type: a member this example does not send may still be accepted. The example is a request the server accepted, with identifiers, timestamps and secrets replaced by placeholders." }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post-auth-users-id-u2f-4e007c" } } }, "description": "Success" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-403" } } }, "description": "Forbidden" } }, "summary": "POST /auth/users/:id/u2f", "tags": [ "auth" ] } }, "/auth/users/{id}/u2f/{u2fId}": { "post": { "description": "Not recorded: a successful call needs a physical authenticator. The body is the credential a security key creates for the challenge that `POST /auth/users/{id}/u2f` returned, signed by the key. Success needs a security key to produce it. No request was sent, so this operation's request body and success response are not described.", "operationId": "post-auth-users-id-u2f-u2fId", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "u2fId", "required": true, "schema": { "type": "string" } } ], "responses": { "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-403" } } }, "description": "Forbidden" } }, "summary": "POST /auth/users/:id/u2f/:u2fId", "tags": [ "auth" ] } }, "/health": { "get": { "operationId": "get-health", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/get-health-428884" } } }, "description": "Success" } }, "summary": "GET /health", "tags": [ "health" ] }, "head": { "operationId": "head-health", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/head-health-3ad84b" } } }, "description": "Success" } }, "summary": "HEAD /health", "tags": [ "health" ] } }, "/openapi/stable.json": { "get": { "description": "Not recorded by the golden harness: serves the committed OpenAPI document, which has its own drift check", "operationId": "get-openapi-stable-json", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "This document." }, "304": { "description": "Not modified since the If-Modified-Since date." } }, "summary": "GET /openapi/stable.json", "tags": [ "openapi" ] } }, "/v1/modules": { "get": { "operationId": "get-v1-modules", "parameters": [ { "description": "The most to return in one response.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" } }, { "description": "How far in to start, counted from 0.", "in": "query", "name": "offset", "required": false, "schema": { "type": "integer" } }, { "in": "query", "name": "provider", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "verified", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/get-v1-modules-1b59d5" } } }, "description": "Success" } }, "summary": "GET /v1/modules", "tags": [ "v1" ] } }, "/v1/modules/search": { "get": { "operationId": "get-v1-modules-search", "parameters": [ { "description": "The most to return in one response.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" } }, { "in": "query", "name": "namespace", "required": false, "schema": { "type": "string" } }, { "description": "How far in to start, counted from 0.", "in": "query", "name": "offset", "required": false, "schema": { "type": "integer" } }, { "in": "query", "name": "provider", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "q", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "verified", "required": false, "schema": { "type": "string" } } ], "responses": { "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-400" } } }, "description": "Bad Request" } }, "summary": "GET /v1/modules/search", "tags": [ "v1" ] } }, "/v1/modules/{namespace}": { "get": { "operationId": "get-v1-modules-namespace", "parameters": [ { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "The most to return in one response.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" } }, { "description": "How far in to start, counted from 0.", "in": "query", "name": "offset", "required": false, "schema": { "type": "integer" } }, { "in": "query", "name": "provider", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "verified", "required": false, "schema": { "type": "string" } } ], "responses": { "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "GET /v1/modules/:namespace", "tags": [ "v1" ] } }, "/v1/modules/{namespace}/{name}/{provider}": { "get": { "operationId": "get-v1-modules-namespace-name-provider", "parameters": [ { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "provider", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "GET /v1/modules/:namespace/:name/:provider", "tags": [ "v1" ] } }, "/v1/modules/{namespace}/{name}/{provider}/download": { "get": { "operationId": "get-v1-modules-namespace-name-provider-download", "parameters": [ { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "provider", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "GET /v1/modules/:namespace/:name/:provider/download", "tags": [ "v1" ] } }, "/v1/modules/{namespace}/{name}/{provider}/versions": { "get": { "operationId": "get-v1-modules-namespace-name-provider-versions", "parameters": [ { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "provider", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "GET /v1/modules/:namespace/:name/:provider/versions", "tags": [ "v1" ] } }, "/v1/modules/{namespace}/{name}/{provider}/{version}": { "get": { "operationId": "get-v1-modules-namespace-name-provider-version", "parameters": [ { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "provider", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "version", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "GET /v1/modules/:namespace/:name/:provider/:version", "tags": [ "v1" ] } }, "/v1/modules/{namespace}/{name}/{provider}/{version}/download": { "get": { "operationId": "get-v1-modules-namespace-name-provider-version-download", "parameters": [ { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "provider", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "version", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "GET /v1/modules/:namespace/:name/:provider/:version/download", "tags": [ "v1" ] } }, "/v1/providers": { "get": { "operationId": "get-v1-providers", "parameters": [ { "description": "The most to return in one response.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" } }, { "description": "How far in to start, counted from 0.", "in": "query", "name": "offset", "required": false, "schema": { "type": "integer" } }, { "in": "query", "name": "verified", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/get-v1-providers-c0509a" } } }, "description": "Success" } }, "summary": "GET /v1/providers", "tags": [ "v1" ] } }, "/v1/providers/search": { "get": { "operationId": "get-v1-providers-search", "parameters": [ { "description": "The most to return in one response.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" } }, { "in": "query", "name": "namespace", "required": false, "schema": { "type": "string" } }, { "description": "How far in to start, counted from 0.", "in": "query", "name": "offset", "required": false, "schema": { "type": "integer" } }, { "in": "query", "name": "q", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "verified", "required": false, "schema": { "type": "string" } } ], "responses": { "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-400" } } }, "description": "Bad Request" } }, "summary": "GET /v1/providers/search", "tags": [ "v1" ] } }, "/v1/providers/{namespace}": { "get": { "operationId": "get-v1-providers-namespace", "parameters": [ { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "The most to return in one response.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" } }, { "description": "How far in to start, counted from 0.", "in": "query", "name": "offset", "required": false, "schema": { "type": "integer" } }, { "in": "query", "name": "verified", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/get-v1-providers-namespace-56a3d5" } } }, "description": "Success" } }, "summary": "GET /v1/providers/:namespace", "tags": [ "v1" ] } }, "/v1/providers/{namespace}/{name}": { "get": { "operationId": "get-v1-providers-namespace-name", "parameters": [ { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/get-v1-providers-namespace-name-821eb0" } } }, "description": "Success" } }, "summary": "GET /v1/providers/:namespace/:name", "tags": [ "v1" ] } }, "/v1/providers/{namespace}/{name}/download/{os}/{arch}": { "get": { "operationId": "get-v1-providers-namespace-name-download-os-arch", "parameters": [ { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "os", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "arch", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "GET /v1/providers/:namespace/:name/download/:os/:arch", "tags": [ "v1" ] } }, "/v1/providers/{namespace}/{name}/versions": { "get": { "operationId": "get-v1-providers-namespace-name-versions", "parameters": [ { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/get-v1-providers-namespace-name-versions-81e7db" } } }, "description": "Success" } }, "summary": "GET /v1/providers/:namespace/:name/versions", "tags": [ "v1" ] } }, "/v1/providers/{namespace}/{name}/{version}": { "get": { "operationId": "get-v1-providers-namespace-name-version", "parameters": [ { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "version", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/get-v1-providers-namespace-name-version-0743f3" } } }, "description": "Success" } }, "summary": "GET /v1/providers/:namespace/:name/:version", "tags": [ "v1" ] } }, "/v1/providers/{namespace}/{name}/{version}/binary/{os}/{arch}": { "get": { "operationId": "get-v1-providers-namespace-name-version-binary-os-arch", "parameters": [ { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "version", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "os", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "arch", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "token", "required": false, "schema": { "type": "string" } } ], "responses": { "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "GET /v1/providers/:namespace/:name/:version/binary/:os/:arch", "tags": [ "v1" ] } }, "/v1/providers/{namespace}/{name}/{version}/download/{os}/{arch}": { "get": { "operationId": "get-v1-providers-namespace-name-version-download-os-arch", "parameters": [ { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "version", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "os", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "arch", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "GET /v1/providers/:namespace/:name/:version/download/:os/:arch", "tags": [ "v1" ] } }, "/v1/providers/{namespace}/{name}/{version}/sha256sums": { "get": { "operationId": "get-v1-providers-namespace-name-version-sha256sums", "parameters": [ { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "version", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "token", "required": false, "schema": { "type": "string" } } ], "responses": { "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "GET /v1/providers/:namespace/:name/:version/sha256sums", "tags": [ "v1" ] } }, "/v1/providers/{namespace}/{name}/{version}/sha256sums.sig": { "get": { "operationId": "get-v1-providers-namespace-name-version-sha256sums-sig", "parameters": [ { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "version", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "token", "required": false, "schema": { "type": "string" } } ], "responses": { "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "GET /v1/providers/:namespace/:name/:version/sha256sums.sig", "tags": [ "v1" ] } }, "/v2/modules/{namespace}/{name}/{provider}/downloads/summary": { "get": { "operationId": "get-v2-modules-namespace-name-provider-downloads-summary", "parameters": [ { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "provider", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "GET /v2/modules/:namespace/:name/:provider/downloads/summary", "tags": [ "v2" ] } }, "/v2/providers/{namespace}/{name}/downloads/summary": { "get": { "operationId": "get-v2-providers-namespace-name-downloads-summary", "parameters": [ { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-404" } } }, "description": "Not Found" } }, "summary": "GET /v2/providers/:namespace/:name/downloads/summary", "tags": [ "v2" ] } } } }