{
  "opencollection": "1.0.0",
  "info": {
    "name": "Github Keys API",
    "version": "1.1.4"
  },
  "items": [
    {
      "info": {
        "name": "Keys",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "GitHub Get All Authorized Ssh Keys",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{protocol}://{hostname}/api/v3/setup/api/settings/authorized-keys"
          },
          "docs": "The GET endpoint at /setup/api/settings/authorized-keys in the GitHub Authorization API retrieves a complete list of all authorized SSH keys that have been configured for the system. This endpoint is typically used during setup or administrative operations to audit and review which SSH public keys have been granted access to the GitHub instance, allowing administrators to manage and verify authorized access points for secure shell connections."
        },
        {
          "info": {
            "name": "GitHub Add an Authorized Ssh Key",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{protocol}://{hostname}/api/v3/setup/api/settings/authorized-keys",
            "body": {
              "type": "form-urlencoded",
              "data": [
                {
                  "name": "authorized_key",
                  "value": ""
                }
              ]
            }
          },
          "docs": "**Note:** The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode)."
        },
        {
          "info": {
            "name": "GitHub Remove an Authorized Ssh Key",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{protocol}://{hostname}/api/v3/setup/api/settings/authorized-keys",
            "body": {
              "type": "form-urlencoded",
              "data": [
                {
                  "name": "authorized_key",
                  "value": ""
                }
              ]
            }
          },
          "docs": "**Note:** The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode)."
        },
        {
          "info": {
            "name": "GitHub Get an Organization Public Key",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/secrets/public-key",
            "params": [
              {
                "name": "org",
                "value": "",
                "type": "path",
                "description": "The organization name. The name is not case sensitive."
              }
            ]
          },
          "docs": "Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.\n\nThe authenticated user must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint."
        },
        {
          "info": {
            "name": "GitHub Get an Organization Public Key",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{protocol}://{hostname}/api/v3/orgs/:org/dependabot/secrets/public-key",
            "params": [
              {
                "name": "org",
                "value": "",
                "type": "path",
                "description": "The organization name. The name is not case sensitive."
              }
            ]
          },
          "docs": "Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint."
        },
        {
          "info": {
            "name": "GitHub Delete Github Actions Caches for Repository (using Cache Key)",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/actions/caches",
            "headers": [
              {
                "name": "Authorization",
                "value": "example_value"
              },
              {
                "name": "X-GitHub-Api-Version",
                "value": "example_value"
              },
              {
                "name": "Accept",
                "value": "example_value"
              }
            ],
            "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": "key",
                "value": "",
                "type": "query",
                "description": "key for identifying the cache."
              },
              {
                "name": "ref",
                "value": "",
                "type": "query",
                "description": "The full Git reference for narrowing down the cache. The `ref` for a branch should be formatted as `refs/heads/<branch name>`. To reference a pull request use `refs/pull/<number>/merge`."
              }
            ]
          },
          "docs": "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.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint."
        },
        {
          "info": {
            "name": "GitHub Get Repository Public Key",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/actions/secrets/public-key",
            "headers": [
              {
                "name": "Authorization",
                "value": "example_value"
              },
              {
                "name": "X-GitHub-Api-Version",
                "value": "example_value"
              },
              {
                "name": "Accept",
                "value": "example_value"
              }
            ],
            "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."
              }
            ]
          },
          "docs": "Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.\n\nAnyone with read access to the repository can use this endpoint.\n\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint."
        },
        {
          "info": {
            "name": "GitHub Get Repository Public Key",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/dependabot/secrets/public-key",
            "headers": [
              {
                "name": "Authorization",
                "value": "example_value"
              },
              {
                "name": "X-GitHub-Api-Version",
                "value": "example_value"
              },
              {
                "name": "Accept",
                "value": "example_value"
              }
            ],
            "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."
              }
            ]
          },
          "docs": "Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets. Anyone with read access\nto the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint if the repository is private."
        },
        {
          "info": {
            "name": "GitHub Get an Environment Public Key",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/environments/:environment_name/secrets/public-key",
            "headers": [
              {
                "name": "Authorization",
                "value": "example_value"
              },
              {
                "name": "X-GitHub-Api-Version",
                "value": "example_value"
              },
              {
                "name": "Accept",
                "value": "example_value"
              }
            ],
            "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": "environment_name",
                "value": "",
                "type": "path",
                "description": "The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`."
              }
            ]
          },
          "docs": "Get the public key for an environment, which you need to encrypt environment\nsecrets. You need to encrypt a secret before you can create or update secrets.\n\nAnyone with read access to the repository can use this endpoint.\n\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint."
        },
        {
          "info": {
            "name": "GitHub List Deploy Keys",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/keys",
            "headers": [
              {
                "name": "Authorization",
                "value": "example_value"
              },
              {
                "name": "X-GitHub-Api-Version",
                "value": "example_value"
              },
              {
                "name": "Accept",
                "value": "example_value"
              }
            ],
            "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": "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": "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).\""
              }
            ]
          },
          "docs": "The List Deploy Keys operation retrieves all deploy keys configured for a specific GitHub repository. Deploy keys are SSH keys that grant read-only or read-write access to a single repository, commonly used for deployment automation and CI/CD pipelines. This GET endpoint requires the repository owner and name as path parameters and returns an array of deploy key objects, each containing details such as the key ID, title, public key content, verification status, creation date, and whether the key"
        },
        {
          "info": {
            "name": "GitHub Create Deploy Key",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/keys",
            "headers": [
              {
                "name": "Authorization",
                "value": "example_value"
              },
              {
                "name": "X-GitHub-Api-Version",
                "value": "example_value"
              },
              {
                "name": "Accept",
                "value": "example_value"
              }
            ],
            "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."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "You can create a read-only deploy key."
        },
        {
          "info": {
            "name": "GitHub Get Deploy Key",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/keys/:key_id",
            "headers": [
              {
                "name": "Authorization",
                "value": "example_value"
              },
              {
                "name": "X-GitHub-Api-Version",
                "value": "example_value"
              },
              {
                "name": "Accept",
                "value": "example_value"
              }
            ],
            "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": "key_id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the key."
              }
            ]
          },
          "docs": "The Get Deploy Key operation retrieves detailed information about a specific deploy key configured for a GitHub repository. By making a GET request to /repos/{owner}/{repo}/keys/{key_id}, authenticated users with appropriate permissions can access the deploy key's metadata including its unique identifier, title, the public SSH key string, creation timestamp, verification status, and whether it has read-only or read-write access to the repository. This endpoint is useful for auditing deploy keys,"
        },
        {
          "info": {
            "name": "GitHub Delete Deploy Key",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/keys/:key_id",
            "headers": [
              {
                "name": "Authorization",
                "value": "example_value"
              },
              {
                "name": "X-GitHub-Api-Version",
                "value": "example_value"
              },
              {
                "name": "Accept",
                "value": "example_value"
              }
            ],
            "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": "key_id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the key."
              }
            ]
          },
          "docs": "Deploy keys are immutable. If you need to update a key, remove the key and create a new one instead."
        }
      ]
    }
  ],
  "bundled": true
}