{
  "opencollection": "1.0.0",
  "info": {
    "name": "Github Status API",
    "version": "1.1.4"
  },
  "items": [
    {
      "info": {
        "name": "Status",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "GitHub Get the Status of Services Running on All Replica Nodes",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{protocol}://{hostname}/api/v3/manage/v1/replication/status",
            "params": [
              {
                "name": "uuid",
                "value": "",
                "type": "query",
                "description": "The UUID which identifies a node."
              },
              {
                "name": "cluster_roles",
                "value": "",
                "type": "query",
                "description": "The cluster roles from the cluster configuration file."
              }
            ]
          },
          "docs": "Gets the status of all services running on each replica node.\nThis endpoint may take several seconds to reply."
        },
        {
          "info": {
            "name": "GitHub Get an Organization Migration Status",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{protocol}://{hostname}/api/v3/orgs/:org/migrations/:migration_id",
            "params": [
              {
                "name": "org",
                "value": "",
                "type": "path",
                "description": "The organization name. The name is not case sensitive."
              },
              {
                "name": "migration_id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the migration."
              },
              {
                "name": "exclude",
                "value": "",
                "type": "query",
                "description": "Exclude attributes from the API response to improve performance"
              }
            ]
          },
          "docs": "Fetches the status of a migration.\n\nThe `state` of a migration can be one of the following values:\n\n*   `pending`, which means the migration hasn't started yet.\n*   `exporting`, which means the migration is in progress.\n*   `exported`, which means the migration finished successfully.\n*   `failed`, which means the migration failed."
        },
        {
          "info": {
            "name": "GitHub Get Status Checks Protection",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/branches/:branch/protection/required_status_checks",
            "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": "branch",
                "value": "",
                "type": "path",
                "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.9/graphql)."
              }
            ]
          },
          "docs": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation."
        },
        {
          "info": {
            "name": "GitHub Update Status Check Protection",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/branches/:branch/protection/required_status_checks",
            "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": "branch",
                "value": "",
                "type": "path",
                "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.9/graphql)."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nUpdating required status checks requires admin or owner permissions to the repository an"
        },
        {
          "info": {
            "name": "GitHub Remove Status Check Protection",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/branches/:branch/protection/required_status_checks",
            "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": "branch",
                "value": "",
                "type": "path",
                "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.9/graphql)."
              }
            ]
          },
          "docs": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation."
        },
        {
          "info": {
            "name": "GitHub Get All Status Check Contexts",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts",
            "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": "branch",
                "value": "",
                "type": "path",
                "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.9/graphql)."
              }
            ]
          },
          "docs": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation."
        },
        {
          "info": {
            "name": "GitHub Add Status Check Contexts",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts",
            "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": "branch",
                "value": "",
                "type": "path",
                "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.9/graphql)."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation."
        },
        {
          "info": {
            "name": "GitHub Set Status Check Contexts",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts",
            "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": "branch",
                "value": "",
                "type": "path",
                "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.9/graphql)."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation."
        },
        {
          "info": {
            "name": "GitHub Remove Status Check Contexts",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts",
            "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": "branch",
                "value": "",
                "type": "path",
                "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.9/graphql)."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation."
        },
        {
          "info": {
            "name": "GitHub Get the Combined Status for Specific Reference",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/commits/:ref/status",
            "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": "ref",
                "value": "",
                "type": "path",
                "description": "The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see \"[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)\" in the Git documentation."
              },
              {
                "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": "Users with pull access in a repository can access a combined view of commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name.\n\n\nAdditionally, a combined `state` is returned. The `state` is one of:\n\n*   **failure** if any of the contexts report as `error` or `failure`\n*   **pending** if there are no statuses or a context is `pending`\n*   **success** if the latest status for all contexts is `success`"
        },
        {
          "info": {
            "name": "GitHub Create Deployment Status",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/deployments/:deployment_id/statuses",
            "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": "deployment_id",
                "value": "",
                "type": "path",
                "description": "deployment_id parameter"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Users with `push` access can create deployment statuses for a given deployment.\n\nOAuth app tokens and personal access tokens (classic) need the `repo_deployment` scope to use this endpoint."
        },
        {
          "info": {
            "name": "GitHub Get Deployment Status",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/deployments/:deployment_id/statuses/:status_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": "deployment_id",
                "value": "",
                "type": "path",
                "description": "deployment_id parameter"
              },
              {
                "name": "status_id",
                "value": "42",
                "type": "path"
              }
            ]
          },
          "docs": "Users with pull access can view a deployment status for a deployment:"
        },
        {
          "info": {
            "name": "GitHub List Repository Cache Replication Status",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/replicas/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": "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": "Lists the status of each repository cache replica."
        },
        {
          "info": {
            "name": "GitHub Create Commit Status",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/statuses/:sha",
            "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": "sha",
                "value": "abc123def456789012345678901234567890",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Users with push access in a repository can create commit statuses for a given SHA.\n\nNote: there is a limit of 1000 statuses per `sha` and `context` within a repository. Attempts to create more than 1000 statuses will result in a validation error."
        },
        {
          "info": {
            "name": "GitHub Get the Configuration Status",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{protocol}://{hostname}/api/v3/setup/api/configcheck"
          },
          "docs": "This endpoint allows you to check the status of the most recent configuration process:\n\nNote that you may need to wait several seconds after you start a process before you can check its status.\n\nThe different statuses are:\n\n| Status        | Description                       |\n| - |  |\n| `PENDING`     | The job has not started yet       |\n| `CONFIGURING` | The job is running                |\n| `DONE`        | The job has finished correctly    |\n| `FAILED`      | The job has finished unexpectedly"
        },
        {
          "info": {
            "name": "GitHub Get the Maintenance Status",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{protocol}://{hostname}/api/v3/setup/api/maintenance"
          },
          "docs": "The GitHub Setup API endpoint `/setup/api/maintenance` using the GET method retrieves the current maintenance status of a GitHub Enterprise Server instance. This operation allows administrators and monitoring systems to programmatically check whether the server is currently in maintenance mode, which is useful for coordinating deployments, upgrades, or troubleshooting activities. The endpoint returns information about the maintenance state, helping teams understand if the instance is available f"
        }
      ]
    }
  ],
  "bundled": true
}