openapi: 3.1.0 info: version: 1.1.4 title: github-repo-actions-api description: |- Use the REST API to create, manage and control the workflow of public and private GitHub repositories. license: name: MIT url: https://spdx.org/licenses/MIT termsOfService: https://docs.github.com/articles/github-terms-of-service contact: name: Support url: https://support.github.com/contact servers: - url: '{protocol}://{hostname}' variables: hostname: description: Self-hosted Enterprise Server hostname default: api.github.com protocol: description: Self-hosted Enterprise Server protocol default: https externalDocs: description: GitHub Enterprise Developer Docs url: https://docs.github.com/enterprise-server@3.9/rest/ tags: - name: Access - name: Actions - name: Add - name: All - name: Allowed - name: Applications - name: Artifacts - name: Attempts - name: Cache - name: Caches - name: Cancel - name: Claims - name: Create - name: Custom - name: Customizations - name: Delete - name: Deployments - name: Disables - name: Dispatch - name: Download - name: Enables - name: Event - name: Failed - name: Get - name: History - name: Identifiers - name: Jobs - name: Keys - name: Label - name: Labels - name: Levels - name: Lists - name: Logs - name: Openid Connect - name: Organizations - name: Outside - name: Pending - name: Permissions - name: Policies - name: Public - name: Re-Run - name: Registration - name: Remove - name: Repositories description: Source control repositories. - name: Reviews - name: Runners - name: Runs - name: Secrets - name: Self-Hosted - name: Sets - name: Subject - name: Templates - name: Tokens - name: Update - name: Usage - name: Variables - name: Workflows paths: /repos/{owner}/{repo}/actions/artifacts: get: summary: GitHub List Artifacts for Repository description: |- Lists all artifacts for a repository. Anyone with read access to the repository can use this endpoint. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. tags: - Artifacts - Lists - Repositories operationId: listArtifactsForRepository externalDocs: description: API method documentation url: |- https://docs.github.com/enterprise-server@3.9/rest/actions/artifacts#list-artifacts-for-a-repository parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/per-page' - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/artifact-name' - in: header name: Authorization schema: type: string example: example_value - in: header name: X-GitHub-Api-Version schema: type: string default: '2022-11-28' example: example_value - in: header name: Accept schema: type: string default: application/vnd.github+json example: example_value responses: '200': description: Response content: application/json: schema: type: object required: - total_count - artifacts properties: total_count: type: integer artifacts: type: array items: $ref: '#/components/schemas/artifact' examples: default: $ref: '#/components/examples/artifact-paginated' headers: Link: $ref: '#/components/headers/link' x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: artifacts x-api-evangelist-certified: '2025-07-18' x-api-naftiko-published: '2025-07-25' security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /repos/{owner}/{repo}/actions/artifacts/{artifact_id}: get: summary: GitHub Get an Artifact description: |- Gets a specific artifact for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - Artifacts - Get operationId: getAnArtifact externalDocs: description: API method documentation url: |- https://docs.github.com/enterprise-server@3.9/rest/actions/artifacts#get-an-artifact parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/artifact-id' - in: header name: Authorization schema: type: string example: example_value - in: header name: X-GitHub-Api-Version schema: type: string default: '2022-11-28' example: example_value - in: header name: Accept schema: type: string default: application/vnd.github+json example: example_value responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/artifact' examples: default: $ref: '#/components/examples/artifact' x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: artifacts security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: summary: GitHub Delete an Artifact description: |- Deletes an artifact for a workflow run. OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - Artifacts - Delete operationId: deleteAnArtifact externalDocs: description: API method documentation url: |- https://docs.github.com/enterprise-server@3.9/rest/actions/artifacts#delete-an-artifact parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/artifact-id' - in: header name: Authorization schema: type: string example: example_value - in: header name: X-GitHub-Api-Version schema: type: string default: '2022-11-28' example: example_value - in: header name: Accept schema: type: string default: application/vnd.github+json example: example_value responses: '204': description: Response x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: artifacts security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /repos/{owner}/{repo}/actions/artifacts/{artifact_id}/{archive_format}: get: summary: GitHub Download an Artifact description: |- Gets a redirect URL to download an archive for a repository. This URL expires after 1 minute. Look for `Location:` in the response header to find the URL for the download. The `:archive_format` must be `zip`. OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - Artifacts - Download operationId: downloadAnArtifact externalDocs: description: API method documentation url: |- https://docs.github.com/enterprise-server@3.9/rest/actions/artifacts#download-an-artifact parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/artifact-id' - name: archive_format in: path required: true schema: type: string example: example_value - in: header name: Authorization schema: type: string example: example_value - in: header name: X-GitHub-Api-Version schema: type: string default: '2022-11-28' example: example_value - in: header name: Accept schema: type: string default: application/vnd.github+json example: example_value responses: '302': description: Response headers: Location: $ref: '#/components/headers/location' '410': $ref: '#/components/responses/gone' x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: artifacts security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /repos/{owner}/{repo}/actions/cache/usage: get: summary: GitHub Get Github Actions Cache Usage for Repository description: |- Gets GitHub Actions cache usage for a repository. The data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated. Anyone with read access to the repository can use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - Actions - Cache - Get - Repositories - Usage operationId: getGithubActionsCacheUsageForRepository externalDocs: description: API method documentation url: |- https://docs.github.com/enterprise-server@3.9/rest/actions/cache#get-github-actions-cache-usage-for-a-repository parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - in: header name: Authorization schema: type: string example: example_value - in: header name: X-GitHub-Api-Version schema: type: string default: '2022-11-28' example: example_value - in: header name: Accept schema: type: string default: application/vnd.github+json example: example_value responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/actions-cache-usage-by-repository' examples: default: $ref: '#/components/examples/actions-cache-usage' x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: cache x-api-evangelist-certified: '2025-07-16' x-api-naftiko-published: '2025-07-25' security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /repos/{owner}/{repo}/actions/cache/usage-policy: get: summary: GitHub Get Github Actions Cache Usage Policy for Repository description: |- Gets GitHub Actions cache usage policy for a repository. OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - Actions - Cache - Get - Policies - Repositories - Usage operationId: getGithubActionsCacheUsagePolicyForRepository externalDocs: description: API method documentation url: |- https://docs.github.com/enterprise-server@3.9/rest/actions/cache#get-github-actions-cache-usage-policy-for-a-repository parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - in: header name: Authorization schema: type: string example: example_value - in: header name: X-GitHub-Api-Version schema: type: string default: '2022-11-28' example: example_value - in: header name: Accept schema: type: string default: application/vnd.github+json example: example_value responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/actions-cache-usage-policy-for-repository' examples: default: $ref: '#/components/examples/actions-cache-usage-policy' x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: cache security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK patch: summary: GitHub Set Github Actions Cache Usage Policy for Repository description: |- Sets GitHub Actions cache usage policy for a repository. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - Actions - Cache - Policies - Repositories - Sets - Usage operationId: setGithubActionsCacheUsagePolicyForRepository externalDocs: description: API method documentation url: |- https://docs.github.com/enterprise-server@3.9/rest/actions/cache#set-github-actions-cache-usage-policy-for-a-repository parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - in: header name: Authorization schema: type: string example: example_value - in: header name: X-GitHub-Api-Version schema: type: string default: '2022-11-28' example: example_value - in: header name: Accept schema: type: string default: application/vnd.github+json example: example_value responses: '204': description: Response requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/actions-cache-usage-policy-for-repository' examples: selected_actions: $ref: '#/components/examples/actions-cache-usage-policy' x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: cache security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /repos/{owner}/{repo}/actions/caches: get: summary: GitHub List Github Actions Caches for Repository description: |- Lists the GitHub Actions caches for a repository. OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - Actions - Caches - Lists - Repositories operationId: listGithubActionsCachesForRepository externalDocs: description: API method documentation url: |- https://docs.github.com/enterprise-server@3.9/rest/actions/cache#list-github-actions-caches-for-a-repository parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/per-page' - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/actions-cache-git-ref-full' - $ref: '#/components/parameters/actions-cache-key' - $ref: '#/components/parameters/actions-cache-list-sort' - $ref: '#/components/parameters/direction' - in: header name: Authorization schema: type: string example: example_value - in: header name: X-GitHub-Api-Version schema: type: string default: '2022-11-28' example: example_value - in: header name: Accept schema: type: string default: application/vnd.github+json example: example_value responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/actions-cache-list' examples: default: $ref: '#/components/examples/actions-cache-list' headers: Link: $ref: '#/components/headers/link' x-github: githubCloudOnly: false enabledForGitHubApps: true previews: [] category: actions subcategory: cache security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: summary: GitHub Delete Github Actions Caches for Repository (using Cache Key) description: |- Deletes one or more GitHub Actions caches for a repository, using a complete cache key. By default, all caches that match the provided key are deleted, but you can optionally provide a Git ref to restrict deletions to caches that match both the provided key and the Git ref. OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - Actions - Cache - Caches - Delete - Keys - Repositories operationId: deleteGithubActionsCachesForRepositoryUsingCacheKey externalDocs: description: API method documentation url: |- https://docs.github.com/enterprise-server@3.9/rest/actions/cache#delete-github-actions-caches-for-a-repository-using-a-cache-key parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/actions-cache-key-required' - $ref: '#/components/parameters/actions-cache-git-ref-full' - in: header name: Authorization schema: type: string example: example_value - in: header name: X-GitHub-Api-Version schema: type: string default: '2022-11-28' example: example_value - in: header name: Accept schema: type: string default: application/vnd.github+json example: example_value responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/actions-cache-list' examples: default: $ref: '#/components/examples/actions-cache-list' x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: cache security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /repos/{owner}/{repo}/actions/caches/{cache_id}: delete: summary: GitHub Delete Github Actions Cache for Repository (using Cache Id) description: |- Deletes a GitHub Actions cache for a repository, using a cache ID. OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - Actions - Cache - Delete - Identifiers - Repositories operationId: deleteGithubActionsCacheForRepositoryUsingCacheId externalDocs: description: API method documentation url: |- https://docs.github.com/enterprise-server@3.9/rest/actions/cache#delete-a-github-actions-cache-for-a-repository-using-a-cache-id parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/cache-id' - in: header name: Authorization schema: type: string example: example_value - in: header name: X-GitHub-Api-Version schema: type: string default: '2022-11-28' example: example_value - in: header name: Accept schema: type: string default: application/vnd.github+json example: example_value responses: '204': description: Response x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: cache security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /repos/{owner}/{repo}/actions/jobs/{job_id}: get: summary: GitHub Get Job for Workflow Run description: |- Gets a specific job in a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - Get - Jobs - Runs operationId: getJobForWorkflowRun externalDocs: description: API method documentation url: |- https://docs.github.com/enterprise-server@3.9/rest/actions/workflow-jobs#get-a-job-for-a-workflow-run parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/job-id' - in: header name: Authorization schema: type: string example: example_value - in: header name: X-GitHub-Api-Version schema: type: string default: '2022-11-28' example: example_value - in: header name: Accept schema: type: string default: application/vnd.github+json example: example_value responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/job' examples: default: $ref: '#/components/examples/job' x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: workflow-jobs security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /repos/{owner}/{repo}/actions/jobs/{job_id}/logs: get: summary: GitHub Download Job Logs for Workflow Run description: |- Gets a redirect URL to download a plain text file of logs for a workflow job. This link expires after 1 minute. Look for `Location:` in the response header to find the URL for the download. Anyone with read access to the repository can use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - Download - Jobs - Logs - Runs - Workflows operationId: downloadJobLogsForWorkflowRun externalDocs: description: API method documentation url: |- https://docs.github.com/enterprise-server@3.9/rest/actions/workflow-jobs#download-job-logs-for-a-workflow-run parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/job-id' - in: header name: Authorization schema: type: string example: example_value - in: header name: X-GitHub-Api-Version schema: type: string default: '2022-11-28' example: example_value - in: header name: Accept schema: type: string default: application/vnd.github+json example: example_value responses: '302': description: Response headers: Location: example: |- https://pipelines.actions.githubusercontent.com/ab1f3cCFPB34Nd6imvFxpGZH5hNlDp2wijMwl2gDoO0bcrrlJj/_apis/pipelines/1/jobs/19/signedlogcontent?urlExpires=2020-01-22T22%3A44%3A54.1389777Z&urlSigningMethod=HMACV1&urlSignature=2TUDfIg4fm36OJmfPy6km5QD5DLCOkBVzvhWZM8B%2BUY%3D schema: type: string x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: workflow-jobs security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /repos/{owner}/{repo}/actions/jobs/{job_id}/rerun: post: summary: GitHub Re-run Job from Workflow Run description: |- Re-run a job and its dependent jobs in a workflow run. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - Jobs - Re-Run - Runs - Workflows operationId: rerunJobFromWorkflowRun externalDocs: description: API method documentation url: |- https://docs.github.com/enterprise-server@3.9/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/job-id' - in: header name: Authorization schema: type: string example: example_value - in: header name: X-GitHub-Api-Version schema: type: string default: '2022-11-28' example: example_value - in: header name: Accept schema: type: string default: application/vnd.github+json example: example_value requestBody: required: false content: application/json: schema: type: object properties: enable_debug_logging: type: boolean default: false description: Whether to enable debug logging for the re-run. examples: default: value: {} responses: '201': description: Response content: application/json: schema: $ref: '#/components/schemas/empty-object' examples: default: value: {} '403': $ref: '#/components/responses/forbidden' x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: workflow-runs security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /repos/{owner}/{repo}/actions/oidc/customization/sub: get: summary: GitHub Get the Customization Template for an Oidc Subject Claim for Repository description: |- Gets the customization template for an OpenID Connect (OIDC) subject claim. OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - Claims - Customizations - Get - Openid Connect - Repositories - Subject - Templates operationId: getTheCustomizationTemplateForAnOidcSubjectClaimForRepository externalDocs: description: API method documentation url: |- https://docs.github.com/enterprise-server@3.9/rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-a-repository parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - in: header name: Authorization schema: type: string example: example_value - in: header name: X-GitHub-Api-Version schema: type: string default: '2022-11-28' example: example_value - in: header name: Accept schema: type: string default: application/vnd.github+json example: example_value responses: '200': description: Status response content: application/json: schema: $ref: '#/components/schemas/oidc-custom-sub-repo' examples: default: $ref: '#/components/examples/oidc-custom-sub-repo' '400': $ref: '#/components/responses/bad_request' '404': $ref: '#/components/responses/not_found' x-github: enabledForGitHubApps: true previews: [] category: actions subcategory: oidc security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK put: summary: GitHub Set the Customization Template for an Oidc Subject Claim for Repository description: |- Sets the customization template and `opt-in` or `opt-out` flag for an OpenID Connect (OIDC) subject claim for a repository. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - Claims - Customizations - Openid Connect - Repositories - Sets - Subject - Templates operationId: setTheCustomizationTemplateForAnOidcSubjectClaimForRepository externalDocs: description: API method documentation url: |- https://docs.github.com/enterprise-server@3.9/rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-a-repository parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - in: header name: Authorization schema: type: string example: example_value - in: header name: X-GitHub-Api-Version schema: type: string default: '2022-11-28' example: example_value - in: header name: Accept schema: type: string default: application/vnd.github+json example: example_value requestBody: required: true content: application/json: schema: title: Actions OIDC subject customization for a repository description: Actions OIDC subject customization for a repository type: object required: - use_default properties: use_default: description: |- Whether to use the default template or not. If `true`, the `include_claim_keys` field is ignored. type: boolean include_claim_keys: description: |- Array of unique strings. Each claim key can only contain alphanumeric characters and underscores. type: array items: type: string examples: default: value: use_default: false include_claim_keys: - repo - context responses: '201': description: Empty response content: application/json: schema: $ref: '#/components/schemas/empty-object' examples: default: value: {} '400': $ref: '#/components/responses/bad_request' '404': $ref: '#/components/responses/not_found' '422': $ref: '#/components/responses/validation_failed_simple' x-github: enabledForGitHubApps: true previews: [] category: actions subcategory: oidc security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /repos/{owner}/{repo}/actions/organization-secrets: get: summary: GitHub List Repository Organization Secrets description: |- Lists all organization secrets shared with a repository without revealing their encrypted values. Authenticated users must have collaborator access to a repository to create, update, or read secrets. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - Lists - Organizations - Repositories - Secrets operationId: listRepositoryOrganizationSecrets externalDocs: description: API method documentation url: |- https://docs.github.com/enterprise-server@3.9/rest/actions/secrets#list-repository-organization-secrets parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/per-page' - $ref: '#/components/parameters/page' - in: header name: Authorization schema: type: string example: example_value - in: header name: X-GitHub-Api-Version schema: type: string default: '2022-11-28' example: example_value - in: header name: Accept schema: type: string default: application/vnd.github+json example: example_value responses: '200': description: Response content: application/json: schema: type: object required: - total_count - secrets properties: total_count: type: integer secrets: type: array items: $ref: '#/components/schemas/actions-secret' examples: default: $ref: '#/components/examples/actions-secret-paginated' headers: Link: $ref: '#/components/headers/link' x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: secrets x-api-evangelist-certified: '2025-07-16' x-api-naftiko-published: '2025-07-25' security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /repos/{owner}/{repo}/actions/organization-variables: get: summary: GitHub List Repository Organization Variables description: |- Lists all organization variables shared with a repository. Authenticated users must have collaborator access to a repository to create, update, or read variables. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - Lists - Organizations - Repositories - Variables operationId: listRepositoryOrganizationVariables externalDocs: description: API method documentation url: |- https://docs.github.com/enterprise-server@3.9/rest/actions/variables#list-repository-organization-variables parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/variables-per-page' - $ref: '#/components/parameters/page' - in: header name: Authorization schema: type: string example: example_value - in: header name: X-GitHub-Api-Version schema: type: string default: '2022-11-28' example: example_value - in: header name: Accept schema: type: string default: application/vnd.github+json example: example_value responses: '200': description: Response content: application/json: schema: type: object required: - total_count - variables properties: total_count: type: integer variables: type: array items: $ref: '#/components/schemas/actions-variable' examples: default: $ref: '#/components/examples/actions-variables-paginated' headers: Link: $ref: '#/components/headers/link' x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: variables x-api-evangelist-certified: '2025-07-16' x-api-naftiko-published: '2025-07-25' security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /repos/{owner}/{repo}/actions/permissions: get: summary: GitHub Get Github Actions Permissions for Repository description: |- Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions allowed to run in the repository. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API. operationId: getGithubActionsPermissionsForRepository tags: - Actions - Get - Permissions - Repositories externalDocs: description: API method documentation url: |- https://docs.github.com/enterprise-server@3.9/rest/actions/permissions#get-github-actions-permissions-for-a-repository parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - in: header name: Authorization schema: type: string example: example_value - in: header name: X-GitHub-Api-Version schema: type: string default: '2022-11-28' example: example_value - in: header name: Accept schema: type: string default: application/vnd.github+json example: example_value responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/actions-repository-permissions' examples: default: $ref: '#/components/examples/actions-repository-permissions' x-github: enabledForGitHubApps: true githubCloudOnly: false category: actions subcategory: permissions security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK put: summary: GitHub Set Github Actions Permissions for Repository description: |- Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions in the repository. If the repository belongs to an organization or enterprise that has set restrictive permissions at the organization or enterprise levels, such as `allowed_actions` to `selected` actions, then you cannot override them for the repository. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. operationId: setGithubActionsPermissionsForRepository tags: - Actions - Permissions - Repositories - Sets externalDocs: description: API method documentation url: |- https://docs.github.com/enterprise-server@3.9/rest/actions/permissions#set-github-actions-permissions-for-a-repository parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - in: header name: Authorization schema: type: string example: example_value - in: header name: X-GitHub-Api-Version schema: type: string default: '2022-11-28' example: example_value - in: header name: Accept schema: type: string default: application/vnd.github+json example: example_value responses: '204': description: Response requestBody: required: true content: application/json: schema: type: object properties: enabled: $ref: '#/components/schemas/actions-enabled' allowed_actions: $ref: '#/components/schemas/allowed-actions' required: - enabled examples: default: value: enabled: true allowed_actions: selected x-github: enabledForGitHubApps: true githubCloudOnly: false category: actions subcategory: permissions security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /repos/{owner}/{repo}/actions/permissions/access: get: summary: GitHub Get the Level of Access for Workflows Outside of the Repository description: |- Gets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository. This endpoint only applies to internal and private repositories. For more information, see "[Allowing access to components in a private repository](https://docs.github.com/enterprise-server@3.9/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)" and "[Allowing access to components in an internal repository](https://docs.github.com/enterprise-server@3.9/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-repository)." OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - Access - Get - Levels - Outside - Repositories - Workflows operationId: getTheLevelOfAccessForWorkflowsOutsideOfTheRepository externalDocs: description: API method documentation url: |- https://docs.github.com/enterprise-server@3.9/rest/actions/permissions#get-the-level-of-access-for-workflows-outside-of-the-repository parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - in: header name: Authorization schema: type: string example: example_value - in: header name: X-GitHub-Api-Version schema: type: string default: '2022-11-28' example: example_value - in: header name: Accept schema: type: string default: application/vnd.github+json example: example_value responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/actions-workflow-access-to-repository' examples: default: $ref: '#/components/examples/actions-workflow-access-to-repository' x-github: githubCloudOnly: false enabledForGitHubApps: true previews: [] category: actions subcategory: permissions security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK put: summary: GitHub Set the Level of Access for Workflows Outside of the Repository description: |- Sets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository. This endpoint only applies to internal and private repositories. For more information, see "[Allowing access to components in a private repository](https://docs.github.com/enterprise-server@3.9/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)" and "[Allowing access to components in an internal repository](https://docs.github.com/enterprise-server@3.9/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-repository)." OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - Access - Levels - Outside - Repositories - Sets - Workflows operationId: setTheLevelOfAccessForWorkflowsOutsideOfTheRepository externalDocs: description: API method documentation url: |- https://docs.github.com/enterprise-server@3.9/rest/actions/permissions#set-the-level-of-access-for-workflows-outside-of-the-repository parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - in: header name: Authorization schema: type: string example: example_value - in: header name: X-GitHub-Api-Version schema: type: string default: '2022-11-28' example: example_value - in: header name: Accept schema: type: string default: application/vnd.github+json example: example_value requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/actions-workflow-access-to-repository' examples: default: $ref: '#/components/examples/actions-workflow-access-to-repository' responses: '204': description: Response x-github: githubCloudOnly: false enabledForGitHubApps: true previews: [] category: actions subcategory: permissions security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /repos/{owner}/{repo}/actions/permissions/selected-actions: get: summary: GitHub Get Allowed Actions for Repository description: |- Gets the settings for selected actions that are allowed in a repository. To use this endpoint, the repository policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)." You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API. operationId: getAllowedActionsForRepository tags: - Actions - Allowed - Get - Repositories externalDocs: description: API method documentation url: |- https://docs.github.com/enterprise-server@3.9/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-a-repository parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - in: header name: Authorization schema: type: string example: example_value - in: header name: X-GitHub-Api-Version schema: type: string default: '2022-11-28' example: example_value - in: header name: Accept schema: type: string default: application/vnd.github+json example: example_value responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/selected-actions' examples: default: $ref: '#/components/examples/selected-actions' x-github: enabledForGitHubApps: true githubCloudOnly: false category: actions subcategory: permissions x-api-evangelist-certified: '2025-07-16' x-api-naftiko-published: '2025-07-25' security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK put: summary: GitHub Set Allowed Actions for Repository description: |- Sets the actions that are allowed in a repository. To use this endpoint, the repository permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)." If the repository belongs to an organization or enterprise that has `selected` actions set at the organization or enterprise levels, then you cannot override any of the allowed actions settings. To use the `patterns_allowed` setting for private repositories, the repository must belong to an enterprise. If the repository does not belong to an enterprise, then the `patterns_allowed` setting only applies to public repositories. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. operationId: setAllowedActionsForRepository tags: - Actions - Allowed - Repositories - Sets externalDocs: description: API method documentation url: |- https://docs.github.com/enterprise-server@3.9/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-a-repository parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - in: header name: Authorization schema: type: string example: example_value - in: header name: X-GitHub-Api-Version schema: type: string default: '2022-11-28' example: example_value - in: header name: Accept schema: type: string default: application/vnd.github+json example: example_value responses: '204': description: Response requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/selected-actions' examples: selected_actions: $ref: '#/components/examples/selected-actions' x-github: enabledForGitHubApps: true githubCloudOnly: false category: actions subcategory: permissions security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /repos/{owner}/{repo}/actions/permissions/workflow: get: summary: GitHub Get Default Workflow Permissions for Repository description: |- Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository, as well as if GitHub Actions can submit approving pull request reviews. For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/enterprise-server@3.9/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository)." OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - Get - Permissions - Repositories - Workflows operationId: getDefaultWorkflowPermissionsForRepository externalDocs: description: API method documentation url: |- https://docs.github.com/enterprise-server@3.9/rest/actions/permissions#get-default-workflow-permissions-for-a-repository parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - in: header name: Authorization schema: type: string example: example_value - in: header name: X-GitHub-Api-Version schema: type: string default: '2022-11-28' example: example_value - in: header name: Accept schema: type: string default: application/vnd.github+json example: example_value responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/actions-get-default-workflow-permissions' examples: default: $ref: '#/components/examples/actions-default-workflow-permissions' x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: permissions security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK put: summary: GitHub Set Default Workflow Permissions for Repository description: |- Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository, and sets if GitHub Actions can submit approving pull request reviews. For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/enterprise-server@3.9/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository)." OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - Permissions - Repositories - Sets - Workflows operationId: setDefaultWorkflowPermissionsForRepository externalDocs: description: API method documentation url: |- https://docs.github.com/enterprise-server@3.9/rest/actions/permissions#set-default-workflow-permissions-for-a-repository parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - in: header name: Authorization schema: type: string example: example_value - in: header name: X-GitHub-Api-Version schema: type: string default: '2022-11-28' example: example_value - in: header name: Accept schema: type: string default: application/vnd.github+json example: example_value responses: '204': description: Success response '409': description: |- Conflict response when changing a setting is prevented by the owning organization or enterprise requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/actions-set-default-workflow-permissions' examples: default: $ref: '#/components/examples/actions-default-workflow-permissions' x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: permissions security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /repos/{owner}/{repo}/actions/runners: get: summary: GitHub List Self-hosted Runners for Repository description: |- Lists all self-hosted runners configured in a repository. Authenticated users must have admin access to the repository to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - Lists - Repositories - Runners - Self-Hosted operationId: listSelfhostedRunnersForRepository externalDocs: description: API method documentation url: |- https://docs.github.com/enterprise-server@3.9/rest/actions/self-hosted-runners#list-self-hosted-runners-for-a-repository parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/per-page' - $ref: '#/components/parameters/page' - in: header name: Authorization schema: type: string example: example_value - in: header name: X-GitHub-Api-Version schema: type: string default: '2022-11-28' example: example_value - in: header name: Accept schema: type: string default: application/vnd.github+json example: example_value responses: '200': description: Response content: application/json: schema: type: object required: - total_count - runners properties: total_count: type: integer runners: type: array items: $ref: '#/components/schemas/runner' examples: default: $ref: '#/components/examples/runner-paginated' headers: Link: $ref: '#/components/headers/link' x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: self-hosted-runners security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /repos/{owner}/{repo}/actions/runners/downloads: get: summary: GitHub List Runner Applications for Repository description: |- Lists binaries for the runner application that you can download and run. Authenticated users must have admin access to the repository to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - Applications - Lists - Repositories - Runners operationId: listRunnerApplicationsForRepository externalDocs: description: API method documentation url: |- https://docs.github.com/enterprise-server@3.9/rest/actions/self-hosted-runners#list-runner-applications-for-a-repository parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - in: header name: Authorization schema: type: string example: example_value - in: header name: X-GitHub-Api-Version schema: type: string default: '2022-11-28' example: example_value - in: header name: Accept schema: type: string default: application/vnd.github+json example: example_value responses: '200': description: Response content: application/json: schema: type: array items: $ref: '#/components/schemas/runner-application' examples: default: $ref: '#/components/examples/runner-application-items-airgap' x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: self-hosted-runners security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /repos/{owner}/{repo}/actions/runners/registration-token: post: summary: GitHub Create Registration Token for Repository description: |- Returns a token that you can pass to the `config` script. The token expires after one hour. For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to configure your self-hosted runner: ``` ./config.sh --url https://github.com/octo-org --token TOKEN ``` Authenticated users must have admin access to the repository to use this endpoint. OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - Create - Registration - Repositories - Tokens operationId: createRegistrationTokenForRepository externalDocs: description: API method documentation url: |- https://docs.github.com/enterprise-server@3.9/rest/actions/self-hosted-runners#create-a-registration-token-for-a-repository parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - in: header name: Authorization schema: type: string example: example_value - in: header name: X-GitHub-Api-Version schema: type: string default: '2022-11-28' example: example_value - in: header name: Accept schema: type: string default: application/vnd.github+json example: example_value responses: '201': description: Response content: application/json: schema: $ref: '#/components/schemas/authentication-token' examples: default: $ref: '#/components/examples/authentication-token' x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: self-hosted-runners security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /repos/{owner}/{repo}/actions/runners/remove-token: post: summary: GitHub Create Remove Token for Repository description: |- Returns a token that you can pass to the `config` script to remove a self-hosted runner from an repository. The token expires after one hour. For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization: ``` ./config.sh remove --token TOKEN ``` Authenticated users must have admin access to the repository to use this endpoint. OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - Create - Remove - Repositories - Tokens operationId: createRemoveTokenForRepository externalDocs: description: API method documentation url: |- https://docs.github.com/enterprise-server@3.9/rest/actions/self-hosted-runners#create-a-remove-token-for-a-repository parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - in: header name: Authorization schema: type: string example: example_value - in: header name: X-GitHub-Api-Version schema: type: string default: '2022-11-28' example: example_value - in: header name: Accept schema: type: string default: application/vnd.github+json example: example_value responses: '201': description: Response content: application/json: schema: $ref: '#/components/schemas/authentication-token' examples: default: $ref: '#/components/examples/authentication-token-2' x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: self-hosted-runners security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /repos/{owner}/{repo}/actions/runners/{runner_id}: get: summary: GitHub Get Self-hosted Runner for Repository description: |- Gets a specific self-hosted runner configured in a repository. Authenticated users must have admin access to the repository to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - Get - Repositories - Runners - Self-Hosted operationId: getSelfhostedRunnerForRepository externalDocs: description: API method documentation url: |- https://docs.github.com/enterprise-server@3.9/rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-a-repository parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/runner-id' - in: header name: Authorization schema: type: string example: example_value - in: header name: X-GitHub-Api-Version schema: type: string default: '2022-11-28' example: example_value - in: header name: Accept schema: type: string default: application/vnd.github+json example: example_value responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/runner' examples: default: $ref: '#/components/examples/runner' x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: self-hosted-runners security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: summary: GitHub Delete Self-hosted Runner from Repository description: |- Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. Authenticated users must have admin access to the repository to use this endpoint. OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - Delete - Repositories - Runners - Self-Hosted operationId: deleteSelfhostedRunnerFromRepository externalDocs: description: API method documentation url: |- https://docs.github.com/enterprise-server@3.9/rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-a-repository parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/runner-id' - in: header name: Authorization schema: type: string example: example_value - in: header name: X-GitHub-Api-Version schema: type: string default: '2022-11-28' example: example_value - in: header name: Accept schema: type: string default: application/vnd.github+json example: example_value responses: '204': description: Response x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: self-hosted-runners security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /repos/{owner}/{repo}/actions/runners/{runner_id}/labels: get: summary: GitHub List Labels for Self-hosted Runner for Repository description: |- Lists all labels for a self-hosted runner configured in a repository. Authenticated users must have admin access to the repository to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - Labels - Lists - Repositories - Runners - Self-Hosted operationId: listLabelsForSelfhostedRunnerForRepository externalDocs: description: API method documentation url: |- https://docs.github.com/enterprise-server@3.9/rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-a-repository parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/runner-id' - in: header name: Authorization schema: type: string example: example_value - in: header name: X-GitHub-Api-Version schema: type: string default: '2022-11-28' example: example_value - in: header name: Accept schema: type: string default: application/vnd.github+json example: example_value responses: '200': $ref: '#/components/responses/actions_runner_labels' '404': $ref: '#/components/responses/not_found' x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: self-hosted-runners security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK post: summary: GitHub Add Custom Labels to Self-hosted Runner for Repository description: |- Adds custom labels to a self-hosted runner configured in a repository. Authenticated users must have admin access to the organization to use this endpoint. OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - Add - Custom - Labels - Repositories - Runners - Self-Hosted operationId: addCustomLabelsToSelfhostedRunnerForRepository externalDocs: description: API method documentation url: |- https://docs.github.com/enterprise-server@3.9/rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-a-repository parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/runner-id' - in: header name: Authorization schema: type: string example: example_value - in: header name: X-GitHub-Api-Version schema: type: string default: '2022-11-28' example: example_value - in: header name: Accept schema: type: string default: application/vnd.github+json example: example_value requestBody: required: true content: application/json: schema: type: object required: - labels properties: labels: type: array minItems: 1 maxItems: 100 description: The names of the custom labels to add to the runner. items: type: string examples: default: value: labels: - gpu - accelerated responses: '200': $ref: '#/components/responses/actions_runner_labels' '404': $ref: '#/components/responses/not_found' '422': $ref: '#/components/responses/validation_failed_simple' x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: self-hosted-runners security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK put: summary: GitHub Set Custom Labels for Self-hosted Runner for Repository description: |- Remove all previous custom labels and set the new custom labels for a specific self-hosted runner configured in a repository. Authenticated users must have admin access to the repository to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - Custom - Labels - Repositories - Runners - Self-Hosted - Sets operationId: setCustomLabelsForSelfhostedRunnerForRepository externalDocs: description: API method documentation url: |- https://docs.github.com/enterprise-server@3.9/rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-a-repository parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/runner-id' - in: header name: Authorization schema: type: string example: example_value - in: header name: X-GitHub-Api-Version schema: type: string default: '2022-11-28' example: example_value - in: header name: Accept schema: type: string default: application/vnd.github+json example: example_value requestBody: required: true content: application/json: schema: type: object required: - labels properties: labels: type: array maxItems: 100 description: |- The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels. items: type: string examples: default: value: labels: - gpu - accelerated responses: '200': $ref: '#/components/responses/actions_runner_labels' '404': $ref: '#/components/responses/not_found' '422': $ref: '#/components/responses/validation_failed_simple' x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: self-hosted-runners security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: summary: GitHub Remove All Custom Labels from Self-hosted Runner for Repository description: |- Remove all custom labels from a self-hosted runner configured in a repository. Returns the remaining read-only labels from the runner. Authenticated users must have admin access to the repository to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - All - Custom - Labels - Remove - Repositories - Runners - Self-Hosted operationId: removeAllCustomLabelsFromSelfhostedRunnerForRepository externalDocs: description: API method documentation url: |- https://docs.github.com/enterprise-server@3.9/rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-a-repository parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/runner-id' - in: header name: Authorization schema: type: string example: example_value - in: header name: X-GitHub-Api-Version schema: type: string default: '2022-11-28' example: example_value - in: header name: Accept schema: type: string default: application/vnd.github+json example: example_value responses: '200': $ref: '#/components/responses/actions_runner_labels_readonly' '404': $ref: '#/components/responses/not_found' x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: self-hosted-runners security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /repos/{owner}/{repo}/actions/runners/{runner_id}/labels/{name}: delete: summary: GitHub Remove Custom Label from Self-hosted Runner for Repository description: |- Remove a custom label from a self-hosted runner configured in a repository. Returns the remaining labels from the runner. This endpoint returns a `404 Not Found` status if the custom label is not present on the runner. Authenticated users must have admin access to the repository to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - Custom - Label - Remove - Repositories - Runners - Self-Hosted operationId: removeCustomLabelFromSelfhostedRunnerForRepository externalDocs: description: API method documentation url: |- https://docs.github.com/enterprise-server@3.9/rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-a-repository parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/runner-id' - $ref: '#/components/parameters/runner-label-name' - in: header name: Authorization schema: type: string example: example_value - in: header name: X-GitHub-Api-Version schema: type: string default: '2022-11-28' example: example_value - in: header name: Accept schema: type: string default: application/vnd.github+json example: example_value responses: '200': $ref: '#/components/responses/actions_runner_labels' '404': $ref: '#/components/responses/not_found' '422': $ref: '#/components/responses/validation_failed_simple' x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: self-hosted-runners security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /repos/{owner}/{repo}/actions/runs: get: summary: GitHub List Workflow Runs for Repository description: |- Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#parameters). Anyone with read access to the repository can use this endpoint. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. tags: - Lists - Repositories - Runs - Workflows operationId: listWorkflowRunsForRepository externalDocs: description: API method documentation url: |- https://docs.github.com/enterprise-server@3.9/rest/actions/workflow-runs#list-workflow-runs-for-a-repository parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/actor' - $ref: '#/components/parameters/workflow-run-branch' - $ref: '#/components/parameters/event' - $ref: '#/components/parameters/workflow-run-status' - $ref: '#/components/parameters/per-page' - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/created' - $ref: '#/components/parameters/exclude-pull-requests' - $ref: '#/components/parameters/workflow-run-check-suite-id' - $ref: '#/components/parameters/workflow-run-head-sha' - in: header name: Authorization schema: type: string example: example_value - in: header name: X-GitHub-Api-Version schema: type: string default: '2022-11-28' example: example_value - in: header name: Accept schema: type: string default: application/vnd.github+json example: example_value responses: '200': description: Response content: application/json: schema: type: object required: - total_count - workflow_runs properties: total_count: type: integer workflow_runs: type: array items: $ref: '#/components/schemas/workflow-run' examples: default: $ref: '#/components/examples/workflow-run-paginated' headers: Link: $ref: '#/components/headers/link' x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: workflow-runs x-api-evangelist-certified: '2025-07-16' x-api-naftiko-published: '2025-07-25' security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /repos/{owner}/{repo}/actions/runs/{run_id}: get: summary: GitHub Get Workflow Run description: |- Gets a specific workflow run. Anyone with read access to the repository can use this endpoint. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. tags: - Get - Runs - Workflows operationId: getWorkflowRun externalDocs: description: API method documentation url: |- https://docs.github.com/enterprise-server@3.9/rest/actions/workflow-runs#get-a-workflow-run parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/run-id' - $ref: '#/components/parameters/exclude-pull-requests' - in: header name: Authorization schema: type: string example: example_value - in: header name: X-GitHub-Api-Version schema: type: string default: '2022-11-28' example: example_value - in: header name: Accept schema: type: string default: application/vnd.github+json example: example_value responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/workflow-run' examples: default: $ref: '#/components/examples/workflow-run' x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: workflow-runs security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: summary: GitHub Delete Workflow Run description: |- Deletes a specific workflow run. Anyone with write access to the repository can use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. operationId: deleteWorkflowRun tags: - Delete - Runs - Workflows externalDocs: description: API method documentation url: |- https://docs.github.com/enterprise-server@3.9/rest/actions/workflow-runs#delete-a-workflow-run parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/run-id' - in: header name: Authorization schema: type: string example: example_value - in: header name: X-GitHub-Api-Version schema: type: string default: '2022-11-28' example: example_value - in: header name: Accept schema: type: string default: application/vnd.github+json example: example_value responses: '204': description: Response x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: workflow-runs security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /repos/{owner}/{repo}/actions/runs/{run_id}/approvals: get: summary: GitHub Get the Review History for Workflow Run description: |- Anyone with read access to the repository can use this endpoint. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. tags: - Get - History - Reviews - Runs - Workflows operationId: getTheReviewHistoryForWorkflowRun externalDocs: description: API method documentation url: |- https://docs.github.com/enterprise-server@3.9/rest/actions/workflow-runs#get-the-review-history-for-a-workflow-run parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/run-id' - in: header name: Authorization schema: type: string example: example_value - in: header name: X-GitHub-Api-Version schema: type: string default: '2022-11-28' example: example_value - in: header name: Accept schema: type: string default: application/vnd.github+json example: example_value responses: '200': description: Response content: application/json: schema: type: array items: $ref: '#/components/schemas/environment-approvals' examples: default: $ref: '#/components/examples/environment-approvals-items' x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: workflow-runs security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /repos/{owner}/{repo}/actions/runs/{run_id}/artifacts: get: summary: GitHub List Workflow Run Artifacts description: |- Lists artifacts for a workflow run. Anyone with read access to the repository can use this endpoint. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. tags: - Artifacts - Lists - Runs - Workflows operationId: listWorkflowRunArtifacts externalDocs: description: API method documentation url: |- https://docs.github.com/enterprise-server@3.9/rest/actions/artifacts#list-workflow-run-artifacts parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/run-id' - $ref: '#/components/parameters/per-page' - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/artifact-name' - in: header name: Authorization schema: type: string example: example_value - in: header name: X-GitHub-Api-Version schema: type: string default: '2022-11-28' example: example_value - in: header name: Accept schema: type: string default: application/vnd.github+json example: example_value responses: '200': description: Response content: application/json: schema: type: object required: - total_count - artifacts properties: total_count: type: integer artifacts: type: array items: $ref: '#/components/schemas/artifact' examples: default: $ref: '#/components/examples/artifact-paginated' headers: Link: $ref: '#/components/headers/link' x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: artifacts security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}: get: summary: GitHub Get Workflow Run Attempt description: |- Gets a specific workflow run attempt. Anyone with read access to the repository can use this endpoint. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. tags: - Attempts - Get - Runs - Workflows operationId: getWorkflowRunAttempt externalDocs: description: API method documentation url: |- https://docs.github.com/enterprise-server@3.9/rest/actions/workflow-runs#get-a-workflow-run-attempt parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/run-id' - $ref: '#/components/parameters/attempt-number' - $ref: '#/components/parameters/exclude-pull-requests' - in: header name: Authorization schema: type: string example: example_value - in: header name: X-GitHub-Api-Version schema: type: string default: '2022-11-28' example: example_value - in: header name: Accept schema: type: string default: application/vnd.github+json example: example_value responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/workflow-run' examples: default: $ref: '#/components/examples/workflow-run' x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: workflow-runs security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs: get: summary: GitHub List Jobs for Workflow Run Attempt description: |- Lists jobs for a specific workflow run attempt. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#parameters). Anyone with read access to the repository can use this endpoint. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. tags: - Attempts - Jobs - Lists - Runs - Workflows operationId: listJobsForWorkflowRunAttempt externalDocs: description: API method documentation url: |- https://docs.github.com/enterprise-server@3.9/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run-attempt parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/run-id' - $ref: '#/components/parameters/attempt-number' - $ref: '#/components/parameters/per-page' - $ref: '#/components/parameters/page' - in: header name: Authorization schema: type: string example: example_value - in: header name: X-GitHub-Api-Version schema: type: string default: '2022-11-28' example: example_value - in: header name: Accept schema: type: string default: application/vnd.github+json example: example_value responses: '200': description: Response content: application/json: schema: type: object required: - total_count - jobs properties: total_count: type: integer jobs: type: array items: $ref: '#/components/schemas/job' examples: default: $ref: '#/components/examples/job-paginated' headers: Link: $ref: '#/components/headers/link' '404': $ref: '#/components/responses/not_found' x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: workflow-jobs security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/logs: get: summary: GitHub Download Workflow Run Attempt Logs description: |- Gets a redirect URL to download an archive of log files for a specific workflow run attempt. This link expires after 1 minute. Look for `Location:` in the response header to find the URL for the download. Anyone with read access to the repository can use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - Attempts - Download - Logs - Runs - Workflows operationId: downloadWorkflowRunAttemptLogs externalDocs: description: API method documentation url: |- https://docs.github.com/enterprise-server@3.9/rest/actions/workflow-runs#download-workflow-run-attempt-logs parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/run-id' - $ref: '#/components/parameters/attempt-number' - in: header name: Authorization schema: type: string example: example_value - in: header name: X-GitHub-Api-Version schema: type: string default: '2022-11-28' example: example_value - in: header name: Accept schema: type: string default: application/vnd.github+json example: example_value responses: '302': description: Response headers: Location: example: |- https://pipelines.actions.githubusercontent.com/ab1f3cCFPB34Nd6imvFxpGZH5hNlDp2wijMwl2gDoO0bcrrlJj/_apis/pipelines/1/runs/19/signedlogcontent?urlExpires=2020-01-22T22%3A44%3A54.1389777Z&urlSigningMethod=HMACV1&urlSignature=2TUDfIg4fm36OJmfPy6km5QD5DLCOkBVzvhWZM8B%2BUY%3D schema: type: string x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: workflow-runs security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /repos/{owner}/{repo}/actions/runs/{run_id}/cancel: post: summary: GitHub Cancel Workflow Run description: |- Cancels workflow run using its `id`. OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - Cancel - Runs - Workflows operationId: cancelWorkflowRun externalDocs: description: API method documentation url: |- https://docs.github.com/enterprise-server@3.9/rest/actions/workflow-runs#cancel-a-workflow-run parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/run-id' - in: header name: Authorization schema: type: string example: example_value - in: header name: X-GitHub-Api-Version schema: type: string default: '2022-11-28' example: example_value - in: header name: Accept schema: type: string default: application/vnd.github+json example: example_value responses: '202': description: Response content: application/json: schema: $ref: '#/components/schemas/empty-object' examples: default: value: {} '409': $ref: '#/components/responses/conflict' x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: workflow-runs security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /repos/{owner}/{repo}/actions/runs/{run_id}/jobs: get: summary: GitHub List Jobs for Workflow Run description: |- Lists jobs for workflow run. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#parameters). Anyone with read access to the repository can use this endpoint. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private repository. tags: - Jobs - Lists - Runs - Workflows operationId: listJobsForWorkflowRun externalDocs: description: API method documentation url: |- https://docs.github.com/enterprise-server@3.9/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/run-id' - name: filter description: |- Filters jobs by their `completed_at` timestamp. `latest` returns jobs from the most recent execution of the workflow run. `all` returns all jobs for workflow run, including from old executions of the workflow run. in: query required: false schema: type: string enum: - latest - all default: latest example: latest - $ref: '#/components/parameters/per-page' - $ref: '#/components/parameters/page' - in: header name: Authorization schema: type: string example: example_value - in: header name: X-GitHub-Api-Version schema: type: string default: '2022-11-28' example: example_value - in: header name: Accept schema: type: string default: application/vnd.github+json example: example_value responses: '200': description: Response content: application/json: schema: type: object required: - total_count - jobs properties: total_count: type: integer jobs: type: array items: $ref: '#/components/schemas/job' examples: default: $ref: '#/components/examples/job-paginated' headers: Link: $ref: '#/components/headers/link' x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: workflow-jobs security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /repos/{owner}/{repo}/actions/runs/{run_id}/logs: get: summary: GitHub Download Workflow Run Logs description: |- Gets redirect URL to download an archive of log files for workflow run. This link expires after 1 minute. Look for `Location:` in the response header to find the URL for the download. Anyone with read access to the repository can use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - Download - Logs - Runs - Workflows operationId: downloadWorkflowRunLogs externalDocs: description: API method documentation url: |- https://docs.github.com/enterprise-server@3.9/rest/actions/workflow-runs#download-workflow-run-logs parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/run-id' - in: header name: Authorization schema: type: string example: example_value - in: header name: X-GitHub-Api-Version schema: type: string default: '2022-11-28' example: example_value - in: header name: Accept schema: type: string default: application/vnd.github+json example: example_value responses: '302': description: Response headers: Location: example: |- https://pipelines.actions.githubusercontent.com/ab1f3cCFPB34Nd6imvFxpGZH5hNlDp2wijMwl2gDoO0bcrrlJj/_apis/pipelines/1/runs/19/signedlogcontent?urlExpires=2020-01-22T22%3A44%3A54.1389777Z&urlSigningMethod=HMACV1&urlSignature=2TUDfIg4fm36OJmfPy6km5QD5DLCOkBVzvhWZM8B%2BUY%3D schema: type: string x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: workflow-runs security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: summary: GitHub Delete Workflow Run Logs description: |- Deletes all logs for a workflow run. OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - Delete - Logs - Runs - Workflows operationId: deleteWorkflowRunLogs externalDocs: description: API method documentation url: |- https://docs.github.com/enterprise-server@3.9/rest/actions/workflow-runs#delete-workflow-run-logs parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/run-id' - in: header name: Authorization schema: type: string example: example_value - in: header name: X-GitHub-Api-Version schema: type: string default: '2022-11-28' example: example_value - in: header name: Accept schema: type: string default: application/vnd.github+json example: example_value responses: '204': description: Response '403': $ref: '#/components/responses/forbidden' '500': $ref: '#/components/responses/internal_error' x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: workflow-runs security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments: get: summary: GitHub Get Pending Deployments for Workflow Run description: |- Get all deployment environments for a workflow run that are waiting for protection rules to pass. Anyone with read access to the repository can use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - Deployments - Get - Pending - Runs - Workflows operationId: getPendingDeploymentsForWorkflowRun externalDocs: description: API method documentation url: |- https://docs.github.com/enterprise-server@3.9/rest/actions/workflow-runs#get-pending-deployments-for-a-workflow-run parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/run-id' - in: header name: Authorization schema: type: string example: example_value - in: header name: X-GitHub-Api-Version schema: type: string default: '2022-11-28' example: example_value - in: header name: Accept schema: type: string default: application/vnd.github+json example: example_value responses: '200': description: Response content: application/json: schema: type: array items: $ref: '#/components/schemas/pending-deployment' examples: default: $ref: '#/components/examples/pending-deployment-items' x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: workflow-runs security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK post: summary: GitHub Review Pending Deployments for Workflow Run description: |- Approve or reject pending deployments that are waiting on approval by a required reviewer. Required reviewers with read access to the repository contents and deployments can use this endpoint. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - Deployments - Pending - Reviews - Runs - Workflows operationId: reviewPendingDeploymentsForWorkflowRun externalDocs: description: API method documentation url: |- https://docs.github.com/enterprise-server@3.9/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/run-id' - in: header name: Authorization schema: type: string example: example_value - in: header name: X-GitHub-Api-Version schema: type: string default: '2022-11-28' example: example_value - in: header name: Accept schema: type: string default: application/vnd.github+json example: example_value requestBody: required: true content: application/json: schema: type: object properties: environment_ids: type: array description: The list of environment ids to approve or reject example: - 161171787 - 161171795 items: type: integer example: 161171787 state: type: string description: |- Whether to approve or reject deployment to the specified environments. enum: - approved - rejected example: approved comment: type: string description: comment to accompany the deployment review example: Ship it! required: - environment_ids - state - comment examples: default: value: environment_ids: - 161171787 state: approved comment: Ship it! responses: '200': description: Response content: application/json: schema: type: array items: $ref: '#/components/schemas/deployment' examples: default: $ref: '#/components/examples/deployment-items' x-github: githubCloudOnly: false enabledForGitHubApps: false category: actions subcategory: workflow-runs security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /repos/{owner}/{repo}/actions/runs/{run_id}/rerun: post: summary: GitHub Re-run Workflow description: |- Re-runs your workflow run using its `id`. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - Re-Run - Workflows operationId: rerunWorkflow externalDocs: description: API method documentation url: |- https://docs.github.com/enterprise-server@3.9/rest/actions/workflow-runs#re-run-a-workflow parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/run-id' - in: header name: Authorization schema: type: string example: example_value - in: header name: X-GitHub-Api-Version schema: type: string default: '2022-11-28' example: example_value - in: header name: Accept schema: type: string default: application/vnd.github+json example: example_value requestBody: required: false content: application/json: schema: type: object properties: enable_debug_logging: type: boolean default: false description: Whether to enable debug logging for the re-run. examples: default: value: {} responses: '201': description: Response content: application/json: schema: $ref: '#/components/schemas/empty-object' examples: default: value: {} x-github: githubCloudOnly: false enabledForGitHubApps: false category: actions subcategory: workflow-runs security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /repos/{owner}/{repo}/actions/runs/{run_id}/rerun-failed-jobs: post: summary: GitHub Re-run Failed Jobs from Workflow Run description: |- Re-run all of the failed jobs and their dependent jobs in a workflow run using the `id` of the workflow run. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - Failed - Jobs - Re-Run - Runs - Workflows operationId: rerunFailedJobsFromWorkflowRun externalDocs: description: API method documentation url: |- https://docs.github.com/enterprise-server@3.9/rest/actions/workflow-runs#re-run-failed-jobs-from-a-workflow-run parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/run-id' - in: header name: Authorization schema: type: string example: example_value - in: header name: X-GitHub-Api-Version schema: type: string default: '2022-11-28' example: example_value - in: header name: Accept schema: type: string default: application/vnd.github+json example: example_value requestBody: required: false content: application/json: schema: type: object properties: enable_debug_logging: type: boolean default: false description: Whether to enable debug logging for the re-run. examples: default: value: {} responses: '201': description: Response content: application/json: schema: $ref: '#/components/schemas/empty-object' examples: default: value: {} x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: workflow-runs security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /repos/{owner}/{repo}/actions/secrets: get: summary: GitHub List Repository Secrets description: |- Lists all secrets available in a repository without revealing their encrypted values. Authenticated users must have collaborator access to a repository to create, update, or read secrets. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - Lists - Repositories - Secrets operationId: listRepositorySecrets externalDocs: description: API method documentation url: |- https://docs.github.com/enterprise-server@3.9/rest/actions/secrets#list-repository-secrets parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/per-page' - $ref: '#/components/parameters/page' - in: header name: Authorization schema: type: string example: example_value - in: header name: X-GitHub-Api-Version schema: type: string default: '2022-11-28' example: example_value - in: header name: Accept schema: type: string default: application/vnd.github+json example: example_value responses: '200': description: Response content: application/json: schema: type: object required: - total_count - secrets properties: total_count: type: integer secrets: type: array items: $ref: '#/components/schemas/actions-secret' examples: default: $ref: '#/components/examples/actions-secret-paginated' headers: Link: $ref: '#/components/headers/link' x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: secrets x-api-evangelist-certified: '2025-07-16' x-api-naftiko-published: '2025-07-25' security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /repos/{owner}/{repo}/actions/secrets/public-key: get: summary: GitHub Get Repository Public Key description: |- Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - Get - Keys - Public - Repositories operationId: getRepositoryPublicKey externalDocs: description: API method documentation url: |- https://docs.github.com/enterprise-server@3.9/rest/actions/secrets#get-a-repository-public-key parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - in: header name: Authorization schema: type: string example: example_value - in: header name: X-GitHub-Api-Version schema: type: string default: '2022-11-28' example: example_value - in: header name: Accept schema: type: string default: application/vnd.github+json example: example_value responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/actions-public-key' examples: default: $ref: '#/components/examples/actions-public-key' x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: secrets x-api-evangelist-certified: '2025-07-16' x-api-naftiko-published: '2025-07-25' security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /repos/{owner}/{repo}/actions/secrets/{secret_name}: get: summary: GitHub Get Repository Secret description: |- Gets a single repository secret without revealing its encrypted value. The authenticated user must have collaborator access to the repository to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - Get - Repositories - Secrets operationId: getRepositorySecret externalDocs: description: API method documentation url: |- https://docs.github.com/enterprise-server@3.9/rest/actions/secrets#get-a-repository-secret parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/secret-name' - in: header name: Authorization schema: type: string example: example_value - in: header name: X-GitHub-Api-Version schema: type: string default: '2022-11-28' example: example_value - in: header name: Accept schema: type: string default: application/vnd.github+json example: example_value responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/actions-secret' examples: default: $ref: '#/components/examples/actions-secret' x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: secrets security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK put: summary: GitHub Create or Update Repository Secret description: |- Creates or updates a repository secret with an encrypted value. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/encrypting-secrets-for-the-rest-api)." Authenticated users must have collaborator access to a repository to create, update, or read secrets. OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - Create - Repositories - Secrets - Update operationId: createOrUpdateRepositorySecret externalDocs: description: API method documentation url: |- https://docs.github.com/enterprise-server@3.9/rest/actions/secrets#create-or-update-a-repository-secret parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/secret-name' - in: header name: Authorization schema: type: string example: example_value - in: header name: X-GitHub-Api-Version schema: type: string default: '2022-11-28' example: example_value - in: header name: Accept schema: type: string default: application/vnd.github+json example: example_value requestBody: required: true content: application/json: schema: type: object properties: encrypted_value: type: string description: |- Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get repository public key](https://docs.github.com/enterprise-server@3.9/rest/actions/secrets#get-a-repository-public-key) endpoint. pattern: |- ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$ key_id: type: string description: ID of the key you used to encrypt the secret. examples: default: value: encrypted_value: c2VjcmV0 key_id: '012345678912345678' responses: '201': description: Response when creating a secret content: application/json: schema: $ref: '#/components/schemas/empty-object' examples: default: value: {} '204': description: Response when updating a secret x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: secrets security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: summary: GitHub Delete Repository Secret description: |- Deletes a secret in a repository using the secret name. Authenticated users must have collaborator access to a repository to create, update, or read secrets. OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - Delete - Repositories - Secrets operationId: deleteRepositorySecret externalDocs: description: API method documentation url: |- https://docs.github.com/enterprise-server@3.9/rest/actions/secrets#delete-a-repository-secret parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/secret-name' - in: header name: Authorization schema: type: string example: example_value - in: header name: X-GitHub-Api-Version schema: type: string default: '2022-11-28' example: example_value - in: header name: Accept schema: type: string default: application/vnd.github+json example: example_value responses: '204': description: Response x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: secrets security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /repos/{owner}/{repo}/actions/variables: get: summary: GitHub List Repository Variables description: |- Lists all repository variables. Authenticated users must have collaborator access to a repository to create, update, or read variables. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - Lists - Repositories - Variables operationId: listRepositoryVariables externalDocs: description: API method documentation url: |- https://docs.github.com/enterprise-server@3.9/rest/actions/variables#list-repository-variables parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/variables-per-page' - $ref: '#/components/parameters/page' - in: header name: Authorization schema: type: string example: example_value - in: header name: X-GitHub-Api-Version schema: type: string default: '2022-11-28' example: example_value - in: header name: Accept schema: type: string default: application/vnd.github+json example: example_value responses: '200': description: Response content: application/json: schema: type: object required: - total_count - variables properties: total_count: type: integer variables: type: array items: $ref: '#/components/schemas/actions-variable' examples: default: $ref: '#/components/examples/actions-variables-paginated' headers: Link: $ref: '#/components/headers/link' x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: variables x-api-evangelist-certified: '2025-07-16' x-api-naftiko-published: '2025-07-25' security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK post: summary: GitHub Create Repository Variable description: |- Creates a repository variable that you can reference in a GitHub Actions workflow. Authenticated users must have collaborator access to a repository to create, update, or read variables. OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - Create - Repositories - Variables operationId: createRepositoryVariable externalDocs: description: API method documentation url: |- https://docs.github.com/enterprise-server@3.9/rest/actions/variables#create-a-repository-variable parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - in: header name: Authorization schema: type: string example: example_value - in: header name: X-GitHub-Api-Version schema: type: string default: '2022-11-28' example: example_value - in: header name: Accept schema: type: string default: application/vnd.github+json example: example_value requestBody: required: true content: application/json: schema: type: object properties: name: type: string description: The name of the variable. value: type: string description: The value of the variable. required: - name - value examples: default: value: name: USERNAME value: octocat responses: '201': description: Response content: application/json: schema: $ref: '#/components/schemas/empty-object' examples: default: value: {} x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: variables security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /repos/{owner}/{repo}/actions/variables/{name}: get: summary: GitHub Get Repository Variable description: |- Gets a specific variable in a repository. The authenticated user must have collaborator access to the repository to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - Get - Repositories - Variables operationId: getRepositoryVariable externalDocs: description: API method documentation url: |- https://docs.github.com/enterprise-server@3.9/rest/actions/variables#get-a-repository-variable parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/variable-name' - in: header name: Authorization schema: type: string example: example_value - in: header name: X-GitHub-Api-Version schema: type: string default: '2022-11-28' example: example_value - in: header name: Accept schema: type: string default: application/vnd.github+json example: example_value responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/actions-variable' examples: default: $ref: '#/components/examples/actions-variable' x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: variables security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK patch: summary: GitHub Update Repository Variable description: |- Updates a repository variable that you can reference in a GitHub Actions workflow. Authenticated users must have collaborator access to a repository to create, update, or read variables. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - Repositories - Update - Variables operationId: updateRepositoryVariable externalDocs: description: API method documentation url: |- https://docs.github.com/enterprise-server@3.9/rest/actions/variables#update-a-repository-variable parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/variable-name' - in: header name: Authorization schema: type: string example: example_value - in: header name: X-GitHub-Api-Version schema: type: string default: '2022-11-28' example: example_value - in: header name: Accept schema: type: string default: application/vnd.github+json example: example_value requestBody: required: true content: application/json: schema: type: object properties: name: type: string description: The name of the variable. value: type: string description: The value of the variable. examples: default: value: name: USERNAME value: octocat responses: '204': description: Response x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: variables security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: summary: GitHub Delete Repository Variable description: |- Deletes a repository variable using the variable name. Authenticated users must have collaborator access to a repository to create, update, or read variables. OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - Delete - Repositories - Variables operationId: deleteRepositoryVariable externalDocs: description: API method documentation url: |- https://docs.github.com/enterprise-server@3.9/rest/actions/variables#delete-a-repository-variable parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/variable-name' - in: header name: Authorization schema: type: string example: example_value - in: header name: X-GitHub-Api-Version schema: type: string default: '2022-11-28' example: example_value - in: header name: Accept schema: type: string default: application/vnd.github+json example: example_value responses: '204': description: Response x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: variables security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /repos/{owner}/{repo}/actions/workflows: get: summary: GitHub List Repository Workflows description: |- Lists the workflows in a repository. Anyone with read access to the repository can use this endpoint. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. tags: - Lists - Repositories - Workflows operationId: listRepositoryWorkflows externalDocs: description: API method documentation url: |- https://docs.github.com/enterprise-server@3.9/rest/actions/workflows#list-repository-workflows parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/per-page' - $ref: '#/components/parameters/page' - in: header name: Authorization schema: type: string example: example_value - in: header name: X-GitHub-Api-Version schema: type: string default: '2022-11-28' example: example_value - in: header name: Accept schema: type: string default: application/vnd.github+json example: example_value responses: '200': description: Response content: application/json: schema: type: object required: - total_count - workflows properties: total_count: type: integer workflows: type: array items: $ref: '#/components/schemas/workflow' examples: default: $ref: '#/components/examples/workflow-paginated' headers: Link: $ref: '#/components/headers/link' x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: workflows x-api-evangelist-certified: '2025-07-16' x-api-naftiko-published: '2025-07-25' security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /repos/{owner}/{repo}/actions/workflows/{workflow_id}: get: summary: GitHub Get Workflow description: |- Gets a specific workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. Anyone with read access to the repository can use this endpoint. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. tags: - Get - Workflows operationId: getWorkflow externalDocs: description: API method documentation url: |- https://docs.github.com/enterprise-server@3.9/rest/actions/workflows#get-a-workflow parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/workflow-id' - in: header name: Authorization schema: type: string example: example_value - in: header name: X-GitHub-Api-Version schema: type: string default: '2022-11-28' example: example_value - in: header name: Accept schema: type: string default: application/vnd.github+json example: example_value responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/workflow' examples: default: $ref: '#/components/examples/workflow' x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: workflows security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /repos/{owner}/{repo}/actions/workflows/{workflow_id}/disable: put: summary: GitHub Disable Workflow description: |- Disables a workflow and sets the `state` of the workflow to `disabled_manually`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - Disables - Workflows operationId: disableWorkflow externalDocs: description: API method documentation url: |- https://docs.github.com/enterprise-server@3.9/rest/actions/workflows#disable-a-workflow parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/workflow-id' - in: header name: Authorization schema: type: string example: example_value - in: header name: X-GitHub-Api-Version schema: type: string default: '2022-11-28' example: example_value - in: header name: Accept schema: type: string default: application/vnd.github+json example: example_value responses: '204': description: Response x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: workflows security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches: post: summary: GitHub Create Workflow Dispatch Event description: |- You can use this endpoint to manually trigger a GitHub Actions workflow run. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You must configure your GitHub Actions workflow to run when the [`workflow_dispatch` webhook](/developers/webhooks-and-events/webhook-events-and-payloads#workflow_dispatch) event occurs. The `inputs` are configured in the workflow file. For more information about how to configure the `workflow_dispatch` event in the workflow file, see "[Events that trigger workflows](/actions/reference/events-that-trigger-workflows#workflow_dispatch)." OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. operationId: createWorkflowDispatchEvent tags: - Create - Dispatch - Event - Workflows externalDocs: description: API method documentation url: |- https://docs.github.com/enterprise-server@3.9/rest/actions/workflows#create-a-workflow-dispatch-event parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/workflow-id' - in: header name: Authorization schema: type: string example: example_value - in: header name: X-GitHub-Api-Version schema: type: string default: '2022-11-28' example: example_value - in: header name: Accept schema: type: string default: application/vnd.github+json example: example_value responses: '204': description: Response requestBody: required: true content: application/json: schema: type: object properties: ref: type: string description: |- The git reference for the workflow. The reference can be a branch or tag name. inputs: type: object description: |- Input keys and values configured in the workflow file. The maximum number of properties is 10. Any default properties configured in the workflow file will be used when `inputs` are omitted. additionalProperties: true maxProperties: 10 required: - ref examples: default: value: ref: topic-branch inputs: name: Mona the Octocat home: San Francisco, CA x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: workflows security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /repos/{owner}/{repo}/actions/workflows/{workflow_id}/enable: put: summary: GitHub Enable Workflow description: |- Enables a workflow and sets the `state` of the workflow to `active`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - Enables - Workflows operationId: enableWorkflow externalDocs: description: API method documentation url: |- https://docs.github.com/enterprise-server@3.9/rest/actions/workflows#enable-a-workflow parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/workflow-id' - in: header name: Authorization schema: type: string example: example_value - in: header name: X-GitHub-Api-Version schema: type: string default: '2022-11-28' example: example_value - in: header name: Accept schema: type: string default: application/vnd.github+json example: example_value responses: '204': description: Response x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: workflows security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs: get: summary: GitHub List Workflow Runs for Workflow description: |- List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#parameters). Anyone with read access to the repository can use this endpoint OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. tags: - Lists - Runs - Workflows operationId: listWorkflowRunsForWorkflow externalDocs: description: API method documentation url: |- https://docs.github.com/enterprise-server@3.9/rest/actions/workflow-runs#list-workflow-runs-for-a-workflow parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/workflow-id' - $ref: '#/components/parameters/actor' - $ref: '#/components/parameters/workflow-run-branch' - $ref: '#/components/parameters/event' - $ref: '#/components/parameters/workflow-run-status' - $ref: '#/components/parameters/per-page' - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/created' - $ref: '#/components/parameters/exclude-pull-requests' - $ref: '#/components/parameters/workflow-run-check-suite-id' - $ref: '#/components/parameters/workflow-run-head-sha' - in: header name: Authorization schema: type: string example: example_value - in: header name: X-GitHub-Api-Version schema: type: string default: '2022-11-28' example: example_value - in: header name: Accept schema: type: string default: application/vnd.github+json example: example_value responses: '200': description: Response content: application/json: schema: type: object required: - total_count - workflow_runs properties: total_count: type: integer workflow_runs: type: array items: $ref: '#/components/schemas/workflow-run' examples: default: $ref: '#/components/examples/workflow-run-paginated' headers: Link: $ref: '#/components/headers/link' x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: workflow-runs security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK components: schemas: nullable-simple-user: title: Simple User description: GitHub user. type: object properties: name: type: string example: octocat email: type: string example: octocat@github.com login: type: string example: octocat id: type: integer format: int64 example: 1 node_id: type: string example: MDQ6VXNlcjE= avatar_url: type: string format: uri example: https://github.com/images/error/octocat_happy.gif gravatar_id: type: string example: 41d064eb2195891e12d0413f63227ea7 url: type: string format: uri example: https://api.github.com/users/octocat html_url: type: string format: uri example: https://github.com/octocat followers_url: type: string format: uri example: https://api.github.com/users/octocat/followers following_url: type: string example: https://api.github.com/users/octocat/following{/other_user} gists_url: type: string example: https://api.github.com/users/octocat/gists{/gist_id} starred_url: type: string example: https://api.github.com/users/octocat/starred{/owner}{/repo} subscriptions_url: type: string format: uri example: https://api.github.com/users/octocat/subscriptions organizations_url: type: string format: uri example: https://api.github.com/users/octocat/orgs repos_url: type: string format: uri example: https://api.github.com/users/octocat/repos events_url: type: string example: https://api.github.com/users/octocat/events{/privacy} received_events_url: type: string format: uri example: https://api.github.com/users/octocat/received_events type: type: string example: User site_admin: type: boolean example: true starred_at: type: string example: '"2020-07-09T00:17:55Z"' required: - avatar_url - events_url - followers_url - following_url - gists_url - gravatar_id - html_url - id - node_id - login - organizations_url - received_events_url - repos_url - site_admin - starred_url - subscriptions_url - type - url simple-user: title: Simple User description: GitHub user. type: object properties: name: type: string example: octocat email: type: string example: octocat@github.com login: type: string example: octocat id: type: integer format: int64 example: 1 node_id: type: string example: MDQ6VXNlcjE= avatar_url: type: string format: uri example: https://github.com/images/error/octocat_happy.gif gravatar_id: type: string example: 41d064eb2195891e12d0413f63227ea7 url: type: string format: uri example: https://api.github.com/users/octocat html_url: type: string format: uri example: https://github.com/octocat followers_url: type: string format: uri example: https://api.github.com/users/octocat/followers following_url: type: string example: https://api.github.com/users/octocat/following{/other_user} gists_url: type: string example: https://api.github.com/users/octocat/gists{/gist_id} starred_url: type: string example: https://api.github.com/users/octocat/starred{/owner}{/repo} subscriptions_url: type: string format: uri example: https://api.github.com/users/octocat/subscriptions organizations_url: type: string format: uri example: https://api.github.com/users/octocat/orgs repos_url: type: string format: uri example: https://api.github.com/users/octocat/repos events_url: type: string example: https://api.github.com/users/octocat/events{/privacy} received_events_url: type: string format: uri example: https://api.github.com/users/octocat/received_events type: type: string example: User site_admin: type: boolean example: true starred_at: type: string example: '"2020-07-09T00:17:55Z"' required: - avatar_url - events_url - followers_url - following_url - gists_url - gravatar_id - html_url - id - node_id - login - organizations_url - received_events_url - repos_url - site_admin - starred_url - subscriptions_url - type - url basic-error: title: Basic Error description: Basic Error type: object properties: message: type: string example: Example body text documentation_url: type: string example: https://api.github.com/repos/octocat/Hello-World url: type: string example: https://api.github.com/repos/octocat/Hello-World status: type: string example: open validation-error-simple: title: Validation Error Simple description: Validation Error Simple type: object required: - message - documentation_url properties: message: type: string example: Example body text documentation_url: type: string example: https://api.github.com/repos/octocat/Hello-World errors: type: array items: type: string scim-error: title: Scim Error description: Scim Error type: object properties: message: type: string example: Example body text documentation_url: type: string example: https://api.github.com/repos/octocat/Hello-World detail: type: string example: example_value status: type: integer example: 42 scimType: type: string example: User schemas: type: array items: type: string nullable-license-simple: title: License Simple description: License Simple type: object properties: key: type: string example: mit name: type: string example: MIT License url: type: string format: uri example: https://api.github.com/licenses/mit spdx_id: type: string example: MIT node_id: type: string example: MDc6TGljZW5zZW1pdA== html_url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World required: - key - name - url - spdx_id - node_id repository: title: Repository description: repository on GitHub. type: object properties: id: description: Unique identifier of the repository example: 42 type: integer format: int64 node_id: type: string example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 name: description: The name of the repository. type: string example: Team Environment full_name: type: string example: octocat/Hello-World license: $ref: '#/components/schemas/nullable-license-simple' forks: type: integer example: 42 permissions: type: object properties: admin: type: boolean pull: type: boolean triage: type: boolean push: type: boolean maintain: type: boolean required: - admin - pull - push owner: $ref: '#/components/schemas/simple-user' private: description: Whether the repository is private or public. default: false type: boolean example: true html_url: type: string format: uri example: https://github.com/octocat/Hello-World description: type: string example: This your first repo! fork: type: boolean example: true url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World archive_url: type: string example: |- http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} assignees_url: type: string example: http://api.github.com/repos/octocat/Hello-World/assignees{/user} blobs_url: type: string example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} branches_url: type: string example: http://api.github.com/repos/octocat/Hello-World/branches{/branch} collaborators_url: type: string example: |- http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} comments_url: type: string example: http://api.github.com/repos/octocat/Hello-World/comments{/number} commits_url: type: string example: http://api.github.com/repos/octocat/Hello-World/commits{/sha} compare_url: type: string example: |- http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} contents_url: type: string example: http://api.github.com/repos/octocat/Hello-World/contents/{+path} contributors_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/contributors deployments_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/deployments downloads_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/downloads events_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/events forks_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/forks git_commits_url: type: string example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} git_refs_url: type: string example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} git_tags_url: type: string example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} git_url: type: string example: git:github.com/octocat/Hello-World.git issue_comment_url: type: string example: |- http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} issue_events_url: type: string example: |- http://api.github.com/repos/octocat/Hello-World/issues/events{/number} issues_url: type: string example: http://api.github.com/repos/octocat/Hello-World/issues{/number} keys_url: type: string example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id} labels_url: type: string example: http://api.github.com/repos/octocat/Hello-World/labels{/name} languages_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/languages merges_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/merges milestones_url: type: string example: http://api.github.com/repos/octocat/Hello-World/milestones{/number} notifications_url: type: string example: |- http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} pulls_url: type: string example: http://api.github.com/repos/octocat/Hello-World/pulls{/number} releases_url: type: string example: http://api.github.com/repos/octocat/Hello-World/releases{/id} ssh_url: type: string example: git@github.com:octocat/Hello-World.git stargazers_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/stargazers statuses_url: type: string example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha} subscribers_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/subscribers subscription_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/subscription tags_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/tags teams_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/teams trees_url: type: string example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} clone_url: type: string example: https://github.com/octocat/Hello-World.git mirror_url: type: string format: uri example: git:git.example.com/octocat/Hello-World hooks_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/hooks svn_url: type: string format: uri example: https://svn.github.com/octocat/Hello-World homepage: type: string format: uri example: https://github.com language: type: string forks_count: type: integer example: 9 stargazers_count: type: integer example: 80 watchers_count: type: integer example: 80 size: description: |- The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0. type: integer example: 108 default_branch: description: The default branch of the repository. type: string example: master open_issues_count: type: integer example: 0 is_template: description: |- Whether this repository acts as a template that can be used to generate new repositories. default: false type: boolean example: true topics: type: array items: type: string has_issues: description: Whether issues are enabled. default: true type: boolean example: true has_projects: description: Whether projects are enabled. default: true type: boolean example: true has_wiki: description: Whether the wiki is enabled. default: true type: boolean example: true has_pages: type: boolean has_downloads: description: Whether downloads are enabled. default: true type: boolean example: true deprecated: true has_discussions: description: Whether discussions are enabled. default: false type: boolean example: true archived: description: Whether the repository is archived. default: false type: boolean disabled: type: boolean description: Returns whether or not this repository disabled. visibility: description: 'The repository visibility: public, private, or internal.' default: public type: string pushed_at: type: string format: date-time example: '2011-01-26T19:06:43Z' created_at: type: string format: date-time example: '2011-01-26T19:01:12Z' updated_at: type: string format: date-time example: '2011-01-26T19:14:43Z' allow_rebase_merge: description: Whether to allow rebase merges for pull requests. default: true type: boolean example: true temp_clone_token: type: string allow_squash_merge: description: Whether to allow squash merges for pull requests. default: true type: boolean example: true allow_auto_merge: description: Whether to allow Auto-merge to be used on pull requests. default: false type: boolean example: false delete_branch_on_merge: description: Whether to delete head branches when pull requests are merged default: false type: boolean example: false allow_update_branch: description: |- Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging. default: false type: boolean example: false use_squash_pr_title_as_default: type: boolean description: |- Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. default: false deprecated: true squash_merge_commit_title: type: string enum: - PR_TITLE - COMMIT_OR_PR_TITLE description: |- The default value for a squash merge commit title: - `PR_TITLE` - default to the pull request's title. - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). squash_merge_commit_message: type: string enum: - PR_BODY - COMMIT_MESSAGES - BLANK description: |- The default value for a squash merge commit message: - `PR_BODY` - default to the pull request's body. - `COMMIT_MESSAGES` - default to the branch's commit messages. - `BLANK` - default to a blank commit message. merge_commit_title: type: string enum: - PR_TITLE - MERGE_MESSAGE description: |- The default value for a merge commit title. - `PR_TITLE` - default to the pull request's title. - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). merge_commit_message: type: string enum: - PR_BODY - PR_TITLE - BLANK description: |- The default value for a merge commit message. - `PR_TITLE` - default to the pull request's title. - `PR_BODY` - default to the pull request's body. - `BLANK` - default to a blank commit message. allow_merge_commit: description: Whether to allow merge commits for pull requests. default: true type: boolean example: true allow_forking: description: Whether to allow forking this repo type: boolean web_commit_signoff_required: description: Whether to require contributors to sign off on web-based commits default: false type: boolean open_issues: type: integer watchers: type: integer master_branch: type: string starred_at: type: string example: '"2020-07-09T00:17:42Z"' anonymous_access_enabled: type: boolean description: Whether anonymous git access is enabled for this repository required: - archive_url - assignees_url - blobs_url - branches_url - collaborators_url - comments_url - commits_url - compare_url - contents_url - contributors_url - deployments_url - description - downloads_url - events_url - fork - forks_url - full_name - git_commits_url - git_refs_url - git_tags_url - hooks_url - html_url - id - node_id - issue_comment_url - issue_events_url - issues_url - keys_url - labels_url - languages_url - merges_url - milestones_url - name - notifications_url - owner - private - pulls_url - releases_url - stargazers_url - statuses_url - subscribers_url - subscription_url - tags_url - teams_url - trees_url - url - clone_url - default_branch - forks - forks_count - git_url - has_downloads - has_issues - has_projects - has_wiki - has_pages - homepage - language - archived - disabled - mirror_url - open_issues - open_issues_count - license - pushed_at - size - ssh_url - stargazers_count - svn_url - watchers - watchers_count - created_at - updated_at code-of-conduct: title: Code Of Conduct description: Code Of Conduct type: object properties: key: type: string example: contributor_covenant name: type: string example: Contributor Covenant url: type: string format: uri example: https://api.github.com/codes_of_conduct/contributor_covenant body: type: string example: | # Contributor Covenant Code of Conduct ## Our Pledge In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation. ## Our Standards Examples of behavior that contributes to creating a positive environment include: * Using welcoming and inclusive language * Being respectful of differing viewpoints and experiences * Gracefully accepting constructive criticism * Focusing on what is best for the community * Showing empathy towards other community members Examples of unacceptable behavior by participants include: * The use of sexualized language or imagery and unwelcome sexual attention or advances * Trolling, insulting/derogatory comments, and personal or political attacks * Public or private harassment * Publishing others' private information, such as a physical or electronic address, without explicit permission * Other conduct which could reasonably be considered inappropriate in a professional setting ## Our Responsibilities Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior. Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful. ## Scope This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers. ## Enforcement Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately. Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership. ## Attribution This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/). html_url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World required: - url - html_url - key - name allowed-actions: type: string description: |- The permissions policy that controls the actions that are allowed to run. enum: - all - local_only - selected selected-actions-url: type: string description: |- The API URL to use to get or set the actions that are allowed to run, when `allowed_actions` is set to `selected`. selected-actions: type: object properties: github_owned_allowed: type: boolean description: |- Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization. example: true patterns_allowed: type: array description: |- Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`. items: type: string required: - github_owned_allowed - patterns_allowed actions-default-workflow-permissions: type: string description: |- The default workflow permissions granted to the GITHUB_TOKEN when running workflows. enum: - read - write actions-can-approve-pull-request-reviews: type: boolean description: |- Whether GitHub Actions can approve pull requests. Enabling this can be a security risk. actions-get-default-workflow-permissions: type: object properties: default_workflow_permissions: $ref: '#/components/schemas/actions-default-workflow-permissions' can_approve_pull_request_reviews: $ref: '#/components/schemas/actions-can-approve-pull-request-reviews' required: - default_workflow_permissions - can_approve_pull_request_reviews actions-set-default-workflow-permissions: type: object properties: default_workflow_permissions: $ref: '#/components/schemas/actions-default-workflow-permissions' can_approve_pull_request_reviews: $ref: '#/components/schemas/actions-can-approve-pull-request-reviews' runner-label: title: Self hosted runner label description: label for a self hosted runner type: object properties: id: type: integer description: Unique identifier of the label. example: 42 name: type: string description: Name of the label. example: octocat type: type: string description: |- The type of label. Read-only labels are applied automatically when the runner is configured. enum: - read-only - custom example: read-only required: - name runner: title: Self hosted runners description: self hosted runner type: object properties: id: description: The id of the runner. type: integer example: 5 runner_group_id: description: The id of the runner group. type: integer example: 1 name: description: The name of the runner. type: string example: iMac os: description: The Operating System of the runner. type: string example: macos status: description: The status of the runner. type: string example: online busy: type: boolean example: true labels: type: array items: $ref: '#/components/schemas/runner-label' required: - id - name - os - status - busy - labels runner-application: title: Runner Application description: Runner Application type: object properties: os: type: string example: example_value architecture: type: string example: example_value download_url: type: string example: https://api.github.com/repos/octocat/Hello-World filename: type: string example: octocat temp_download_token: description: short lived bearer token used to download the runner, if needed. type: string example: example_value sha256_checksum: type: string example: abc123def456789012345678901234567890 required: - os - architecture - download_url - filename authentication-token: title: Authentication Token description: Authentication Token type: object properties: token: description: The token used for authentication type: string example: v1.1f699f1069f60xxx expires_at: description: The time this token expires type: string format: date-time example: '2016-07-11T22:14:10Z' permissions: type: object example: issues: read deployments: write repositories: description: The repositories this token has access to type: array items: $ref: '#/components/schemas/repository' single_file: type: string example: config.yaml repository_selection: description: |- Describe whether all repositories have been selected or there's a selection involved type: string enum: - all - selected example: all required: - token - expires_at nullable-integration: title: GitHub app description: |- GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. type: object properties: id: description: Unique identifier of the GitHub app example: 37 type: integer slug: description: The slug name of the GitHub app example: probot-owners type: string node_id: type: string example: MDExOkludGVncmF0aW9uMQ== owner: $ref: '#/components/schemas/nullable-simple-user' name: description: The name of the GitHub app example: Probot Owners type: string description: type: string example: The description of the app. external_url: type: string format: uri example: https://example.com html_url: type: string format: uri example: https://github.com/apps/super-ci created_at: type: string format: date-time example: '2017-07-08T16:18:44-04:00' updated_at: type: string format: date-time example: '2017-07-08T16:18:44-04:00' permissions: description: The set of permissions for the GitHub app type: object properties: issues: type: string checks: type: string metadata: type: string contents: type: string deployments: type: string additionalProperties: type: string example: issues: read deployments: write events: description: The list of events for the GitHub app example: - label - deployment type: array items: type: string installations_count: description: The number of installations associated with the GitHub app example: 5 type: integer client_id: type: string example: '"Iv1.25b5d1e65ffc4022"' client_secret: type: string example: '"1d4b2097ac622ba702d19de498f005747a8b21d3"' webhook_secret: type: string example: '"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b"' pem: type: string example: |- "-----BEGIN RSA PRIVATE KEY-----\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\n-----END RSA PRIVATE KEY-----\n" required: - id - node_id - owner - name - description - external_url - html_url - created_at - updated_at - permissions - events security-and-analysis: type: object properties: advanced_security: type: object properties: status: type: string enum: - enabled - disabled secret_scanning: type: object properties: status: type: string enum: - enabled - disabled secret_scanning_push_protection: type: object properties: status: type: string enum: - enabled - disabled minimal-repository: title: Minimal Repository description: Minimal Repository type: object properties: id: type: integer format: int64 example: 1296269 node_id: type: string example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 name: type: string example: Hello-World full_name: type: string example: octocat/Hello-World owner: $ref: '#/components/schemas/simple-user' private: type: boolean example: true html_url: type: string format: uri example: https://github.com/octocat/Hello-World description: type: string example: This your first repo! fork: type: boolean example: true url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World archive_url: type: string example: |- http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} assignees_url: type: string example: http://api.github.com/repos/octocat/Hello-World/assignees{/user} blobs_url: type: string example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} branches_url: type: string example: http://api.github.com/repos/octocat/Hello-World/branches{/branch} collaborators_url: type: string example: |- http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} comments_url: type: string example: http://api.github.com/repos/octocat/Hello-World/comments{/number} commits_url: type: string example: http://api.github.com/repos/octocat/Hello-World/commits{/sha} compare_url: type: string example: |- http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} contents_url: type: string example: http://api.github.com/repos/octocat/Hello-World/contents/{+path} contributors_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/contributors deployments_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/deployments downloads_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/downloads events_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/events forks_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/forks git_commits_url: type: string example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} git_refs_url: type: string example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} git_tags_url: type: string example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} git_url: type: string issue_comment_url: type: string example: |- http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} issue_events_url: type: string example: |- http://api.github.com/repos/octocat/Hello-World/issues/events{/number} issues_url: type: string example: http://api.github.com/repos/octocat/Hello-World/issues{/number} keys_url: type: string example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id} labels_url: type: string example: http://api.github.com/repos/octocat/Hello-World/labels{/name} languages_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/languages merges_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/merges milestones_url: type: string example: http://api.github.com/repos/octocat/Hello-World/milestones{/number} notifications_url: type: string example: |- http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} pulls_url: type: string example: http://api.github.com/repos/octocat/Hello-World/pulls{/number} releases_url: type: string example: http://api.github.com/repos/octocat/Hello-World/releases{/id} ssh_url: type: string stargazers_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/stargazers statuses_url: type: string example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha} subscribers_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/subscribers subscription_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/subscription tags_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/tags teams_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/teams trees_url: type: string example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} clone_url: type: string mirror_url: type: string hooks_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/hooks svn_url: type: string homepage: type: string language: type: string forks_count: type: integer stargazers_count: type: integer watchers_count: type: integer size: description: |- The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0. type: integer default_branch: type: string open_issues_count: type: integer is_template: type: boolean topics: type: array items: type: string has_issues: type: boolean has_projects: type: boolean has_wiki: type: boolean has_pages: type: boolean has_downloads: type: boolean has_discussions: type: boolean archived: type: boolean disabled: type: boolean visibility: type: string pushed_at: type: string format: date-time example: '2011-01-26T19:06:43Z' created_at: type: string format: date-time example: '2011-01-26T19:01:12Z' updated_at: type: string format: date-time example: '2011-01-26T19:14:43Z' permissions: type: object properties: admin: type: boolean maintain: type: boolean push: type: boolean triage: type: boolean pull: type: boolean role_name: type: string example: admin temp_clone_token: type: string delete_branch_on_merge: type: boolean subscribers_count: type: integer network_count: type: integer code_of_conduct: $ref: '#/components/schemas/code-of-conduct' license: type: object properties: key: type: string name: type: string spdx_id: type: string url: type: string node_id: type: string forks: type: integer example: 0 open_issues: type: integer example: 0 watchers: type: integer example: 0 allow_forking: type: boolean web_commit_signoff_required: type: boolean example: false security_and_analysis: $ref: '#/components/schemas/security-and-analysis' required: - archive_url - assignees_url - blobs_url - branches_url - collaborators_url - comments_url - commits_url - compare_url - contents_url - contributors_url - deployments_url - description - downloads_url - events_url - fork - forks_url - full_name - git_commits_url - git_refs_url - git_tags_url - hooks_url - html_url - id - node_id - issue_comment_url - issue_events_url - issues_url - keys_url - labels_url - languages_url - merges_url - milestones_url - name - notifications_url - owner - private - pulls_url - releases_url - stargazers_url - statuses_url - subscribers_url - subscription_url - tags_url - teams_url - trees_url - url actions-cache-usage-by-repository: title: Actions Cache Usage by repository description: GitHub Actions Cache Usage by repository. type: object properties: full_name: description: The repository owner and name for the cache usage being shown. type: string example: octo-org/Hello-World active_caches_size_in_bytes: description: |- The sum of the size in bytes of all the active cache items in the repository. type: integer example: 2322142 active_caches_count: description: The number of active caches in the repository. type: integer example: 3 required: - full_name - active_caches_size_in_bytes - active_caches_count empty-object: title: Empty Object description: An object without any properties. type: object additionalProperties: false actions-public-key: title: ActionsPublicKey description: The public key used for setting Actions Secrets. type: object properties: key_id: description: The identifier for the key. type: string example: '1234567' key: description: The Base64 encoded public key. type: string example: hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs= id: type: integer example: 2 url: type: string example: https://api.github.com/user/keys/2 title: type: string example: ssh-rsa AAAAB3NzaC1yc2EAAA created_at: type: string example: '2011-01-26T19:01:12Z' required: - key_id - key nullable-team-simple: title: Team Simple description: |- Groups of organization members that gives permissions on specified repositories. type: object properties: id: description: Unique identifier of the team type: integer example: 1 node_id: type: string example: MDQ6VGVhbTE= url: description: URL for the team type: string format: uri example: https://api.github.com/organizations/1/team/1 members_url: type: string example: https://api.github.com/organizations/1/team/1/members{/member} name: description: Name of the team type: string example: Justice League description: description: Description of the team type: string example: great team. permission: description: Permission that the team will have for its repositories type: string example: admin privacy: description: The level of privacy this team should have type: string example: closed html_url: type: string format: uri example: https://github.com/orgs/rails/teams/core repositories_url: type: string format: uri example: https://api.github.com/organizations/1/team/1/repos slug: type: string example: justice-league ldap_dn: description: Distinguished Name (DN) that team maps to within LDAP environment example: uid=example,ou=users,dc=github,dc=com type: string required: - id - node_id - url - members_url - name - description - permission - html_url - repositories_url - slug team: title: Team description: |- Groups of organization members that gives permissions on specified repositories. type: object properties: id: type: integer example: 42 node_id: type: string example: '12345678' name: type: string example: octocat slug: type: string example: example_value description: type: string example: This is an example repository privacy: type: string example: example_value permission: type: string example: example_value permissions: type: object properties: pull: type: boolean triage: type: boolean push: type: boolean maintain: type: boolean admin: type: boolean required: - pull - triage - push - maintain - admin url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World html_url: type: string format: uri example: https://github.com/orgs/rails/teams/core members_url: type: string example: https://api.github.com/repos/octocat/Hello-World repositories_url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World parent: $ref: '#/components/schemas/nullable-team-simple' required: - id - node_id - url - members_url - name - description - permission - html_url - repositories_url - slug - parent artifact: title: Artifact description: An artifact type: object properties: id: type: integer example: 5 node_id: type: string example: MDEwOkNoZWNrU3VpdGU1 name: description: The name of the artifact. type: string example: AdventureWorks.Framework size_in_bytes: description: The size in bytes of the artifact. type: integer example: 12345 url: type: string example: https://api.github.com/repos/github/hello-world/actions/artifacts/5 archive_download_url: type: string example: |- https://api.github.com/repos/github/hello-world/actions/artifacts/5/zip expired: description: Whether or not the artifact has expired. type: boolean example: true created_at: type: string format: date-time example: '2026-04-17T12:00:00Z' expires_at: type: string format: date-time example: '2026-04-17T12:00:00Z' updated_at: type: string format: date-time example: '2026-04-17T12:00:00Z' workflow_run: type: object properties: id: example: 10 type: integer repository_id: example: 42 type: integer head_repository_id: example: 42 type: integer head_branch: example: main type: string head_sha: example: 009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d type: string required: - id - node_id - name - size_in_bytes - url - archive_download_url - expired - created_at - expires_at - updated_at actions-cache-usage-policy-for-repository: title: Actions cache usage policy for repository description: GitHub Actions cache usage policy for repository. type: object properties: repo_cache_size_limit_in_gb: description: The size limit for the sum of all caches, in gigabytes. type: integer example: 14 required: - repo_cache_size_limit_in_gb actions-cache-list: title: Repository actions caches description: Repository actions caches type: object properties: total_count: description: Total number of caches type: integer example: 2 actions_caches: description: Array of caches type: array items: type: object properties: id: type: integer example: 2 ref: type: string example: refs/heads/main key: type: string example: Linux-node-958aff96db2d75d67787d1e634ae70b659de937b version: type: string example: |- 73885106f58cc52a7df9ec4d4a5622a5614813162cb516c759a30af6bf56e6f0 last_accessed_at: type: string format: date-time example: '2019-01-24T22:45:36.000Z' created_at: type: string format: date-time example: '2019-01-24T22:45:36.000Z' size_in_bytes: type: integer example: 1024 required: - total_count - actions_caches job: title: Job description: Information of a job execution in a workflow run type: object properties: id: description: The id of the job. example: 21 type: integer run_id: description: The id of the associated workflow run. example: 5 type: integer run_url: type: string example: https://api.github.com/repos/github/hello-world/actions/runs/5 run_attempt: type: integer description: |- Attempt number of the associated workflow run, 1 for first attempt and higher if the workflow was re-run. example: 1 node_id: type: string example: MDg6Q2hlY2tSdW40 head_sha: description: The SHA of the commit that is being run. example: 009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d type: string url: type: string example: https://api.github.com/repos/github/hello-world/actions/jobs/21 html_url: type: string example: https://github.com/github/hello-world/runs/4 status: description: The phase of the lifecycle that the job is currently in. example: queued type: string enum: - queued - in_progress - completed - waiting - requested - pending conclusion: description: The outcome of the job. example: success type: string enum: - success - failure - neutral - cancelled - skipped - timed_out - action_required created_at: description: The time that the job created, in ISO 8601 format. example: '2019-08-08T08:00:00-07:00' format: date-time type: string started_at: description: The time that the job started, in ISO 8601 format. example: '2019-08-08T08:00:00-07:00' format: date-time type: string completed_at: description: The time that the job finished, in ISO 8601 format. example: '2019-08-08T08:00:00-07:00' format: date-time type: string name: description: The name of the job. example: test-coverage type: string steps: description: Steps in this job. type: array items: type: object required: - name - status - conclusion - number properties: status: description: The phase of the lifecycle that the job is currently in. example: queued type: string enum: - queued - in_progress - completed conclusion: description: The outcome of the job. example: success type: string name: description: The name of the job. example: test-coverage type: string number: type: integer example: 1 started_at: description: The time that the step started, in ISO 8601 format. example: '2019-08-08T08:00:00-07:00' format: date-time type: string completed_at: description: The time that the job finished, in ISO 8601 format. example: '2019-08-08T08:00:00-07:00' format: date-time type: string check_run_url: type: string example: https://api.github.com/repos/github/hello-world/check-runs/4 labels: type: array items: type: string description: |- Labels for the workflow job. Specified by the "runs_on" attribute in the action's workflow file. example: - self-hosted - foo - bar runner_id: type: integer example: 1 description: |- The ID of the runner to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.) runner_name: type: string example: my runner description: |- The name of the runner to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.) runner_group_id: type: integer example: 2 description: |- The ID of the runner group to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.) runner_group_name: type: string example: my runner group description: |- The name of the runner group to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.) workflow_name: type: string description: The name of the workflow. example: Build head_branch: type: string description: The name of the current branch. example: main required: - id - node_id - run_id - run_url - head_sha - workflow_name - head_branch - name - url - html_url - status - conclusion - started_at - completed_at - check_run_url - labels - runner_id - runner_name - runner_group_id - runner_group_name - created_at oidc-custom-sub-repo: title: Actions OIDC subject customization for a repository description: Actions OIDC subject customization for a repository type: object properties: use_default: description: |- Whether to use the default template or not. If `true`, the `include_claim_keys` field is ignored. type: boolean example: true include_claim_keys: description: |- Array of unique strings. Each claim key can only contain alphanumeric characters and underscores. type: array items: type: string required: - use_default actions-secret: title: Actions Secret description: Set secrets for GitHub Actions. type: object properties: name: description: The name of the secret. example: SECRET_TOKEN type: string created_at: type: string format: date-time example: '2026-04-17T12:00:00Z' updated_at: type: string format: date-time example: '2026-04-17T12:00:00Z' required: - name - created_at - updated_at actions-variable: title: Actions Variable type: object properties: name: description: The name of the variable. example: USERNAME type: string value: description: The value of the variable. example: octocat type: string created_at: description: |- The date and time at which the variable was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. type: string format: date-time example: '2019-01-24T22:45:36.000Z' updated_at: description: |- The date and time at which the variable was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. type: string format: date-time example: '2019-01-24T22:45:36.000Z' required: - name - value - created_at - updated_at actions-enabled: type: boolean description: Whether GitHub Actions is enabled on the repository. actions-repository-permissions: type: object properties: enabled: $ref: '#/components/schemas/actions-enabled' allowed_actions: $ref: '#/components/schemas/allowed-actions' selected_actions_url: $ref: '#/components/schemas/selected-actions-url' required: - enabled actions-workflow-access-to-repository: type: object properties: access_level: type: string description: |- Defines the level of access that workflows outside of the repository have to actions and reusable workflows within the repository. `none` means the access is only possible from workflows in this repository. `user` level access allows sharing across user owned private repositories only. `organization` level access allows sharing across the organization. `enterprise` level access allows sharing across the enterprise. enum: - none - user - organization - enterprise example: none required: - access_level referenced-workflow: title: Referenced workflow description: workflow referenced/reused by the initial caller workflow type: object properties: path: type: string example: src/index.js sha: type: string example: abc123def456789012345678901234567890 ref: type: string example: main required: - path - sha pull-request-minimal: title: Pull Request Minimal type: object properties: id: type: integer format: int64 example: 42 number: type: integer example: 42 url: type: string example: https://api.github.com/repos/octocat/Hello-World head: type: object properties: ref: type: string sha: type: string repo: type: object properties: id: type: integer format: int64 url: type: string name: type: string required: - id - url - name required: - ref - sha - repo base: type: object properties: ref: type: string sha: type: string repo: type: object properties: id: type: integer format: int64 url: type: string name: type: string required: - id - url - name required: - ref - sha - repo required: - id - number - url - head - base nullable-simple-commit: title: Simple Commit description: commit. type: object properties: id: type: string description: SHA for the commit example: 7638417db6d59f3c431d3e1f261cc637155684cd tree_id: type: string description: SHA for the commit's tree example: '12345678' message: description: Message describing the purpose of the commit example: 'Fix #42' type: string timestamp: description: Timestamp of the commit example: '2014-08-09T08:02:04+12:00' format: date-time type: string author: type: object description: Information about the Git author properties: name: description: Name of the commit's author example: Monalisa Octocat type: string email: description: Git email address of the commit's author example: monalisa.octocat@example.com type: string format: email required: - name - email committer: type: object description: Information about the Git committer properties: name: description: Name of the commit's committer example: Monalisa Octocat type: string email: description: Git email address of the commit's committer example: monalisa.octocat@example.com type: string format: email required: - name - email required: - id - tree_id - message - timestamp - author - committer workflow-run: title: Workflow Run description: An invocation of a workflow type: object properties: id: type: integer description: The ID of the workflow run. example: 5 name: type: string description: The name of the workflow run. example: Build node_id: type: string example: MDEwOkNoZWNrU3VpdGU1 check_suite_id: type: integer description: The ID of the associated check suite. example: 42 check_suite_node_id: type: string description: The node ID of the associated check suite. example: MDEwOkNoZWNrU3VpdGU0Mg== head_branch: type: string example: master head_sha: description: |- The SHA of the head commit that points to the version of the workflow being run. example: 009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d type: string path: description: The full path of the workflow example: octocat/octo-repo/.github/workflows/ci.yml@main type: string run_number: type: integer description: The auto incrementing run number for the workflow run. example: 106 run_attempt: type: integer description: |- Attempt number of the run, 1 for first attempt and higher if the workflow was re-run. example: 1 referenced_workflows: type: array items: $ref: '#/components/schemas/referenced-workflow' event: type: string example: push status: type: string example: completed conclusion: type: string example: neutral workflow_id: type: integer description: The ID of the parent workflow. example: 5 url: type: string description: The URL to the workflow run. example: https://api.github.com/repos/github/hello-world/actions/runs/5 html_url: type: string example: https://github.com/github/hello-world/suites/4 pull_requests: description: |- Pull requests that are open with a `head_sha` or `head_branch` that matches the workflow run. The returned pull requests do not necessarily indicate pull requests that triggered the run. type: array items: $ref: '#/components/schemas/pull-request-minimal' created_at: type: string format: date-time example: '2026-04-17T12:00:00Z' updated_at: type: string format: date-time example: '2026-04-17T12:00:00Z' actor: $ref: '#/components/schemas/simple-user' triggering_actor: $ref: '#/components/schemas/simple-user' run_started_at: type: string format: date-time description: The start time of the latest run. Resets on re-run. jobs_url: description: The URL to the jobs for the workflow run. type: string example: https://api.github.com/repos/github/hello-world/actions/runs/5/jobs logs_url: description: The URL to download the logs for the workflow run. type: string example: https://api.github.com/repos/github/hello-world/actions/runs/5/logs check_suite_url: description: The URL to the associated check suite. type: string example: https://api.github.com/repos/github/hello-world/check-suites/12 artifacts_url: description: The URL to the artifacts for the workflow run. type: string example: |- https://api.github.com/repos/github/hello-world/actions/runs/5/rerun/artifacts cancel_url: description: The URL to cancel the workflow run. type: string example: |- https://api.github.com/repos/github/hello-world/actions/runs/5/cancel rerun_url: description: The URL to rerun the workflow run. type: string example: https://api.github.com/repos/github/hello-world/actions/runs/5/rerun previous_attempt_url: description: |- The URL to the previous attempted run of this workflow, if one exists. type: string example: |- https://api.github.com/repos/github/hello-world/actions/runs/5/attempts/3 workflow_url: description: The URL to the workflow. type: string example: |- https://api.github.com/repos/github/hello-world/actions/workflows/main.yaml head_commit: $ref: '#/components/schemas/nullable-simple-commit' repository: $ref: '#/components/schemas/minimal-repository' head_repository: $ref: '#/components/schemas/minimal-repository' head_repository_id: type: integer example: 5 display_title: type: string example: Simple Workflow description: |- The event-specific title associated with the run or the run-name if set, or the value of `run-name` if it is set in the workflow. required: - id - node_id - head_branch - run_number - display_title - event - status - conclusion - head_sha - path - workflow_id - url - html_url - created_at - updated_at - head_commit - head_repository - repository - jobs_url - logs_url - check_suite_url - cancel_url - rerun_url - artifacts_url - workflow_url - pull_requests environment-approvals: title: Environment Approval description: An entry in the reviews log for environment deployments type: object properties: environments: description: The list of environments that were approved or rejected type: array items: type: object properties: id: description: The id of the environment. example: 56780428 type: integer node_id: type: string example: MDExOkVudmlyb25tZW50NTY3ODA0Mjg= name: description: The name of the environment. example: staging type: string url: type: string example: |- https://api.github.com/repos/github/hello-world/environments/staging html_url: type: string example: |- https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging created_at: description: The time that the environment was created, in ISO 8601 format. example: '2020-11-23T22:00:40Z' format: date-time type: string updated_at: description: |- The time that the environment was last updated, in ISO 8601 format. example: '2020-11-23T22:00:40Z' format: date-time type: string state: description: |- Whether deployment to the environment(s) was approved or rejected or pending (with comments) enum: - approved - rejected - pending example: approved type: string user: $ref: '#/components/schemas/simple-user' comment: type: string description: The comment submitted with the deployment review example: Ship it! required: - environments - state - user - comment deployment-reviewer-type: type: string description: The type of reviewer. enum: - User - Team example: User pending-deployment: title: Pending Deployment description: Details of a deployment that is waiting for protection rules to pass type: object properties: environment: type: object properties: id: description: The id of the environment. type: integer format: int64 example: 56780428 node_id: type: string example: MDExOkVudmlyb25tZW50NTY3ODA0Mjg= name: description: The name of the environment. example: staging type: string url: type: string example: |- https://api.github.com/repos/github/hello-world/environments/staging html_url: type: string example: |- https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging wait_timer: type: integer description: The set duration of the wait timer example: 30 wait_timer_started_at: description: The time that the wait timer began. example: '2020-11-23T22:00:40Z' format: date-time type: string current_user_can_approve: description: Whether the currently authenticated user can approve the deployment type: boolean example: true reviewers: type: array description: |- The people or teams that may approve jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed. items: type: object properties: type: $ref: '#/components/schemas/deployment-reviewer-type' reviewer: anyOf: - $ref: '#/components/schemas/simple-user' - $ref: '#/components/schemas/team' required: - environment - wait_timer - wait_timer_started_at - current_user_can_approve - reviewers deployment: title: Deployment description: request for a specific ref(branch,sha,tag) to be deployed type: object properties: url: type: string format: uri example: https://api.github.com/repos/octocat/example/deployments/1 id: description: Unique identifier of the deployment type: integer format: int64 example: 42 node_id: type: string example: MDEwOkRlcGxveW1lbnQx sha: type: string example: a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d ref: description: The ref to deploy. This can be a branch, tag, or sha. example: topic-branch type: string task: description: Parameter to specify a task to execute example: deploy type: string payload: oneOf: - type: object additionalProperties: true - type: string example: example_value original_environment: type: string example: staging environment: description: Name for the target deployment environment. example: production type: string description: type: string example: Deploy request from hubot creator: $ref: '#/components/schemas/nullable-simple-user' created_at: type: string format: date-time example: '2012-07-20T01:19:13Z' updated_at: type: string format: date-time example: '2012-07-20T01:19:13Z' statuses_url: type: string format: uri example: https://api.github.com/repos/octocat/example/deployments/1/statuses repository_url: type: string format: uri example: https://api.github.com/repos/octocat/example transient_environment: description: |- Specifies if the given environment is will no longer exist at some point in the future. Default: false. example: true type: boolean production_environment: description: |- Specifies if the given environment is one that end-users directly interact with. Default: false. example: true type: boolean performed_via_github_app: $ref: '#/components/schemas/nullable-integration' required: - id - node_id - sha - ref - task - environment - creator - payload - description - statuses_url - repository_url - url - created_at - updated_at workflow: title: Workflow description: GitHub Actions workflow type: object properties: id: type: integer example: 5 node_id: type: string example: MDg6V29ya2Zsb3cxMg== name: type: string example: CI path: type: string example: ruby.yaml state: type: string example: active enum: - active - deleted - disabled_fork - disabled_inactivity - disabled_manually created_at: type: string format: date-time example: '2019-12-06T14:20:20.000Z' updated_at: type: string format: date-time example: '2019-12-06T14:20:20.000Z' url: type: string example: https://api.github.com/repos/actions/setup-ruby/workflows/5 html_url: type: string example: |- https://github.com/actions/setup-ruby/blob/master/.github/workflows/ruby.yaml badge_url: type: string example: https://github.com/actions/setup-ruby/workflows/CI/badge.svg deleted_at: type: string format: date-time example: '2019-12-06T14:20:20.000Z' required: - id - node_id - name - path - state - url - html_url - badge_url - created_at - updated_at examples: selected-actions: value: github_owned_allowed: true verified_allowed: false patterns_allowed: - monalisa/octocat@* - docker/* actions-default-workflow-permissions: summary: Give read-only permission, and allow approving PRs. value: default_workflow_permissions: read can_approve_pull_request_reviews: true runner-paginated: value: total_count: 2 runners: - id: 23 name: linux_runner os: linux status: online busy: true labels: - id: 5 name: self-hosted type: read-only - id: 7 name: X64 type: read-only - id: 11 name: Linux type: read-only - id: 24 name: mac_runner os: macos status: offline busy: false labels: - id: 5 name: self-hosted type: read-only - id: 7 name: X64 type: read-only - id: 20 name: macOS type: read-only - id: 21 name: no-gpu type: custom runner-application-items-airgap: value: - os: osx architecture: x64 download_url: |- https://github.com/actions/runner/releases/download/v2.277.1/actions-runner-osx-x64-2.277.1.tar.gz filename: actions-runner-osx-x64-2.277.1.tar.gz temp_download_token: |- eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6IkJmSjdCUXpLdXhjWDc4WnJ5NUxnUW53ZFRrMCJ9.eyJuYW1laWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJzY3AiOiJBY3Rpb25zUnVudGltZS5QYWNrYWdlRG93bmxvYWQiLCJJZGVudGl0eVR5cGVDbGFpbSI6IlN5c3RlbTpTZXJ2aWNlSWRlbnRpdHkiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9zaWQiOiJERERERERERC1ERERELUREREQtRERERC1EREREREREREREREQiLCJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL3ByaW1hcnlzaWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJhdWkiOiIwZTZkODAxYi02NzVlLTQ1YzAtOWM4NC1jYTkzNjdlZjc1NjciLCJzaWQiOiI4ZTE5MDliZC1kYzU1LTQ2MWYtOTk2Mi1hZTI0OTEzNzU4OWIiLCJpc3MiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJhdWQiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJuYmYiOjE2MTc5MDQxNzUsImV4cCI6MTYxNzkwODM3NX0.YNsRXL9pBuIfLVndnyVQOpru77Br8hgYIX7LPsOaMfKk4K88YG89a2VIXUWPyHRiOaC-4J0lIPei8ujezEtnMfNZCwHdWq0Niiy-2-ywcfGPmcz-RHz_ZglkPFbzKaiZWJcFKCGHCP0Ta3kdXumJQqiVJEIyppxIY-caR_Wsw2L4BZHOefJq-odsJ0guPgm9fVuU9FxVRkucho1UH_bzt0tAMl1gEWOLBLZ88U9LKCzHWaxheFeBV4DTt1lAcSm213gKP1eMbgAGn5heWhR4RMRBzZc2HO3Lf1syu4E8fW8a-esRAxEYPfqPHwN9LNj2jaU3D3nPwa8lHQLLtA1PNA sha256_checksum: f1fa173889dc9036cd529417e652e1729e5a3f4d35ec0151806d7480fda6b89b - os: linux architecture: x64 download_url: |- https://github.com/actions/runner/releases/download/v2.277.1/actions-runner-linux-x64-2.277.1.tar.gz filename: actions-runner-linux-x64-2.277.1.tar.gz temp_download_token: |- eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6IkJmSjdCUXpLdXhjWDc4WnJ5NUxnUW53ZFRrMCJ9.eyJuYW1laWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJzY3AiOiJBY3Rpb25zUnVudGltZS5QYWNrYWdlRG93bmxvYWQiLCJJZGVudGl0eVR5cGVDbGFpbSI6IlN5c3RlbTpTZXJ2aWNlSWRlbnRpdHkiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9zaWQiOiJERERERERERC1ERERELUREREQtRERERC1EREREREREREREREQiLCJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL3ByaW1hcnlzaWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJhdWkiOiIwZTZkODAxYi02NzVlLTQ1YzAtOWM4NC1jYTkzNjdlZjc1NjciLCJzaWQiOiI4ZTE5MDliZC1kYzU1LTQ2MWYtOTk2Mi1hZTI0OTEzNzU4OWIiLCJpc3MiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJhdWQiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJuYmYiOjE2MTc5MDQxNzUsImV4cCI6MTYxNzkwODM3NX0.YNsRXL9pBuIfLVndnyVQOpru77Br8hgYIX7LPsOaMfKk4K88YG89a2VIXUWPyHRiOaC-4J0lIPei8ujezEtnMfNZCwHdWq0Niiy-2-ywcfGPmcz-RHz_ZglkPFbzKaiZWJcFKCGHCP0Ta3kdXumJQqiVJEIyppxIY-caR_Wsw2L4BZHOefJq-odsJ0guPgm9fVuU9FxVRkucho1UH_bzt0tAMl1gEWOLBLZ88U9LKCzHWaxheFeBV4DTt1lAcSm213gKP1eMbgAGn5heWhR4RMRBzZc2HO3Lf1syu4E8fW8a-esRAxEYPfqPHwN9LNj2jaU3D3nPwa8lHQLLtA1PNA sha256_checksum: 02d710fc9e0008e641274bb7da7fde61f7c9aa1cbb541a2990d3450cc88f4e98 - os: linux architecture: arm download_url: |- https://github.com/actions/runner/releases/download/v2.277.1/actions-runner-linux-arm-2.277.1.tar.gz filename: actions-runner-linux-arm-2.277.1.tar.gz temp_download_token: |- eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6IkJmSjdCUXpLdXhjWDc4WnJ5NUxnUW53ZFRrMCJ9.eyJuYW1laWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJzY3AiOiJBY3Rpb25zUnVudGltZS5QYWNrYWdlRG93bmxvYWQiLCJJZGVudGl0eVR5cGVDbGFpbSI6IlN5c3RlbTpTZXJ2aWNlSWRlbnRpdHkiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9zaWQiOiJERERERERERC1ERERELUREREQtRERERC1EREREREREREREREQiLCJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL3ByaW1hcnlzaWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJhdWkiOiIyYTEzZDRmZC01ZDhkLTRjNzgtYjg2MS0zYTMxZGQ3MmYzNjQiLCJzaWQiOiI0MzZiNTg3YS04ODMyLTRiMTMtOWM2Ny05OWRkMjA2ZTQzNmMiLCJpc3MiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJhdWQiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJuYmYiOjE2MTc5MzE1NzEsImV4cCI6MTYxNzkzNTc3MX0.PMhU7-MOnZRDj5k5a4ieeFlQCmKPl2pQvpVRhGZq-9ByKF5s9G0rsnGBxDcolTYlbvEAmSSkeAEwF486F7P0kMVEb-GI14WbErqqMSyaPL81c3W7UHxMJLaSBnDs9ftHMv_IkJmRzaROS8q1ObzUW-ErlltxCdj2zF_5ruK9G2RR566AOAtiA3AHV6k7-FCY5--sDYJN_YXPgpwI0fPN1TM92fdPm93hJnoXuCJNpBYp1vl5W4gwGtU_Pa07ESdqqFN1YJJHUloedNhiIOczGfGVSapRc8vyGm9P_VCM_yKD8JI-MkOXl8JI5fCfhmjmKsw-vSAh9NW67RGvmehmpw sha256_checksum: 2f2bda21e2fd8fed6938b33182a293f6b1f74e4c5d09acd6d9a0fe3f979f5c85 - os: win architecture: x64 download_url: |- https://github.com/actions/runner/releases/download/v2.277.1/actions-runner-win-x64-2.277.1.zip filename: actions-runner-win-x64-2.277.1.zip temp_download_token: |- eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6IkJmSjdCUXpLdXhjWDc4WnJ5NUxnUW53ZFRrMCJ9.eyJuYW1laWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJzY3AiOiJBY3Rpb25zUnVudGltZS5QYWNrYWdlRG93bmxvYWQiLCJJZGVudGl0eVR5cGVDbGFpbSI6IlN5c3RlbTpTZXJ2aWNlSWRlbnRpdHkiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9zaWQiOiJERERERERERC1ERERELUREREQtRERERC1EREREREREREREREQiLCJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL3ByaW1hcnlzaWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJhdWkiOiIwZTZkODAxYi02NzVlLTQ1YzAtOWM4NC1jYTkzNjdlZjc1NjciLCJzaWQiOiI4ZTE5MDliZC1kYzU1LTQ2MWYtOTk2Mi1hZTI0OTEzNzU4OWIiLCJpc3MiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJhdWQiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJuYmYiOjE2MTc5MDQxNzUsImV4cCI6MTYxNzkwODM3NX0.YNsRXL9pBuIfLVndnyVQOpru77Br8hgYIX7LPsOaMfKk4K88YG89a2VIXUWPyHRiOaC-4J0lIPei8ujezEtnMfNZCwHdWq0Niiy-2-ywcfGPmcz-RHz_ZglkPFbzKaiZWJcFKCGHCP0Ta3kdXumJQqiVJEIyppxIY-caR_Wsw2L4BZHOefJq-odsJ0guPgm9fVuU9FxVRkucho1UH_bzt0tAMl1gEWOLBLZ88U9LKCzHWaxheFeBV4DTt1lAcSm213gKP1eMbgAGn5heWhR4RMRBzZc2HO3Lf1syu4E8fW8a-esRAxEYPfqPHwN9LNj2jaU3D3nPwa8lHQLLtA1PNA sha256_checksum: 7215c75a462eeb6a839fa8ed298d79f620617d44d47d37c583114fc3f3b27b30 - os: linux architecture: arm64 download_url: |- https://github.com/actions/runner/releases/download/v2.277.1/actions-runner-linux-arm64-2.277.1.tar.gz filename: actions-runner-linux-arm64-2.277.1.tar.gz temp_download_token: |- eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6IkJmSjdCUXpLdXhjWDc4WnJ5NUxnUW53ZFRrMCJ9.eyJuYW1laWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJzY3AiOiJBY3Rpb25zUnVudGltZS5QYWNrYWdlRG93bmxvYWQiLCJJZGVudGl0eVR5cGVDbGFpbSI6IlN5c3RlbTpTZXJ2aWNlSWRlbnRpdHkiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9zaWQiOiJERERERERERC1ERERELUREREQtRERERC1EREREREREREREREQiLCJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL3ByaW1hcnlzaWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJhdWkiOiIwZTZkODAxYi02NzVlLTQ1YzAtOWM4NC1jYTkzNjdlZjc1NjciLCJzaWQiOiI4ZTE5MDliZC1kYzU1LTQ2MWYtOTk2Mi1hZTI0OTEzNzU4OWIiLCJpc3MiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJhdWQiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJuYmYiOjE2MTc5MDQxNzUsImV4cCI6MTYxNzkwODM3NX0.YNsRXL9pBuIfLVndnyVQOpru77Br8hgYIX7LPsOaMfKk4K88YG89a2VIXUWPyHRiOaC-4J0lIPei8ujezEtnMfNZCwHdWq0Niiy-2-ywcfGPmcz-RHz_ZglkPFbzKaiZWJcFKCGHCP0Ta3kdXumJQqiVJEIyppxIY-caR_Wsw2L4BZHOefJq-odsJ0guPgm9fVuU9FxVRkucho1UH_bzt0tAMl1gEWOLBLZ88U9LKCzHWaxheFeBV4DTt1lAcSm213gKP1eMbgAGn5heWhR4RMRBzZc2HO3Lf1syu4E8fW8a-esRAxEYPfqPHwN9LNj2jaU3D3nPwa8lHQLLtA1PNA sha256_checksum: a6aa6dd0ba217118ef2b4ea24e9e0a85b02b13c38052a5de0776d6ced3a79c64 authentication-token: value: token: LLBF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-22T12:13:35.123-08:00' authentication-token-2: value: token: AABF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-29T12:13:35.123-08:00' runner: value: id: 23 name: MBP os: macos status: online busy: true labels: - id: 5 name: self-hosted type: read-only - id: 7 name: X64 type: read-only - id: 20 name: macOS type: read-only - id: 21 name: no-gpu type: custom runner-labels: value: total_count: 4 labels: - id: 5 name: self-hosted type: read-only - id: 7 name: X64 type: read-only - id: 20 name: macOS type: read-only - id: 21 name: no-gpu type: custom runner-labels-readonly: value: total_count: 3 labels: - id: 5 name: self-hosted type: read-only - id: 7 name: X64 type: read-only - id: 20 name: macOS type: read-only actions-public-key: value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 artifact-paginated: value: total_count: 2 artifacts: - id: 11 node_id: MDg6QXJ0aWZhY3QxMQ== name: Rails size_in_bytes: 556 url: |- https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11 archive_download_url: |- https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11/zip expired: false created_at: '2020-01-10T14:59:22Z' expires_at: '2020-03-21T14:59:22Z' updated_at: '2020-02-21T14:59:22Z' workflow_run: id: 2332938 repository_id: 1296269 head_repository_id: 1296269 head_branch: main head_sha: 328faa0536e6fef19753d9d91dc96a9931694ce3 - id: 13 node_id: MDg6QXJ0aWZhY3QxMw== name: Test output size_in_bytes: 453 url: |- https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/13 archive_download_url: |- https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/13/zip expired: false created_at: '2020-01-10T14:59:22Z' expires_at: '2020-03-21T14:59:22Z' updated_at: '2020-02-21T14:59:22Z' workflow_run: id: 2332942 repository_id: 1296269 head_repository_id: 1296269 head_branch: main head_sha: 178f4f6090b3fccad4a65b3e83d076a622d59652 artifact: value: id: 11 node_id: MDg6QXJ0aWZhY3QxMQ== name: Rails size_in_bytes: 556 url: https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11 archive_download_url: |- https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11/zip expired: false created_at: '2020-01-10T14:59:22Z' expires_at: '2020-01-21T14:59:22Z' updated_at: '2020-01-21T14:59:22Z' workflow_run: id: 2332938 repository_id: 1296269 head_repository_id: 1296269 head_branch: main head_sha: 328faa0536e6fef19753d9d91dc96a9931694ce3 actions-cache-usage: value: full_name: octo-org/Hello-World active_caches_size_in_bytes: 2322142 active_caches_count: 3 actions-cache-usage-policy: value: repo_cache_size_limit_in_gb: 14 actions-cache-list: value: total_count: 1 actions_caches: - id: 505 ref: refs/heads/main key: Linux-node-958aff96db2d75d67787d1e634ae70b659de937b version: 73885106f58cc52a7df9ec4d4a5622a5614813162cb516c759a30af6bf56e6f0 last_accessed_at: '2019-01-24T22:45:36.000Z' created_at: '2019-01-24T22:45:36.000Z' size_in_bytes: 1024 job: value: id: 399444496 run_id: 29679449 run_url: https://api.github.com/repos/octo-org/octo-repo/actions/runs/29679449 node_id: MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng== head_sha: f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0 url: https://api.github.com/repos/octo-org/octo-repo/actions/jobs/399444496 html_url: https://github.com/octo-org/octo-repo/runs/29679449/jobs/399444496 status: completed conclusion: success started_at: '2020-01-20T17:42:40Z' completed_at: '2020-01-20T17:44:39Z' created_at: '2020-01-20T17:44:39Z' name: build steps: - name: Set up job status: completed conclusion: success number: 1 started_at: '2020-01-20T09:42:40.000-08:00' completed_at: '2020-01-20T09:42:41.000-08:00' - name: Run actions/checkout@v2 status: completed conclusion: success number: 2 started_at: '2020-01-20T09:42:41.000-08:00' completed_at: '2020-01-20T09:42:45.000-08:00' - name: Set up Ruby status: completed conclusion: success number: 3 started_at: '2020-01-20T09:42:45.000-08:00' completed_at: '2020-01-20T09:42:45.000-08:00' - name: Run actions/cache@v3 status: completed conclusion: success number: 4 started_at: '2020-01-20T09:42:45.000-08:00' completed_at: '2020-01-20T09:42:48.000-08:00' - name: Install Bundler status: completed conclusion: success number: 5 started_at: '2020-01-20T09:42:48.000-08:00' completed_at: '2020-01-20T09:42:52.000-08:00' - name: Install Gems status: completed conclusion: success number: 6 started_at: '2020-01-20T09:42:52.000-08:00' completed_at: '2020-01-20T09:42:53.000-08:00' - name: Run Tests status: completed conclusion: success number: 7 started_at: '2020-01-20T09:42:53.000-08:00' completed_at: '2020-01-20T09:42:59.000-08:00' - name: Deploy to Heroku status: completed conclusion: success number: 8 started_at: '2020-01-20T09:42:59.000-08:00' completed_at: '2020-01-20T09:44:39.000-08:00' - name: Post actions/cache@v3 status: completed conclusion: success number: 16 started_at: '2020-01-20T09:44:39.000-08:00' completed_at: '2020-01-20T09:44:39.000-08:00' - name: Complete job status: completed conclusion: success number: 17 started_at: '2020-01-20T09:44:39.000-08:00' completed_at: '2020-01-20T09:44:39.000-08:00' check_run_url: https://api.github.com/repos/octo-org/octo-repo/check-runs/399444496 labels: - self-hosted - foo - bar runner_id: 1 runner_name: my runner runner_group_id: 2 runner_group_name: my runner group workflow_name: CI head_branch: main oidc-custom-sub-repo: value: use_default: false include_claim_keys: - repo - context actions-secret-paginated: value: total_count: 2 secrets: - name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' updated_at: '2020-01-10T14:59:22Z' - name: GIST_ID created_at: '2020-01-10T10:59:22Z' updated_at: '2020-01-11T11:59:22Z' actions-variables-paginated: value: total_count: 2 variables: - name: USERNAME value: octocat created_at: '2019-08-10T14:59:22Z' updated_at: '2020-01-10T14:59:22Z' - name: EMAIL value: octocat@github.com created_at: '2020-01-10T10:59:22Z' updated_at: '2020-01-11T11:59:22Z' actions-repository-permissions: value: enabled: true allowed_actions: selected selected_actions_url: |- https://api.github.com/repositories/42/actions/permissions/selected-actions actions-workflow-access-to-repository: value: access_level: organization workflow-run-paginated: value: total_count: 1 workflow_runs: - id: 30433642 name: Build node_id: MDEyOldvcmtmbG93IFJ1bjI2OTI4OQ== check_suite_id: 42 check_suite_node_id: MDEwOkNoZWNrU3VpdGU0Mg== head_branch: master head_sha: acb5820ced9479c074f688cc328bf03f341a511d path: .github/workflows/build.yml@main run_number: 562 event: push display_title: Update README.md status: queued conclusion: success workflow_id: 159038 url: |- https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642 html_url: https://github.com/octo-org/octo-repo/actions/runs/30433642 pull_requests: [] created_at: '2020-01-22T19:33:08Z' updated_at: '2020-01-22T19:33:08Z' actor: login: octocat id: 1 node_id: MDQ6VXNlcjE= avatar_url: https://github.com/images/error/octocat_happy.gif gravatar_id: '' url: https://api.github.com/users/octocat html_url: https://github.com/octocat followers_url: https://api.github.com/users/octocat/followers following_url: https://api.github.com/users/octocat/following{/other_user} gists_url: https://api.github.com/users/octocat/gists{/gist_id} starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} subscriptions_url: https://api.github.com/users/octocat/subscriptions organizations_url: https://api.github.com/users/octocat/orgs repos_url: https://api.github.com/users/octocat/repos events_url: https://api.github.com/users/octocat/events{/privacy} received_events_url: https://api.github.com/users/octocat/received_events type: User site_admin: false run_attempt: 1 run_started_at: '2020-01-22T19:33:08Z' triggering_actor: login: octocat id: 1 node_id: MDQ6VXNlcjE= avatar_url: https://github.com/images/error/octocat_happy.gif gravatar_id: '' url: https://api.github.com/users/octocat html_url: https://github.com/octocat followers_url: https://api.github.com/users/octocat/followers following_url: https://api.github.com/users/octocat/following{/other_user} gists_url: https://api.github.com/users/octocat/gists{/gist_id} starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} subscriptions_url: https://api.github.com/users/octocat/subscriptions organizations_url: https://api.github.com/users/octocat/orgs repos_url: https://api.github.com/users/octocat/repos events_url: https://api.github.com/users/octocat/events{/privacy} received_events_url: https://api.github.com/users/octocat/received_events type: User site_admin: false jobs_url: |- https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/jobs logs_url: |- https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/logs check_suite_url: |- https://api.github.com/repos/octo-org/octo-repo/check-suites/414944374 artifacts_url: |- https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/artifacts cancel_url: |- https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/cancel rerun_url: |- https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/rerun workflow_url: |- https://api.github.com/repos/octo-org/octo-repo/actions/workflows/159038 head_commit: id: acb5820ced9479c074f688cc328bf03f341a511d tree_id: d23f6eedb1e1b9610bbc754ddb5197bfe7271223 message: Create linter.yaml timestamp: '2020-01-22T19:33:05Z' author: name: Octo Cat email: octocat@github.com committer: name: GitHub email: noreply@github.com repository: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 name: Hello-World full_name: octocat/Hello-World owner: login: octocat id: 1 node_id: MDQ6VXNlcjE= avatar_url: https://github.com/images/error/octocat_happy.gif gravatar_id: '' url: https://api.github.com/users/octocat html_url: https://github.com/octocat followers_url: https://api.github.com/users/octocat/followers following_url: https://api.github.com/users/octocat/following{/other_user} gists_url: https://api.github.com/users/octocat/gists{/gist_id} starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} subscriptions_url: https://api.github.com/users/octocat/subscriptions organizations_url: https://api.github.com/users/octocat/orgs repos_url: https://api.github.com/users/octocat/repos events_url: https://api.github.com/users/octocat/events{/privacy} received_events_url: https://api.github.com/users/octocat/received_events type: User site_admin: false private: false html_url: https://github.com/octocat/Hello-World description: This your first repo! fork: false url: https://api.github.com/repos/octocat/Hello-World archive_url: |- https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} assignees_url: |- https://api.github.com/repos/octocat/Hello-World/assignees{/user} blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} branches_url: |- https://api.github.com/repos/octocat/Hello-World/branches{/branch} collaborators_url: |- https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} comments_url: |- https://api.github.com/repos/octocat/Hello-World/comments{/number} commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} compare_url: |- https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} contents_url: |- https://api.github.com/repos/octocat/Hello-World/contents/{+path} contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads events_url: https://api.github.com/repos/octocat/Hello-World/events forks_url: https://api.github.com/repos/octocat/Hello-World/forks git_commits_url: |- https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} git_url: git:github.com/octocat/Hello-World.git issue_comment_url: |- https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} issue_events_url: |- https://api.github.com/repos/octocat/Hello-World/issues/events{/number} issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} languages_url: https://api.github.com/repos/octocat/Hello-World/languages merges_url: https://api.github.com/repos/octocat/Hello-World/merges milestones_url: |- https://api.github.com/repos/octocat/Hello-World/milestones{/number} notifications_url: |- https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} ssh_url: git@github.com:octocat/Hello-World.git stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription tags_url: https://api.github.com/repos/octocat/Hello-World/tags teams_url: https://api.github.com/repos/octocat/Hello-World/teams trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} hooks_url: http://api.github.com/repos/octocat/Hello-World/hooks head_repository: id: 217723378 node_id: MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg= name: octo-repo full_name: octo-org/octo-repo private: true owner: login: octocat id: 1 node_id: MDQ6VXNlcjE= avatar_url: https://github.com/images/error/octocat_happy.gif gravatar_id: '' url: https://api.github.com/users/octocat html_url: https://github.com/octocat followers_url: https://api.github.com/users/octocat/followers following_url: https://api.github.com/users/octocat/following{/other_user} gists_url: https://api.github.com/users/octocat/gists{/gist_id} starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} subscriptions_url: https://api.github.com/users/octocat/subscriptions organizations_url: https://api.github.com/users/octocat/orgs repos_url: https://api.github.com/users/octocat/repos events_url: https://api.github.com/users/octocat/events{/privacy} received_events_url: https://api.github.com/users/octocat/received_events type: User site_admin: false html_url: https://github.com/octo-org/octo-repo description: '' fork: false url: https://api.github.com/repos/octo-org/octo-repo forks_url: https://api.github.com/repos/octo-org/octo-repo/forks keys_url: https://api.github.com/repos/octo-org/octo-repo/keys{/key_id} collaborators_url: |- https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator} teams_url: https://api.github.com/repos/octo-org/octo-repo/teams hooks_url: https://api.github.com/repos/octo-org/octo-repo/hooks issue_events_url: |- https://api.github.com/repos/octo-org/octo-repo/issues/events{/number} events_url: https://api.github.com/repos/octo-org/octo-repo/events assignees_url: https://api.github.com/repos/octo-org/octo-repo/assignees{/user} branches_url: |- https://api.github.com/repos/octo-org/octo-repo/branches{/branch} tags_url: https://api.github.com/repos/octo-org/octo-repo/tags blobs_url: https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha} git_tags_url: https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha} git_refs_url: https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha} trees_url: https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha} statuses_url: https://api.github.com/repos/octo-org/octo-repo/statuses/{sha} languages_url: https://api.github.com/repos/octo-org/octo-repo/languages stargazers_url: https://api.github.com/repos/octo-org/octo-repo/stargazers contributors_url: https://api.github.com/repos/octo-org/octo-repo/contributors subscribers_url: https://api.github.com/repos/octo-org/octo-repo/subscribers subscription_url: https://api.github.com/repos/octo-org/octo-repo/subscription commits_url: https://api.github.com/repos/octo-org/octo-repo/commits{/sha} git_commits_url: |- https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha} comments_url: |- https://api.github.com/repos/octo-org/octo-repo/comments{/number} issue_comment_url: |- https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number} contents_url: https://api.github.com/repos/octo-org/octo-repo/contents/{+path} compare_url: |- https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head} merges_url: https://api.github.com/repos/octo-org/octo-repo/merges archive_url: |- https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref} downloads_url: https://api.github.com/repos/octo-org/octo-repo/downloads issues_url: https://api.github.com/repos/octo-org/octo-repo/issues{/number} pulls_url: https://api.github.com/repos/octo-org/octo-repo/pulls{/number} milestones_url: |- https://api.github.com/repos/octo-org/octo-repo/milestones{/number} notifications_url: |- https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating} labels_url: https://api.github.com/repos/octo-org/octo-repo/labels{/name} releases_url: https://api.github.com/repos/octo-org/octo-repo/releases{/id} deployments_url: https://api.github.com/repos/octo-org/octo-repo/deployments workflow-run: value: id: 30433642 name: Build node_id: MDEyOldvcmtmbG93IFJ1bjI2OTI4OQ== check_suite_id: 42 check_suite_node_id: MDEwOkNoZWNrU3VpdGU0Mg== head_branch: main head_sha: acb5820ced9479c074f688cc328bf03f341a511d path: .github/workflows/build.yml@main run_number: 562 event: push display_title: Update README.md status: queued conclusion: success workflow_id: 159038 url: https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642 html_url: https://github.com/octo-org/octo-repo/actions/runs/30433642 pull_requests: [] created_at: '2020-01-22T19:33:08Z' updated_at: '2020-01-22T19:33:08Z' actor: login: octocat id: 1 node_id: MDQ6VXNlcjE= avatar_url: https://github.com/images/error/octocat_happy.gif gravatar_id: '' url: https://api.github.com/users/octocat html_url: https://github.com/octocat followers_url: https://api.github.com/users/octocat/followers following_url: https://api.github.com/users/octocat/following{/other_user} gists_url: https://api.github.com/users/octocat/gists{/gist_id} starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} subscriptions_url: https://api.github.com/users/octocat/subscriptions organizations_url: https://api.github.com/users/octocat/orgs repos_url: https://api.github.com/users/octocat/repos events_url: https://api.github.com/users/octocat/events{/privacy} received_events_url: https://api.github.com/users/octocat/received_events type: User site_admin: false run_attempt: 1 referenced_workflows: - path: octocat/Hello-World/.github/workflows/deploy.yml@main sha: 86e8bc9ecf7d38b1ed2d2cfb8eb87ba9b35b01db ref: refs/heads/main - path: octo-org/octo-repo/.github/workflows/report.yml@v2 sha: 79e9790903e1c3373b1a3e3a941d57405478a232 ref: refs/tags/v2 - path: |- octo-org/octo-repo/.github/workflows/secure.yml@1595d4b6de6a9e9751fb270a41019ce507d4099e sha: 1595d4b6de6a9e9751fb270a41019ce507d4099e run_started_at: '2020-01-22T19:33:08Z' triggering_actor: login: octocat id: 1 node_id: MDQ6VXNlcjE= avatar_url: https://github.com/images/error/octocat_happy.gif gravatar_id: '' url: https://api.github.com/users/octocat html_url: https://github.com/octocat followers_url: https://api.github.com/users/octocat/followers following_url: https://api.github.com/users/octocat/following{/other_user} gists_url: https://api.github.com/users/octocat/gists{/gist_id} starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} subscriptions_url: https://api.github.com/users/octocat/subscriptions organizations_url: https://api.github.com/users/octocat/orgs repos_url: https://api.github.com/users/octocat/repos events_url: https://api.github.com/users/octocat/events{/privacy} received_events_url: https://api.github.com/users/octocat/received_events type: User site_admin: false jobs_url: |- https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/jobs logs_url: |- https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/logs check_suite_url: https://api.github.com/repos/octo-org/octo-repo/check-suites/414944374 artifacts_url: |- https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/artifacts cancel_url: |- https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/cancel rerun_url: |- https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/rerun previous_attempt_url: |- https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/attempts/1 workflow_url: |- https://api.github.com/repos/octo-org/octo-repo/actions/workflows/159038 head_commit: id: acb5820ced9479c074f688cc328bf03f341a511d tree_id: d23f6eedb1e1b9610bbc754ddb5197bfe7271223 message: Create linter.yaml timestamp: '2020-01-22T19:33:05Z' author: name: Octo Cat email: octocat@github.com committer: name: GitHub email: noreply@github.com repository: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 name: Hello-World full_name: octocat/Hello-World owner: login: octocat id: 1 node_id: MDQ6VXNlcjE= avatar_url: https://github.com/images/error/octocat_happy.gif gravatar_id: '' url: https://api.github.com/users/octocat html_url: https://github.com/octocat followers_url: https://api.github.com/users/octocat/followers following_url: https://api.github.com/users/octocat/following{/other_user} gists_url: https://api.github.com/users/octocat/gists{/gist_id} starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} subscriptions_url: https://api.github.com/users/octocat/subscriptions organizations_url: https://api.github.com/users/octocat/orgs repos_url: https://api.github.com/users/octocat/repos events_url: https://api.github.com/users/octocat/events{/privacy} received_events_url: https://api.github.com/users/octocat/received_events type: User site_admin: false private: false html_url: https://github.com/octocat/Hello-World description: This your first repo! fork: false url: https://api.github.com/repos/octocat/Hello-World archive_url: |- https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} collaborators_url: |- https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} compare_url: |- https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads events_url: https://api.github.com/repos/octocat/Hello-World/events forks_url: https://api.github.com/repos/octocat/Hello-World/forks git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} git_url: git:github.com/octocat/Hello-World.git issue_comment_url: |- https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} issue_events_url: |- https://api.github.com/repos/octocat/Hello-World/issues/events{/number} issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} languages_url: https://api.github.com/repos/octocat/Hello-World/languages merges_url: https://api.github.com/repos/octocat/Hello-World/merges milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} notifications_url: |- https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} ssh_url: git@github.com:octocat/Hello-World.git stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription tags_url: https://api.github.com/repos/octocat/Hello-World/tags teams_url: https://api.github.com/repos/octocat/Hello-World/teams trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} hooks_url: http://api.github.com/repos/octocat/Hello-World/hooks head_repository: id: 217723378 node_id: MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg= name: octo-repo full_name: octo-org/octo-repo private: true owner: login: octocat id: 1 node_id: MDQ6VXNlcjE= avatar_url: https://github.com/images/error/octocat_happy.gif gravatar_id: '' url: https://api.github.com/users/octocat html_url: https://github.com/octocat followers_url: https://api.github.com/users/octocat/followers following_url: https://api.github.com/users/octocat/following{/other_user} gists_url: https://api.github.com/users/octocat/gists{/gist_id} starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} subscriptions_url: https://api.github.com/users/octocat/subscriptions organizations_url: https://api.github.com/users/octocat/orgs repos_url: https://api.github.com/users/octocat/repos events_url: https://api.github.com/users/octocat/events{/privacy} received_events_url: https://api.github.com/users/octocat/received_events type: User site_admin: false html_url: https://github.com/octo-org/octo-repo description: '' fork: false url: https://api.github.com/repos/octo-org/octo-repo forks_url: https://api.github.com/repos/octo-org/octo-repo/forks keys_url: https://api.github.com/repos/octo-org/octo-repo/keys{/key_id} collaborators_url: |- https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator} teams_url: https://api.github.com/repos/octo-org/octo-repo/teams hooks_url: https://api.github.com/repos/octo-org/octo-repo/hooks issue_events_url: |- https://api.github.com/repos/octo-org/octo-repo/issues/events{/number} events_url: https://api.github.com/repos/octo-org/octo-repo/events assignees_url: https://api.github.com/repos/octo-org/octo-repo/assignees{/user} branches_url: https://api.github.com/repos/octo-org/octo-repo/branches{/branch} tags_url: https://api.github.com/repos/octo-org/octo-repo/tags blobs_url: https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha} git_tags_url: https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha} git_refs_url: https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha} trees_url: https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha} statuses_url: https://api.github.com/repos/octo-org/octo-repo/statuses/{sha} languages_url: https://api.github.com/repos/octo-org/octo-repo/languages stargazers_url: https://api.github.com/repos/octo-org/octo-repo/stargazers contributors_url: https://api.github.com/repos/octo-org/octo-repo/contributors subscribers_url: https://api.github.com/repos/octo-org/octo-repo/subscribers subscription_url: https://api.github.com/repos/octo-org/octo-repo/subscription commits_url: https://api.github.com/repos/octo-org/octo-repo/commits{/sha} git_commits_url: https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha} comments_url: https://api.github.com/repos/octo-org/octo-repo/comments{/number} issue_comment_url: |- https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number} contents_url: https://api.github.com/repos/octo-org/octo-repo/contents/{+path} compare_url: |- https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head} merges_url: https://api.github.com/repos/octo-org/octo-repo/merges archive_url: |- https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref} downloads_url: https://api.github.com/repos/octo-org/octo-repo/downloads issues_url: https://api.github.com/repos/octo-org/octo-repo/issues{/number} pulls_url: https://api.github.com/repos/octo-org/octo-repo/pulls{/number} milestones_url: https://api.github.com/repos/octo-org/octo-repo/milestones{/number} notifications_url: |- https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating} labels_url: https://api.github.com/repos/octo-org/octo-repo/labels{/name} releases_url: https://api.github.com/repos/octo-org/octo-repo/releases{/id} deployments_url: https://api.github.com/repos/octo-org/octo-repo/deployments environment-approvals-items: value: - state: approved comment: Ship it! environments: - id: 161088068 node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4 name: staging url: |- https://api.github.com/repos/github/hello-world/environments/staging html_url: |- https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging created_at: '2020-11-23T22:00:40Z' updated_at: '2020-11-23T22:00:40Z' user: login: octocat id: 1 node_id: MDQ6VXNlcjE= avatar_url: https://github.com/images/error/octocat_happy.gif gravatar_id: '' url: https://api.github.com/users/octocat html_url: https://github.com/octocat followers_url: https://api.github.com/users/octocat/followers following_url: https://api.github.com/users/octocat/following{/other_user} gists_url: https://api.github.com/users/octocat/gists{/gist_id} starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} subscriptions_url: https://api.github.com/users/octocat/subscriptions organizations_url: https://api.github.com/users/octocat/orgs repos_url: https://api.github.com/users/octocat/repos events_url: https://api.github.com/users/octocat/events{/privacy} received_events_url: https://api.github.com/users/octocat/received_events type: User site_admin: false job-paginated: value: total_count: 1 jobs: - id: 399444496 run_id: 29679449 run_url: |- https://api.github.com/repos/octo-org/octo-repo/actions/runs/29679449 node_id: MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng== head_sha: f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0 url: |- https://api.github.com/repos/octo-org/octo-repo/actions/jobs/399444496 html_url: https://github.com/octo-org/octo-repo/runs/29679449/jobs/399444496 status: completed conclusion: success started_at: '2020-01-20T17:42:40Z' completed_at: '2020-01-20T17:44:39Z' created_at: '2020-01-20T17:44:39Z' name: build steps: - name: Set up job status: completed conclusion: success number: 1 started_at: '2020-01-20T09:42:40.000-08:00' completed_at: '2020-01-20T09:42:41.000-08:00' - name: Run actions/checkout@v2 status: completed conclusion: success number: 2 started_at: '2020-01-20T09:42:41.000-08:00' completed_at: '2020-01-20T09:42:45.000-08:00' - name: Set up Ruby status: completed conclusion: success number: 3 started_at: '2020-01-20T09:42:45.000-08:00' completed_at: '2020-01-20T09:42:45.000-08:00' - name: Run actions/cache@v3 status: completed conclusion: success number: 4 started_at: '2020-01-20T09:42:45.000-08:00' completed_at: '2020-01-20T09:42:48.000-08:00' - name: Install Bundler status: completed conclusion: success number: 5 started_at: '2020-01-20T09:42:48.000-08:00' completed_at: '2020-01-20T09:42:52.000-08:00' - name: Install Gems status: completed conclusion: success number: 6 started_at: '2020-01-20T09:42:52.000-08:00' completed_at: '2020-01-20T09:42:53.000-08:00' - name: Run Tests status: completed conclusion: success number: 7 started_at: '2020-01-20T09:42:53.000-08:00' completed_at: '2020-01-20T09:42:59.000-08:00' - name: Deploy to Heroku status: completed conclusion: success number: 8 started_at: '2020-01-20T09:42:59.000-08:00' completed_at: '2020-01-20T09:44:39.000-08:00' - name: Post actions/cache@v3 status: completed conclusion: success number: 16 started_at: '2020-01-20T09:44:39.000-08:00' completed_at: '2020-01-20T09:44:39.000-08:00' - name: Complete job status: completed conclusion: success number: 17 started_at: '2020-01-20T09:44:39.000-08:00' completed_at: '2020-01-20T09:44:39.000-08:00' check_run_url: |- https://api.github.com/repos/octo-org/octo-repo/check-runs/399444496 labels: - self-hosted - foo - bar runner_id: 1 runner_name: my runner runner_group_id: 2 runner_group_name: my runner group workflow_name: CI head_branch: main pending-deployment-items: value: - environment: id: 161088068 node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4 name: staging url: |- https://api.github.com/repos/github/hello-world/environments/staging html_url: |- https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging wait_timer: 30 wait_timer_started_at: '2020-11-23T22:00:40Z' current_user_can_approve: true reviewers: - type: User reviewer: login: octocat id: 1 node_id: MDQ6VXNlcjE= avatar_url: https://github.com/images/error/octocat_happy.gif gravatar_id: '' url: https://api.github.com/users/octocat html_url: https://github.com/octocat followers_url: https://api.github.com/users/octocat/followers following_url: https://api.github.com/users/octocat/following{/other_user} gists_url: https://api.github.com/users/octocat/gists{/gist_id} starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} subscriptions_url: https://api.github.com/users/octocat/subscriptions organizations_url: https://api.github.com/users/octocat/orgs repos_url: https://api.github.com/users/octocat/repos events_url: https://api.github.com/users/octocat/events{/privacy} received_events_url: https://api.github.com/users/octocat/received_events type: User site_admin: false - type: Team reviewer: id: 1 node_id: MDQ6VGVhbTE= url: https://api.github.com/teams/1 html_url: https://github.com/orgs/github/teams/justice-league name: Justice League slug: justice-league description: great team. privacy: closed permission: admin members_url: https://api.github.com/teams/1/members{/member} repositories_url: https://api.github.com/teams/1/repos parent: id: 2 node_id: MDQ6VGVhbTE= url: https://api.github.com/teams/1 html_url: https://github.com/orgs/github/teams/justice-league name: Justice League slug: justice-league description: great team. privacy: closed permission: admin members_url: https://api.github.com/teams/1/members{/member} repositories_url: https://api.github.com/teams/1/repos deployment-items: value: - url: https://api.github.com/repos/octocat/example/deployments/1 id: 1 node_id: MDEwOkRlcGxveW1lbnQx sha: a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d ref: topic-branch task: deploy payload: {} original_environment: staging environment: production description: Deploy request from hubot creator: login: octocat id: 1 node_id: MDQ6VXNlcjE= avatar_url: https://github.com/images/error/octocat_happy.gif gravatar_id: '' url: https://api.github.com/users/octocat html_url: https://github.com/octocat followers_url: https://api.github.com/users/octocat/followers following_url: https://api.github.com/users/octocat/following{/other_user} gists_url: https://api.github.com/users/octocat/gists{/gist_id} starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} subscriptions_url: https://api.github.com/users/octocat/subscriptions organizations_url: https://api.github.com/users/octocat/orgs repos_url: https://api.github.com/users/octocat/repos events_url: https://api.github.com/users/octocat/events{/privacy} received_events_url: https://api.github.com/users/octocat/received_events type: User site_admin: false created_at: '2012-07-20T01:19:13Z' updated_at: '2012-07-20T01:19:13Z' statuses_url: https://api.github.com/repos/octocat/example/deployments/1/statuses repository_url: https://api.github.com/repos/octocat/example transient_environment: false production_environment: true actions-secret: value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' updated_at: '2020-01-10T14:59:22Z' actions-variable: value: name: USERNAME value: octocat created_at: '2021-08-10T14:59:22Z' updated_at: '2022-01-10T14:59:22Z' workflow-paginated: value: total_count: 2 workflows: - id: 161335 node_id: MDg6V29ya2Zsb3cxNjEzMzU= name: CI path: .github/workflows/blank.yaml state: active created_at: '2020-01-08T23:48:37.000-08:00' updated_at: '2020-01-08T23:50:21.000-08:00' url: |- https://api.github.com/repos/octo-org/octo-repo/actions/workflows/161335 html_url: |- https://github.com/octo-org/octo-repo/blob/master/.github/workflows/161335 badge_url: https://github.com/octo-org/octo-repo/workflows/CI/badge.svg - id: 269289 node_id: MDE4OldvcmtmbG93IFNlY29uZGFyeTI2OTI4OQ== name: Linter path: .github/workflows/linter.yaml state: active created_at: '2020-01-08T23:48:37.000-08:00' updated_at: '2020-01-08T23:50:21.000-08:00' url: |- https://api.github.com/repos/octo-org/octo-repo/actions/workflows/269289 html_url: |- https://github.com/octo-org/octo-repo/blob/master/.github/workflows/269289 badge_url: https://github.com/octo-org/octo-repo/workflows/Linter/badge.svg workflow: value: id: 161335 node_id: MDg6V29ya2Zsb3cxNjEzMzU= name: CI path: .github/workflows/blank.yaml state: active created_at: '2020-01-08T23:48:37.000-08:00' updated_at: '2020-01-08T23:50:21.000-08:00' url: |- https://api.github.com/repos/octo-org/octo-repo/actions/workflows/161335 html_url: |- https://github.com/octo-org/octo-repo/blob/master/.github/workflows/161335 badge_url: https://github.com/octo-org/octo-repo/workflows/CI/badge.svg parameters: per-page: name: per_page description: |- The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." in: query schema: type: integer default: 30 page: name: page description: |- The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." in: query schema: type: integer default: 1 direction: name: direction description: The direction to sort the results by. in: query required: false schema: type: string enum: - asc - desc default: desc runner-id: name: runner_id description: Unique identifier of the self-hosted runner. in: path required: true schema: type: integer runner-label-name: name: name description: The name of a self-hosted runner's custom label. in: path required: true schema: type: string owner: name: owner description: The account owner of the repository. The name is not case sensitive. in: path required: true schema: type: string repo: name: repo description: |- The name of the repository without the `.git` extension. The name is not case sensitive. in: path required: true schema: type: string secret-name: name: secret_name description: The name of the secret. in: path required: true schema: type: string variables-per-page: name: per_page description: |- The number of results per page (max 30). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." in: query schema: type: integer default: 10 variable-name: name: name description: The name of the variable. in: path required: true schema: type: string artifact-name: name: name description: |- The name field of an artifact. When specified, only artifacts with this name will be returned. in: query required: false schema: type: string artifact-id: name: artifact_id description: The unique identifier of the artifact. in: path required: true schema: type: integer actions-cache-git-ref-full: name: ref description: |- The full Git reference for narrowing down the cache. The `ref` for a branch should be formatted as `refs/heads/`. To reference a pull request use `refs/pull//merge`. in: query required: false schema: type: string actions-cache-key: name: key description: An explicit key or prefix for identifying the cache in: query required: false schema: type: string actions-cache-list-sort: name: sort description: |- The property to sort the results by. `created_at` means when the cache was created. `last_accessed_at` means when the cache was last accessed. `size_in_bytes` is the size of the cache in bytes. in: query required: false schema: type: string enum: - created_at - last_accessed_at - size_in_bytes default: last_accessed_at actions-cache-key-required: name: key description: key for identifying the cache. in: query required: true schema: type: string cache-id: name: cache_id description: The unique identifier of the GitHub Actions cache. in: path required: true schema: type: integer job-id: name: job_id description: The unique identifier of the job. in: path required: true schema: type: integer actor: name: actor description: |- Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run. in: query required: false schema: type: string workflow-run-branch: name: branch description: |- Returns workflow runs associated with a branch. Use the name of the branch of the `push`. in: query required: false schema: type: string event: name: event description: |- Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events that trigger workflows](https://docs.github.com/enterprise-server@3.9/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows)." in: query required: false schema: type: string workflow-run-status: name: status description: |- Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`. in: query required: false schema: type: string enum: - completed - action_required - cancelled - failure - neutral - skipped - stale - success - timed_out - in_progress - queued - requested - waiting - pending created: name: created description: |- Returns workflow runs created within the given date-time range. For more information on the syntax, see "[Understanding the search syntax](https://docs.github.com/enterprise-server@3.9/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." in: query required: false schema: type: string format: date-time exclude-pull-requests: name: exclude_pull_requests description: If `true` pull requests are omitted from the response (empty array). in: query required: false schema: type: boolean default: false workflow-run-check-suite-id: name: check_suite_id description: Returns workflow runs with the `check_suite_id` that you specify. in: query schema: type: integer workflow-run-head-sha: name: head_sha description: |- Only returns workflow runs that are associated with the specified `head_sha`. in: query required: false schema: type: string run-id: name: run_id description: The unique identifier of the workflow run. in: path required: true schema: type: integer attempt-number: name: attempt_number description: The attempt number of the workflow run. in: path required: true schema: type: integer workflow-id: name: workflow_id in: path description: |- The ID of the workflow. You can also pass the workflow file name as a string. required: true schema: oneOf: - type: integer - type: string headers: link: example: |- ; rel="next", ; rel="last" schema: type: string location: example: |- https://pipelines.actions.githubusercontent.com/OhgS4QRKqmgx7bKC27GKU83jnQjyeqG8oIMTge8eqtheppcmw8/_apis/pipelines/1/runs/176/signedlogcontent?urlExpires=2020-01-24T18%3A10%3A31.5729946Z&urlSigningMethod=HMACV1&urlSignature=agG73JakPYkHrh06seAkvmH7rBR4Ji4c2%2B6a2ejYh3E%3D schema: type: string responses: not_found: description: Resource not found content: application/json: schema: $ref: '#/components/schemas/basic-error' validation_failed_simple: description: Validation failed, or the endpoint has been spammed. content: application/json: schema: $ref: '#/components/schemas/validation-error-simple' bad_request: description: Bad Request content: application/json: schema: $ref: '#/components/schemas/basic-error' application/scim+json: schema: $ref: '#/components/schemas/scim-error' forbidden: description: Forbidden content: application/json: schema: $ref: '#/components/schemas/basic-error' gone: description: Gone content: application/json: schema: $ref: '#/components/schemas/basic-error' actions_runner_labels: description: Response content: application/json: schema: type: object required: - total_count - labels properties: total_count: type: integer labels: type: array items: $ref: '#/components/schemas/runner-label' examples: default: $ref: '#/components/examples/runner-labels' actions_runner_labels_readonly: description: Response content: application/json: schema: type: object required: - total_count - labels properties: total_count: type: integer labels: type: array items: $ref: '#/components/schemas/runner-label' examples: default: $ref: '#/components/examples/runner-labels-readonly' conflict: description: Conflict content: application/json: schema: $ref: '#/components/schemas/basic-error' internal_error: description: Internal Error content: application/json: schema: $ref: '#/components/schemas/basic-error' securitySchemes: bearerHttpAuthentication: description: Bearer Token type: http scheme: Bearer