Amazon API Gateway helps developers deliver robust, secure, and scalable mobile and web application back ends. API Gateway allows developers to securely connect mobile and web applications to APIs that run on AWS Lambda, Amazon EC2, or other publicly addressable web services that are hosted outside of AWS.
x-logo: url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png backgroundColor: '#FFFFFF' termsOfService: https://aws.amazon.com/service-terms/ contact: name: Mike Ralphson email: mike.ralphson@gmail.com url: https://github.com/mermade/aws2openapi x-twitter: PermittedSoc license: name: Apache 2.0 License url: http://www.apache.org/licenses/ x-providerName: amazonaws.com x-serviceName: apigateway x-origin: - contentType: application/json url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/apigateway-2015-07-09.normal.json converter: url: https://github.com/mermade/aws2openapi version: 1.0.0 x-apisguru-driver: external x-apiClientRegistration: url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct x-apisguru-categories: - cloud x-preferred: true servers: - url: http://apigateway.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The Amazon API Gateway multi-region endpoint - url: https://apigateway.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The Amazon API Gateway multi-region endpoint - url: http://apigateway.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The Amazon API Gateway endpoint for China (Beijing) and China (Ningxia) - url: https://apigateway.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The Amazon API Gateway endpoint for China (Beijing) and China (Ningxia) security: - hmac: [] tags: - name: Dependabot description: Endpoints to manage Dependabot. paths: /enterprises/{enterprise}/dependabot/alerts: get: summary: APIs.io Engineering Platform List Dependabot alerts for an enterprise description: 'Lists Dependabot alerts for repositories that are owned by the specified enterprise. The authenticated user must be a member of the enterprise to use this endpoint. Alerts are only returned for organizations in the enterprise for which you are an organization owner or a security manager. For more information about security managers, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint.' tags: - Dependabot operationId: dependabot/list-alerts-for-enterprise externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/dependabot/alerts#list-dependabot-alerts-for-an-enterprise parameters: - $ref: '#/components/parameters/enterprise' - $ref: '#/components/parameters/dependabot-alert-comma-separated-states' - $ref: '#/components/parameters/dependabot-alert-comma-separated-severities' - $ref: '#/components/parameters/dependabot-alert-comma-separated-ecosystems' - $ref: '#/components/parameters/dependabot-alert-comma-separated-packages' - $ref: '#/components/parameters/dependabot-alert-scope' - $ref: '#/components/parameters/dependabot-alert-sort' - $ref: '#/components/parameters/direction' - $ref: '#/components/parameters/pagination-before' - $ref: '#/components/parameters/pagination-after' - $ref: '#/components/parameters/pagination-first' - $ref: '#/components/parameters/pagination-last' - $ref: '#/components/parameters/per-page' responses: '200': description: Response content: application/json: schema: type: array items: $ref: '#/components/schemas/dependabot-alert-with-repository' examples: default: $ref: '#/components/examples/dependabot-alerts-for-organization' '304': $ref: '#/components/responses/not_modified' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not_found' '422': $ref: '#/components/responses/validation_failed_simple' x-github: githubCloudOnly: false enabledForGitHubApps: false previews: [] category: dependabot subcategory: alerts /orgs/{org}/dependabot/alerts: get: summary: APIs.io Engineering Platform List Dependabot alerts for an organization description: 'Lists Dependabot alerts for an organization. The authenticated user must be an owner or security manager for the organization to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.' tags: - Dependabot operationId: dependabot/list-alerts-for-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/dependabot/alerts#list-dependabot-alerts-for-an-organization parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/dependabot-alert-comma-separated-states' - $ref: '#/components/parameters/dependabot-alert-comma-separated-severities' - $ref: '#/components/parameters/dependabot-alert-comma-separated-ecosystems' - $ref: '#/components/parameters/dependabot-alert-comma-separated-packages' - $ref: '#/components/parameters/dependabot-alert-scope' - $ref: '#/components/parameters/dependabot-alert-sort' - $ref: '#/components/parameters/direction' - $ref: '#/components/parameters/pagination-before' - $ref: '#/components/parameters/pagination-after' - $ref: '#/components/parameters/pagination-first' - $ref: '#/components/parameters/pagination-last' - $ref: '#/components/parameters/per-page' responses: '200': description: Response content: application/json: schema: type: array items: $ref: '#/components/schemas/dependabot-alert-with-repository' examples: default: $ref: '#/components/examples/dependabot-alerts-for-organization' '304': $ref: '#/components/responses/not_modified' '400': $ref: '#/components/responses/bad_request' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not_found' '422': $ref: '#/components/responses/validation_failed_simple' x-github: githubCloudOnly: false enabledForGitHubApps: true category: dependabot subcategory: alerts /orgs/{org}/dependabot/secrets: get: summary: APIs.io Engineering Platform List organization secrets description: 'Lists all secrets available in an organization without revealing their encrypted values. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.' tags: - Dependabot operationId: dependabot/list-org-secrets externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/dependabot/secrets#list-organization-secrets parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/per-page' - $ref: '#/components/parameters/page' 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/organization-dependabot-secret' examples: default: $ref: '#/components/examples/organization-dependabot-secret-paginated' headers: Link: $ref: '#/components/headers/link' x-github: githubCloudOnly: false enabledForGitHubApps: true category: dependabot subcategory: secrets /orgs/{org}/dependabot/secrets/public-key: get: summary: APIs.io Engineering Platform Get an organization 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. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.' tags: - Dependabot operationId: dependabot/get-org-public-key externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/dependabot/secrets#get-an-organization-public-key parameters: - $ref: '#/components/parameters/org' responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/dependabot-public-key' examples: default: $ref: '#/components/examples/dependabot-public-key' x-github: githubCloudOnly: false enabledForGitHubApps: true category: dependabot subcategory: secrets /orgs/{org}/dependabot/secrets/{secret_name}: get: summary: APIs.io Engineering Platform Get an organization secret description: 'Gets a single organization secret without revealing its encrypted value. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.' tags: - Dependabot operationId: dependabot/get-org-secret externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/dependabot/secrets#get-an-organization-secret parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/secret-name' responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/organization-dependabot-secret' examples: default: $ref: '#/components/examples/organization-dependabot-secret' x-github: githubCloudOnly: false enabledForGitHubApps: true category: dependabot subcategory: secrets put: summary: APIs.io Engineering Platform Create or update an organization secret description: 'Creates or updates an organization 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)." OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.' tags: - Dependabot operationId: dependabot/create-or-update-org-secret externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/dependabot/secrets#create-or-update-an-organization-secret parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/secret-name' 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 an organization public key](https://docs.github.com/enterprise-server@3.9/rest/dependabot/secrets#get-an-organization-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. visibility: type: string description: Which type of organization repositories have access to the organization secret. `selected` means only the repositories specified by `selected_repository_ids` can access the secret. enum: - all - private - selected selected_repository_ids: type: array description: An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/enterprise-server@3.9/rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/enterprise-server@3.9/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-server@3.9/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret) endpoints. items: type: string required: - visibility examples: default: value: encrypted_value: c2VjcmV0 key_id: 012345678912345678 visibility: selected selected_repository_ids: - '1296269' - '1296280' responses: '201': description: Response when creating a secret content: application/json: schema: $ref: '#/components/schemas/empty-object' examples: default: value: null '204': description: Response when updating a secret x-github: githubCloudOnly: false enabledForGitHubApps: true category: dependabot subcategory: secrets delete: summary: APIs.io Engineering Platform Delete an organization secret description: 'Deletes a secret in an organization using the secret name. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.' tags: - Dependabot operationId: dependabot/delete-org-secret externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/dependabot/secrets#delete-an-organization-secret parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/secret-name' responses: '204': description: Response x-github: githubCloudOnly: false enabledForGitHubApps: true category: dependabot subcategory: secrets /orgs/{org}/dependabot/secrets/{secret_name}/repositories: get: summary: APIs.io Engineering Platform List selected repositories for an organization secret description: 'Lists all repositories that have been selected when the `visibility` for repository access to a secret is set to `selected`. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.' tags: - Dependabot operationId: dependabot/list-selected-repos-for-org-secret externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/secret-name' - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/per-page' responses: '200': description: Response content: application/json: schema: type: object required: - total_count - repositories properties: total_count: type: integer repositories: type: array items: $ref: '#/components/schemas/minimal-repository' examples: default: $ref: '#/components/examples/public-repository-paginated' x-github: githubCloudOnly: false enabledForGitHubApps: true category: dependabot subcategory: secrets put: summary: APIs.io Engineering Platform Set selected repositories for an organization secret description: 'Replaces all repositories for an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/enterprise-server@3.9/rest/dependabot/secrets#create-or-update-an-organization-secret). OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.' tags: - Dependabot operationId: dependabot/set-selected-repos-for-org-secret externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/secret-name' requestBody: required: true content: application/json: schema: type: object properties: selected_repository_ids: type: array description: An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/enterprise-server@3.9/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-server@3.9/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret) endpoints. items: type: integer required: - selected_repository_ids examples: default: value: selected_repository_ids: - 64780797 responses: '204': description: Response x-github: githubCloudOnly: false enabledForGitHubApps: true category: dependabot subcategory: secrets /orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}: put: summary: APIs.io Engineering Platform Add selected repository to an organization secret description: 'Adds a repository to an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/enterprise-server@3.9/rest/dependabot/secrets#create-or-update-an-organization-secret). OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.' tags: - Dependabot operationId: dependabot/add-selected-repo-to-org-secret externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/dependabot/secrets#add-selected-repository-to-an-organization-secret parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/secret-name' - name: repository_id in: path required: true schema: type: integer responses: '204': description: No Content when repository was added to the selected list '409': description: Conflict when visibility type is not set to selected x-github: githubCloudOnly: false enabledForGitHubApps: true category: dependabot subcategory: secrets delete: summary: APIs.io Engineering Platform Remove selected repository from an organization secret description: 'Removes a repository from an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/enterprise-server@3.9/rest/dependabot/secrets#create-or-update-an-organization-secret). OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.' tags: - Dependabot operationId: dependabot/remove-selected-repo-from-org-secret externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/secret-name' - name: repository_id in: path required: true schema: type: integer responses: '204': description: Response when repository was removed from the selected list '409': description: Conflict when visibility type not set to selected x-github: githubCloudOnly: false enabledForGitHubApps: true category: dependabot subcategory: secrets /repos/{owner}/{repo}/dependabot/alerts: get: summary: APIs.io Engineering Platform List Dependabot alerts for a repository description: OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. tags: - Dependabot operationId: dependabot/list-alerts-for-repo externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/dependabot/alerts#list-dependabot-alerts-for-a-repository parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/dependabot-alert-comma-separated-states' - $ref: '#/components/parameters/dependabot-alert-comma-separated-severities' - $ref: '#/components/parameters/dependabot-alert-comma-separated-ecosystems' - $ref: '#/components/parameters/dependabot-alert-comma-separated-packages' - $ref: '#/components/parameters/dependabot-alert-comma-separated-manifests' - $ref: '#/components/parameters/dependabot-alert-scope' - $ref: '#/components/parameters/dependabot-alert-sort' - $ref: '#/components/parameters/direction' - name: page description: '**Deprecated**. Page number of the results to fetch. Use cursor-based pagination with `before` or `after` instead.' deprecated: true in: query schema: type: integer default: 1 - 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)." deprecated: true in: query schema: type: integer default: 30 - $ref: '#/components/parameters/pagination-before' - $ref: '#/components/parameters/pagination-after' - $ref: '#/components/parameters/pagination-first' - $ref: '#/components/parameters/pagination-last' responses: '200': description: Response content: application/json: schema: type: array items: $ref: '#/components/schemas/dependabot-alert' examples: default: $ref: '#/components/examples/dependabot-alerts-for-repository' '304': $ref: '#/components/responses/not_modified' '400': $ref: '#/components/responses/bad_request' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not_found' '422': $ref: '#/components/responses/validation_failed_simple' x-github: githubCloudOnly: false enabledForGitHubApps: true previews: [] category: dependabot subcategory: alerts /repos/{owner}/{repo}/dependabot/alerts/{alert_number}: get: summary: APIs.io Engineering Platform Get a Dependabot alert description: OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. tags: - Dependabot operationId: dependabot/get-alert externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/dependabot/alerts#get-a-dependabot-alert parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/dependabot-alert-number' responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/dependabot-alert' examples: default: $ref: '#/components/examples/dependabot-alert-open' '304': $ref: '#/components/responses/not_modified' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not_found' x-github: githubCloudOnly: false enabledForGitHubApps: true previews: [] category: dependabot subcategory: alerts patch: summary: APIs.io Engineering Platform Update a Dependabot alert description: 'The authenticated user must have access to security alerts for the repository to use this endpoint. For more information, see "[Granting access to security alerts](https://docs.github.com/enterprise-server@3.9/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts)." OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.' tags: - Dependabot operationId: dependabot/update-alert externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/dependabot/alerts#update-a-dependabot-alert parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/dependabot-alert-number' requestBody: required: true content: application/json: schema: type: object properties: state: type: string description: 'The state of the Dependabot alert. A `dismissed_reason` must be provided when setting the state to `dismissed`.' enum: - dismissed - open dismissed_reason: type: string description: '**Required when `state` is `dismissed`.** A reason for dismissing the alert.' enum: - fix_started - inaccurate - no_bandwidth - not_used - tolerable_risk dismissed_comment: type: string description: An optional comment associated with dismissing the alert. maxLength: 280 required: - state additionalProperties: false examples: default: value: state: dismissed dismissed_reason: tolerable_risk dismissed_comment: This alert is accurate but we use a sanitizer. responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/dependabot-alert' examples: default: $ref: '#/components/examples/dependabot-alert-dismissed' '400': $ref: '#/components/responses/bad_request' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not_found' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/validation_failed_simple' x-github: githubCloudOnly: false enabledForGitHubApps: true previews: [] category: dependabot subcategory: alerts /repos/{owner}/{repo}/dependabot/secrets: get: summary: APIs.io Engineering Platform List repository secrets description: 'Lists all secrets available in a repository without revealing their encrypted values. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.' tags: - Dependabot operationId: dependabot/list-repo-secrets externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/dependabot/secrets#list-repository-secrets parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/per-page' - $ref: '#/components/parameters/page' 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/dependabot-secret' examples: default: $ref: '#/components/examples/dependabot-secret-paginated' headers: Link: $ref: '#/components/headers/link' x-github: githubCloudOnly: false enabledForGitHubApps: true category: dependabot subcategory: secrets /repos/{owner}/{repo}/dependabot/secrets/public-key: get: summary: APIs.io Engineering Platform Get a 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. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint if the repository is private.' tags: - Dependabot operationId: dependabot/get-repo-public-key externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/dependabot/secrets#get-a-repository-public-key parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/dependabot-public-key' examples: default: $ref: '#/components/examples/dependabot-public-key' x-github: githubCloudOnly: false enabledForGitHubApps: true category: dependabot subcategory: secrets /repos/{owner}/{repo}/dependabot/secrets/{secret_name}: get: summary: APIs.io Engineering Platform Get a repository secret description: 'Gets a single repository secret without revealing its encrypted value. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.' tags: - Dependabot operationId: dependabot/get-repo-secret externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/dependabot/secrets#get-a-repository-secret parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/secret-name' responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/dependabot-secret' examples: default: $ref: '#/components/examples/dependabot-secret' x-github: githubCloudOnly: false enabledForGitHubApps: true category: dependabot subcategory: secrets put: summary: APIs.io Engineering Platform Create or update a 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)." OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.' tags: - Dependabot operationId: dependabot/create-or-update-repo-secret externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/dependabot/secrets#create-or-update-a-repository-secret parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/secret-name' 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 a repository public key](https://docs.github.com/enterprise-server@3.9/rest/dependabot/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: null '204': description: Response when updating a secret x-github: githubCloudOnly: false enabledForGitHubApps: true category: dependabot subcategory: secrets delete: summary: APIs.io Engineering Platform Delete a repository secret description: 'Deletes a secret in a repository using the secret name. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.' tags: - Dependabot operationId: dependabot/delete-repo-secret externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/dependabot/secrets#delete-a-repository-secret parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/secret-name' responses: '204': description: Response x-github: githubCloudOnly: false enabledForGitHubApps: true category: dependabot subcategory: secrets components: schemas: nullable-simple-user: title: Simple User description: A GitHub user. type: object properties: name: nullable: true type: string email: nullable: true type: string 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 nullable: true 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 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 nullable: true alert-number: type: integer description: The security alert number. readOnly: true alert-html-url: type: string description: The GitHub URL of the alert resource. format: uri readOnly: true alert-updated-at: type: string description: 'The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true 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\n\n## Our Pledge\n\nIn 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.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject 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.\n\n## Scope\n\nThis 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,\n 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.\n\n## Enforcement\n\nInstances 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.\n\nProject 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.\n\n## Attribution\n\nThis 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/).\n" html_url: type: string format: uri nullable: true required: - url - html_url - key - name alert-fixed-at: type: string description: 'The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true nullable: true dependabot-alert-security-advisory: type: object description: Details for the GitHub Security Advisory. readOnly: true properties: ghsa_id: type: string description: The unique GitHub Security Advisory ID assigned to the advisory. readOnly: true cve_id: type: string description: The unique CVE ID assigned to the advisory. readOnly: true nullable: true summary: type: string description: A short, plain text summary of the advisory. readOnly: true maxLength: 1024 description: type: string description: A long-form Markdown-supported description of the advisory. readOnly: true vulnerabilities: type: array description: Vulnerable version range information for the advisory. readOnly: true items: $ref: '#/components/schemas/dependabot-alert-security-vulnerability' severity: type: string description: The severity of the advisory. readOnly: true enum: - low - medium - high - critical cvss: type: object description: Details for the advisory pertaining to the Common Vulnerability Scoring System. readOnly: true properties: score: type: number description: The overall CVSS score of the advisory. minimum: 0 maximum: 10 readOnly: true vector_string: type: string description: The full CVSS vector string for the advisory. readOnly: true nullable: true required: - score - vector_string additionalProperties: false cwes: type: array description: Details for the advisory pertaining to Common Weakness Enumeration. readOnly: true items: type: object description: A CWE weakness assigned to the advisory. readOnly: true properties: cwe_id: type: string description: The unique CWE ID. readOnly: true name: type: string description: The short, plain text name of the CWE. readOnly: true required: - cwe_id - name additionalProperties: false identifiers: type: array description: Values that identify this advisory among security information sources. readOnly: true items: type: object description: An advisory identifier. readOnly: true properties: type: type: string description: The type of advisory identifier. readOnly: true enum: - CVE - GHSA value: type: string description: The value of the advisory identifer. readOnly: true required: - value - type additionalProperties: false references: type: array description: Links to additional advisory information. readOnly: true items: type: object description: A link to additional advisory information. readOnly: true properties: url: type: string description: The URL of the reference. format: uri readOnly: true required: - url additionalProperties: false published_at: type: string description: 'The time that the advisory was published in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true updated_at: type: string description: 'The time that the advisory was last modified in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true withdrawn_at: type: string description: 'The time that the advisory was withdrawn in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true nullable: true required: - ghsa_id - cve_id - summary - description - vulnerabilities - severity - cvss - cwes - identifiers - references - published_at - updated_at - withdrawn_at additionalProperties: false basic-error: title: Basic Error description: Basic Error type: object properties: message: type: string documentation_url: type: string url: type: string status: type: string alert-created-at: type: string description: 'The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true alert-dismissed-at: type: string description: 'The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true nullable: true dependabot-secret: title: Dependabot Secret description: Set secrets for Dependabot. type: object properties: name: description: The name of the secret. example: MY_ARTIFACTORY_PASSWORD type: string created_at: type: string format: date-time updated_at: type: string format: date-time required: - name - created_at - updated_at alert-auto-dismissed-at: type: string description: 'The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true nullable: true scim-error: title: Scim Error description: Scim Error type: object properties: message: type: string nullable: true documentation_url: type: string nullable: true detail: type: string nullable: true status: type: integer scimType: type: string nullable: true schemas: type: array items: type: string validation-error-simple: title: Validation Error Simple description: Validation Error Simple type: object required: - message - documentation_url properties: message: type: string documentation_url: type: string errors: type: array items: type: string simple-user: title: Simple User description: A GitHub user. type: object properties: name: nullable: true type: string email: nullable: true type: string 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 nullable: true 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 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 dependabot-alert: type: object description: A Dependabot alert. properties: number: $ref: '#/components/schemas/alert-number' state: type: string description: The state of the Dependabot alert. readOnly: true enum: - auto_dismissed - dismissed - fixed - open dependency: type: object description: Details for the vulnerable dependency. readOnly: true properties: package: $ref: '#/components/schemas/dependabot-alert-package' manifest_path: type: string description: The full path to the dependency manifest file, relative to the root of the repository. readOnly: true scope: type: string description: The execution scope of the vulnerable dependency. readOnly: true nullable: true enum: - development - runtime security_advisory: $ref: '#/components/schemas/dependabot-alert-security-advisory' security_vulnerability: $ref: '#/components/schemas/dependabot-alert-security-vulnerability' url: $ref: '#/components/schemas/alert-url' html_url: $ref: '#/components/schemas/alert-html-url' created_at: $ref: '#/components/schemas/alert-created-at' updated_at: $ref: '#/components/schemas/alert-updated-at' dismissed_at: $ref: '#/components/schemas/alert-dismissed-at' dismissed_by: $ref: '#/components/schemas/nullable-simple-user' dismissed_reason: type: string description: The reason that the alert was dismissed. nullable: true enum: - fix_started - inaccurate - no_bandwidth - not_used - tolerable_risk dismissed_comment: type: string description: An optional comment associated with the alert's dismissal. nullable: true maxLength: 280 fixed_at: $ref: '#/components/schemas/alert-fixed-at' auto_dismissed_at: $ref: '#/components/schemas/alert-auto-dismissed-at' required: - number - state - dependency - security_advisory - security_vulnerability - url - html_url - created_at - updated_at - dismissed_at - dismissed_by - dismissed_reason - dismissed_comment - fixed_at additionalProperties: false dependabot-public-key: title: DependabotPublicKey description: The public key used for setting Dependabot 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= required: - key_id - key 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 html_url: type: string format: uri example: https://github.com/octocat/Hello-World description: type: string example: This your first repo! nullable: true fork: type: boolean 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 nullable: true hooks_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/hooks svn_url: type: string homepage: type: string nullable: true language: type: string nullable: true 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' nullable: true created_at: type: string format: date-time example: '2011-01-26T19:01:12Z' nullable: true updated_at: type: string format: date-time example: '2011-01-26T19:14:43Z' nullable: true 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 nullable: true 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 empty-object: title: Empty Object description: An object without any properties. type: object properties: {} additionalProperties: false simple-repository: title: Simple Repository description: A GitHub repository. type: object properties: id: type: integer format: int64 example: 1296269 description: A unique identifier of the repository. node_id: type: string example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 description: The GraphQL identifier of the repository. name: type: string example: Hello-World description: The name of the repository. full_name: type: string example: octocat/Hello-World description: The full, globally unique, name of the repository. owner: $ref: '#/components/schemas/simple-user' private: type: boolean description: Whether the repository is private. html_url: type: string format: uri example: https://github.com/octocat/Hello-World description: The URL to view the repository on GitHub.com. description: type: string example: This your first repo! nullable: true description: The repository description. fork: type: boolean description: Whether the repository is a fork. url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World description: The URL to get more information about the repository from the GitHub API. archive_url: type: string example: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} description: A template for the API URL to download the repository as an archive. assignees_url: type: string example: https://api.github.com/repos/octocat/Hello-World/assignees{/user} description: A template for the API URL to list the available assignees for issues in the repository. blobs_url: type: string example: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} description: A template for the API URL to create or retrieve a raw Git blob in the repository. branches_url: type: string example: https://api.github.com/repos/octocat/Hello-World/branches{/branch} description: A template for the API URL to get information about branches in the repository. collaborators_url: type: string example: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} description: A template for the API URL to get information about collaborators of the repository. comments_url: type: string example: https://api.github.com/repos/octocat/Hello-World/comments{/number} description: A template for the API URL to get information about comments on the repository. commits_url: type: string example: https://api.github.com/repos/octocat/Hello-World/commits{/sha} description: A template for the API URL to get information about commits on the repository. compare_url: type: string example: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} description: A template for the API URL to compare two commits or refs. contents_url: type: string example: https://api.github.com/repos/octocat/Hello-World/contents/{+path} description: A template for the API URL to get the contents of the repository. contributors_url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/contributors description: A template for the API URL to list the contributors to the repository. deployments_url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/deployments description: The API URL to list the deployments of the repository. downloads_url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/downloads description: The API URL to list the downloads on the repository. events_url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/events description: The API URL to list the events of the repository. forks_url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/forks description: The API URL to list the forks of the repository. git_commits_url: type: string example: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} description: A template for the API URL to get information about Git commits of the repository. git_refs_url: type: string example: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} description: A template for the API URL to get information about Git refs of the repository. git_tags_url: type: string example: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} description: A template for the API URL to get information about Git tags of the repository. issue_comment_url: type: string example: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} description: A template for the API URL to get information about issue comments on the repository. issue_events_url: type: string example: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} description: A template for the API URL to get information about issue events on the repository. issues_url: type: string example: https://api.github.com/repos/octocat/Hello-World/issues{/number} description: A template for the API URL to get information about issues on the repository. keys_url: type: string example: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} description: A template for the API URL to get information about deploy keys on the repository. labels_url: type: string example: https://api.github.com/repos/octocat/Hello-World/labels{/name} description: A template for the API URL to get information about labels of the repository. languages_url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/languages description: The API URL to get information about the languages of the repository. merges_url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/merges description: The API URL to merge branches in the repository. milestones_url: type: string example: https://api.github.com/repos/octocat/Hello-World/milestones{/number} description: A template for the API URL to get information about milestones of the repository. notifications_url: type: string example: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} description: A template for the API URL to get information about notifications on the repository. pulls_url: type: string example: https://api.github.com/repos/octocat/Hello-World/pulls{/number} description: A template for the API URL to get information about pull requests on the repository. releases_url: type: string example: https://api.github.com/repos/octocat/Hello-World/releases{/id} description: A template for the API URL to get information about releases on the repository. stargazers_url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/stargazers description: The API URL to list the stargazers on the repository. statuses_url: type: string example: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} description: A template for the API URL to get information about statuses of a commit. subscribers_url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/subscribers description: The API URL to list the subscribers on the repository. subscription_url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/subscription description: The API URL to subscribe to notifications for this repository. tags_url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/tags description: The API URL to get information about tags on the repository. teams_url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/teams description: The API URL to list the teams on the repository. trees_url: type: string example: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} description: A template for the API URL to create or retrieve a raw Git tree of the repository. hooks_url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/hooks description: The API URL to list the hooks on the 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 dependabot-alert-package: type: object description: Details for the vulnerable package. readOnly: true properties: ecosystem: type: string description: The package's language or package management ecosystem. readOnly: true name: type: string description: The unique package name within its ecosystem. readOnly: true required: - ecosystem - name additionalProperties: false dependabot-alert-security-vulnerability: type: object description: Details pertaining to one vulnerable version range for the advisory. readOnly: true properties: package: $ref: '#/components/schemas/dependabot-alert-package' severity: type: string description: The severity of the vulnerability. readOnly: true enum: - low - medium - high - critical vulnerable_version_range: type: string description: Conditions that identify vulnerable versions of this vulnerability's package. readOnly: true first_patched_version: type: object description: Details pertaining to the package version that patches this vulnerability. readOnly: true nullable: true properties: identifier: type: string description: The package version that patches this vulnerability. readOnly: true required: - identifier additionalProperties: false required: - package - severity - vulnerable_version_range - first_patched_version additionalProperties: false organization-dependabot-secret: title: Dependabot Secret for an Organization description: Secrets for GitHub Dependabot for an organization. type: object properties: name: description: The name of the secret. example: SECRET_TOKEN type: string created_at: type: string format: date-time updated_at: type: string format: date-time visibility: description: Visibility of a secret enum: - all - private - selected type: string selected_repositories_url: type: string format: uri example: https://api.github.com/organizations/org/dependabot/secrets/my_secret/repositories required: - name - created_at - updated_at - visibility dependabot-alert-with-repository: type: object description: A Dependabot alert. properties: number: $ref: '#/components/schemas/alert-number' state: type: string description: The state of the Dependabot alert. readOnly: true enum: - auto_dismissed - dismissed - fixed - open dependency: type: object description: Details for the vulnerable dependency. readOnly: true properties: package: $ref: '#/components/schemas/dependabot-alert-package' manifest_path: type: string description: The full path to the dependency manifest file, relative to the root of the repository. readOnly: true scope: type: string description: The execution scope of the vulnerable dependency. readOnly: true nullable: true enum: - development - runtime security_advisory: $ref: '#/components/schemas/dependabot-alert-security-advisory' security_vulnerability: $ref: '#/components/schemas/dependabot-alert-security-vulnerability' url: $ref: '#/components/schemas/alert-url' html_url: $ref: '#/components/schemas/alert-html-url' created_at: $ref: '#/components/schemas/alert-created-at' updated_at: $ref: '#/components/schemas/alert-updated-at' dismissed_at: $ref: '#/components/schemas/alert-dismissed-at' dismissed_by: $ref: '#/components/schemas/nullable-simple-user' dismissed_reason: type: string description: The reason that the alert was dismissed. nullable: true enum: - fix_started - inaccurate - no_bandwidth - not_used - tolerable_risk dismissed_comment: type: string description: An optional comment associated with the alert's dismissal. nullable: true maxLength: 280 fixed_at: $ref: '#/components/schemas/alert-fixed-at' auto_dismissed_at: $ref: '#/components/schemas/alert-auto-dismissed-at' repository: $ref: '#/components/schemas/simple-repository' required: - number - state - dependency - security_advisory - security_vulnerability - url - html_url - created_at - updated_at - dismissed_at - dismissed_by - dismissed_reason - dismissed_comment - fixed_at - repository additionalProperties: false security-and-analysis: nullable: true 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 alert-url: type: string description: The REST API URL of the alert resource. format: uri readOnly: true responses: forbidden: description: Forbidden content: application/json: schema: $ref: '#/components/schemas/basic-error' not_found: description: Resource not found content: application/json: schema: $ref: '#/components/schemas/basic-error' bad_request: description: Bad Request content: application/json: schema: $ref: '#/components/schemas/basic-error' application/scim+json: schema: $ref: '#/components/schemas/scim-error' conflict: description: Conflict 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' not_modified: description: Not modified parameters: dependabot-alert-number: name: alert_number in: path description: 'The number that identifies a Dependabot alert in its repository. You can find this at the end of the URL for a Dependabot alert within GitHub, or in `number` fields in the response from the `GET /repos/{owner}/{repo}/dependabot/alerts` operation.' required: true schema: $ref: '#/components/schemas/alert-number' dependabot-alert-comma-separated-manifests: name: manifest in: query description: A comma-separated list of full manifest paths. If specified, only alerts for these manifests will be returned. 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 direction: name: direction description: The direction to sort the results by. in: query required: false schema: type: string enum: - asc - desc default: desc dependabot-alert-comma-separated-severities: name: severity in: query description: 'A comma-separated list of severities. If specified, only alerts with these severities will be returned. Can be: `low`, `medium`, `high`, `critical`' schema: type: string pagination-first: name: first description: '**Deprecated**. The number of results per page (max 100), starting from the first matching result. This parameter must not be used in combination with `last`. Instead, use `per_page` in combination with `after` to fetch the first page of results.' in: query required: false schema: type: integer minimum: 1 maximum: 100 default: 30 dependabot-alert-comma-separated-ecosystems: name: ecosystem in: query description: 'A comma-separated list of ecosystems. If specified, only alerts for these ecosystems will be returned. Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust`' schema: type: string pagination-last: name: last description: '**Deprecated**. The number of results per page (max 100), starting from the last matching result. This parameter must not be used in combination with `first`. Instead, use `per_page` in combination with `before` to fetch the last page of results.' in: query required: false schema: type: integer minimum: 1 maximum: 100 dependabot-alert-scope: name: scope in: query description: The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned. schema: type: string enum: - development - runtime dependabot-alert-sort: name: sort in: query description: 'The property by which to sort the results. `created` means when the alert was created. `updated` means when the alert''s state last changed.' schema: type: string enum: - created - updated default: created 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 org: name: org description: The organization name. The name is not case sensitive. in: path required: true schema: type: string pagination-before: name: before description: A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. 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 required: false schema: type: string 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 secret-name: name: secret_name description: The name of the secret. in: path required: true schema: type: string dependabot-alert-comma-separated-states: name: state in: query description: 'A comma-separated list of states. If specified, only alerts with these states will be returned. Can be: `auto_dismissed`, `dismissed`, `fixed`, `open`' schema: type: string pagination-after: name: after description: A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. 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 required: false schema: type: string dependabot-alert-comma-separated-packages: name: package in: query description: A comma-separated list of package names. If specified, only alerts for these packages will be returned. schema: type: string enterprise: name: enterprise description: The slug version of the enterprise name. You can also substitute this value with the enterprise id. in: path required: true schema: type: string headers: link: example: