{
  "opencollection": "1.0.0",
  "info": {
    "name": "APIs.io Engineering Platform Amazon API Gateway 2014 11 13 Secret-Scanning API",
    "version": "1.0.0"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "Authorization",
      "value": "{{Authorization}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "Secret-Scanning",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "APIs.io Engineering Platform List secret scanning alerts for an enterprise",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://apigateway.{region}.amazonaws.com/enterprises/:enterprise/secret-scanning/alerts",
            "params": [
              {
                "name": "enterprise",
                "value": "",
                "type": "path",
                "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id."
              },
              {
                "name": "state",
                "value": "",
                "type": "query",
                "description": "Set to `open` or `resolved` to only list secret scanning alerts in a specific state."
              },
              {
                "name": "secret_type",
                "value": "",
                "type": "query",
                "description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[Secret scanning patterns](https://docs.github.com/enterprise-server@3.9/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)\"\nfor a complete list of secret types."
              },
              {
                "name": "resolution",
                "value": "",
                "type": "query",
                "description": "A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`."
              },
              {
                "name": "sort",
                "value": "",
                "type": "query",
                "description": "The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved."
              },
              {
                "name": "direction",
                "value": "",
                "type": "query",
                "description": "The direction to sort the results by."
              },
              {
                "name": "per_page",
                "value": "",
                "type": "query",
                "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).\""
              },
              {
                "name": "before",
                "value": "",
                "type": "query",
                "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).\""
              },
              {
                "name": "after",
                "value": "",
                "type": "query",
                "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).\""
              }
            ]
          },
          "docs": "Lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest.\nTo use this endpoint, you must be a member of the enterprise, and you must use an access token with the `repo` scope or `security_events` scope. Alerts are only returned for organizations in the enterprise for which you are an organization owner or a [security manager](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-"
        },
        {
          "info": {
            "name": "APIs.io Engineering Platform List secret scanning alerts for an organization",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://apigateway.{region}.amazonaws.com/orgs/:org/secret-scanning/alerts",
            "params": [
              {
                "name": "org",
                "value": "",
                "type": "path",
                "description": "The organization name. The name is not case sensitive."
              },
              {
                "name": "state",
                "value": "",
                "type": "query",
                "description": "Set to `open` or `resolved` to only list secret scanning alerts in a specific state."
              },
              {
                "name": "secret_type",
                "value": "",
                "type": "query",
                "description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[Secret scanning patterns](https://docs.github.com/enterprise-server@3.9/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)\"\nfor a complete list of secret types."
              },
              {
                "name": "resolution",
                "value": "",
                "type": "query",
                "description": "A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`."
              },
              {
                "name": "sort",
                "value": "",
                "type": "query",
                "description": "The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved."
              },
              {
                "name": "direction",
                "value": "",
                "type": "query",
                "description": "The direction to sort the results by."
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "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).\""
              },
              {
                "name": "per_page",
                "value": "",
                "type": "query",
                "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).\""
              },
              {
                "name": "before",
                "value": "",
                "type": "query",
                "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 events before this cursor. To receive an initial cursor on your first request, include an empty \"before\" query string."
              },
              {
                "name": "after",
                "value": "",
                "type": "query",
                "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 events after this cursor.  To receive an initial cursor on your first request, include an empty \"after\" query string."
              }
            ]
          },
          "docs": "Lists secret scanning alerts for eligible repositories in an organization, from newest to oldest.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `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."
        },
        {
          "info": {
            "name": "APIs.io Engineering Platform List secret scanning alerts for a repository",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://apigateway.{region}.amazonaws.com/repos/:owner/:repo/secret-scanning/alerts",
            "params": [
              {
                "name": "owner",
                "value": "",
                "type": "path",
                "description": "The account owner of the repository. The name is not case sensitive."
              },
              {
                "name": "repo",
                "value": "",
                "type": "path",
                "description": "The name of the repository without the `.git` extension. The name is not case sensitive."
              },
              {
                "name": "state",
                "value": "",
                "type": "query",
                "description": "Set to `open` or `resolved` to only list secret scanning alerts in a specific state."
              },
              {
                "name": "secret_type",
                "value": "",
                "type": "query",
                "description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[Secret scanning patterns](https://docs.github.com/enterprise-server@3.9/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)\"\nfor a complete list of secret types."
              },
              {
                "name": "resolution",
                "value": "",
                "type": "query",
                "description": "A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`."
              },
              {
                "name": "sort",
                "value": "",
                "type": "query",
                "description": "The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved."
              },
              {
                "name": "direction",
                "value": "",
                "type": "query",
                "description": "The direction to sort the results by."
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "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).\""
              },
              {
                "name": "per_page",
                "value": "",
                "type": "query",
                "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).\""
              },
              {
                "name": "before",
                "value": "",
                "type": "query",
                "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 events before this cursor. To receive an initial cursor on your first request, include an empty \"before\" query string."
              },
              {
                "name": "after",
                "value": "",
                "type": "query",
                "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 events after this cursor.  To receive an initial cursor on your first request, include an empty \"after\" query string."
              }
            ]
          },
          "docs": "Lists secret scanning alerts for an eligible repository, from newest to oldest.\n\nThe authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `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."
        },
        {
          "info": {
            "name": "APIs.io Engineering Platform Get a secret scanning alert",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://apigateway.{region}.amazonaws.com/repos/:owner/:repo/secret-scanning/alerts/:alert_number",
            "params": [
              {
                "name": "owner",
                "value": "",
                "type": "path",
                "description": "The account owner of the repository. The name is not case sensitive."
              },
              {
                "name": "repo",
                "value": "",
                "type": "path",
                "description": "The name of the repository without the `.git` extension. The name is not case sensitive."
              },
              {
                "name": "alert_number",
                "value": "",
                "type": "path",
                "description": "The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation."
              }
            ]
          },
          "docs": "Gets a single secret scanning alert detected in an eligible repository.\n\nThe authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `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."
        },
        {
          "info": {
            "name": "APIs.io Engineering Platform Update a secret scanning alert",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "http://apigateway.{region}.amazonaws.com/repos/:owner/:repo/secret-scanning/alerts/:alert_number",
            "params": [
              {
                "name": "owner",
                "value": "",
                "type": "path",
                "description": "The account owner of the repository. The name is not case sensitive."
              },
              {
                "name": "repo",
                "value": "",
                "type": "path",
                "description": "The name of the repository without the `.git` extension. The name is not case sensitive."
              },
              {
                "name": "alert_number",
                "value": "",
                "type": "path",
                "description": "The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates the status of a secret scanning alert in an eligible repository.\n\nThe authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `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."
        },
        {
          "info": {
            "name": "APIs.io Engineering Platform List locations for a secret scanning alert",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://apigateway.{region}.amazonaws.com/repos/:owner/:repo/secret-scanning/alerts/:alert_number/locations",
            "params": [
              {
                "name": "owner",
                "value": "",
                "type": "path",
                "description": "The account owner of the repository. The name is not case sensitive."
              },
              {
                "name": "repo",
                "value": "",
                "type": "path",
                "description": "The name of the repository without the `.git` extension. The name is not case sensitive."
              },
              {
                "name": "alert_number",
                "value": "",
                "type": "path",
                "description": "The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation."
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "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).\""
              },
              {
                "name": "per_page",
                "value": "",
                "type": "query",
                "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).\""
              }
            ]
          },
          "docs": "Lists all locations for a given secret scanning alert for an eligible repository.\n\nThe authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `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."
        }
      ]
    }
  ],
  "bundled": true
}