GitHub

Parameters

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "name",
          "image",
          "size",
          "runner_group_id"
        ],
        "properties": {
          "name": {
            "type": "string",
            "description": "Name of the runner. Must be between 1 and 64 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'."
          },
          "size": {
            "type": "string",
            "description": "The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes`"
          },
          "image": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "description": "The unique identifier of the runner image."
              },
              "source": {
                "enum": [
                  "github",
                  "partner",
                  "custom"
                ],
                "type": "string",
                "description": "The source of the runner image."
              },
              "version": {
                "type": "string",
                "nullable": true,
                "description": "The version of the runner image to deploy. This is relevant only for runners using custom images."
              }
            },
            "description": "The image of runner. To list all available images, use `GET /actions/hosted-runners/images/github-owned` or `GET /actions/hosted-runners/images/partner`."
          },
          "image_gen": {
            "type": "boolean",
            "default": false,
            "description": "Whether this runner should be used to generate custom images."
          },
          "maximum_runners": {
            "type": "integer",
            "description": "The maximum amount of runners to scale up to. Runners will not auto-scale above this number. Use this setting to limit your cost."
          },
          "runner_group_id": {
            "type": "integer",
            "description": "The existing runner group to add this runner to."
          },
          "enable_static_ip": {
            "type": "boolean",
            "description": "Whether this runner should be created with a static public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits`"
          }
        }
      },
      "examples": {
        "default": {
          "value": {
            "name": "My Hosted runner",
            "size": "4-core",
            "image": {
              "id": "ubuntu-latest",
              "source": "github"
            },
            "maximum_runners": 50,
            "runner_group_id": 1,
            "enable_static_ip": false
          }
        }
      }
    }
  },
  "required": true
}

Responses

Parameters

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "name"
        ],
        "properties": {
          "name": {
            "type": "string",
            "description": "Name of the runner group."
          },
          "runners": {
            "type": "array",
            "items": {
              "type": "integer",
              "description": "Unique identifier of the runner."
            },
            "description": "List of runner IDs to add to the runner group."
          },
          "visibility": {
            "enum": [
              "selected",
              "all",
              "private"
            ],
            "type": "string",
            "default": "all",
            "description": "Visibility of a runner group. You can select all repositories, select individual repositories, or limit access to private repositories."
          },
          "selected_workflows": {
            "type": "array",
            "items": {
              "type": "string",
              "example": "octo-org/octo-repo/.github/workflows/deploy.yaml@main",
              "description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required."
            },
            "description": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`."
          },
          "restricted_to_workflows": {
            "type": "boolean",
            "default": false,
            "description": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array."
          },
          "selected_repository_ids": {
            "type": "array",
            "items": {
              "type": "integer",
              "description": "Unique identifier of the repository."
            },
            "description": "List of repository IDs that can access the runner group."
          },
          "network_configuration_id": {
            "type": "string",
            "description": "The identifier of a hosted compute network configuration."
          },
          "allows_public_repositories": {
            "type": "boolean",
            "default": false,
            "description": "Whether the runner group can be used by `public` repositories."
          }
        }
      },
      "examples": {
        "default": {
          "value": {
            "name": "Expensive hardware runners",
            "runners": [
              9,
              2
            ],
            "visibility": "selected",
            "selected_repository_ids": [
              32,
              91
            ]
          }
        }
      }
    }
  },
  "required": true
}

Responses

Parameters

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "name",
          "runner_group_id",
          "labels"
        ],
        "properties": {
          "name": {
            "type": "string",
            "description": "The name of the new runner."
          },
          "labels": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "maxItems": 100,
            "minItems": 1,
            "description": "The names of the custom labels to add to the runner. **Minimum items**: 1. **Maximum items**: 100."
          },
          "work_folder": {
            "type": "string",
            "default": "_work",
            "description": "The working directory to be used for job execution, relative to the runner install directory."
          },
          "runner_group_id": {
            "type": "integer",
            "description": "The ID of the runner group to register the runner to."
          }
        }
      },
      "examples": {
        "default": {
          "value": {
            "name": "New runner",
            "labels": [
              "self-hosted",
              "X64",
              "macOS",
              "no-gpu"
            ],
            "work_folder": "_work",
            "runner_group_id": 1
          }
        }
      }
    }
  },
  "required": true
}

Responses

Parameters

Responses

Parameters

Responses

Parameters

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "labels"
        ],
        "properties": {
          "labels": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "maxItems": 100,
            "minItems": 1,
            "description": "The names of the custom labels to add to the runner."
          }
        }
      },
      "examples": {
        "default": {
          "value": {
            "labels": [
              "gpu",
              "accelerated"
            ]
          }
        }
      }
    }
  },
  "required": true
}

Responses

Parameters

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "name",
          "value",
          "visibility"
        ],
        "properties": {
          "name": {
            "type": "string",
            "description": "The name of the variable."
          },
          "value": {
            "type": "string",
            "description": "The value of the variable."
          },
          "visibility": {
            "enum": [
              "all",
              "private",
              "selected"
            ],
            "type": "string",
            "description": "The type of repositories in the organization that can access the variable. `selected` means only the repositories specified by `selected_repository_ids` can access the variable."
          },
          "selected_repository_ids": {
            "type": "array",
            "items": {
              "type": "integer"
            },
            "description": "An array of repository ids that can access the organization variable. You can only provide a list of repository ids when the `visibility` is set to `selected`."
          }
        }
      },
      "examples": {
        "default": {
          "value": {
            "name": "USERNAME",
            "value": "octocat",
            "visibility": "selected",
            "selected_repository_ids": [
              1296269,
              1296280
            ]
          }
        }
      }
    }
  },
  "required": true
}

Responses

Parameters

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "nullable": true,
        "properties": {
          "enable_debug_logging": {
            "type": "boolean",
            "default": false,
            "description": "Whether to enable debug logging for the re-run."
          }
        }
      },
      "examples": {
        "default": {
          "value": null
        }
      }
    }
  },
  "required": false
}

Responses

Parameters

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "name",
          "runner_group_id",
          "labels"
        ],
        "properties": {
          "name": {
            "type": "string",
            "description": "The name of the new runner."
          },
          "labels": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "maxItems": 100,
            "minItems": 1,
            "description": "The names of the custom labels to add to the runner. **Minimum items**: 1. **Maximum items**: 100."
          },
          "work_folder": {
            "type": "string",
            "default": "_work",
            "description": "The working directory to be used for job execution, relative to the runner install directory."
          },
          "runner_group_id": {
            "type": "integer",
            "description": "The ID of the runner group to register the runner to."
          }
        }
      },
      "examples": {
        "default": {
          "value": {
            "name": "New runner",
            "labels": [
              "self-hosted",
              "X64",
              "macOS",
              "no-gpu"
            ],
            "work_folder": "_work",
            "runner_group_id": 1
          }
        }
      }
    }
  },
  "required": true
}

Responses

Parameters

Responses

Parameters

Responses

Parameters

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "labels"
        ],
        "properties": {
          "labels": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "maxItems": 100,
            "minItems": 1,
            "description": "The names of the custom labels to add to the runner."
          }
        }
      },
      "examples": {
        "default": {
          "value": {
            "labels": [
              "gpu",
              "accelerated"
            ]
          }
        }
      }
    }
  },
  "required": true
}

Responses

Parameters

Responses

Parameters

Responses

Parameters

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "anyOf": [
          {
            "$ref": "#/components/schemas/review-custom-gates-comment-required"
          },
          {
            "$ref": "#/components/schemas/review-custom-gates-state-required"
          }
        ]
      },
      "examples": {
        "default": {
          "value": {
            "state": "approved",
            "comment": "All health checks passed.",
            "environment_name": "prod-eus"
          }
        }
      }
    }
  },
  "required": true
}

Responses

Parameters

Responses

Parameters

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "environment_ids",
          "state",
          "comment"
        ],
        "properties": {
          "state": {
            "enum": [
              "approved",
              "rejected"
            ],
            "type": "string",
            "example": "approved",
            "description": "Whether to approve or reject deployment to the specified environments."
          },
          "comment": {
            "type": "string",
            "example": "Ship it!",
            "description": "A comment to accompany the deployment review"
          },
          "environment_ids": {
            "type": "array",
            "items": {
              "type": "integer",
              "example": 161171787
            },
            "example": [
              161171787,
              161171795
            ],
            "description": "The list of environment ids to approve or reject"
          }
        }
      },
      "examples": {
        "default": {
          "value": {
            "state": "approved",
            "comment": "Ship it!",
            "environment_ids": [
              161171787
            ]
          }
        }
      }
    }
  },
  "required": true
}

Responses

Parameters

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "nullable": true,
        "properties": {
          "enable_debug_logging": {
            "type": "boolean",
            "default": false,
            "description": "Whether to enable debug logging for the re-run."
          }
        }
      },
      "examples": {
        "default": {
          "value": null
        }
      }
    }
  },
  "required": false
}

Responses

Parameters

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "nullable": true,
        "properties": {
          "enable_debug_logging": {
            "type": "boolean",
            "default": false,
            "description": "Whether to enable debug logging for the re-run."
          }
        }
      },
      "examples": {
        "default": {
          "value": null
        }
      }
    }
  },
  "required": false
}

Responses

Parameters

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "name",
          "value"
        ],
        "properties": {
          "name": {
            "type": "string",
            "description": "The name of the variable."
          },
          "value": {
            "type": "string",
            "description": "The value of the variable."
          }
        }
      },
      "examples": {
        "default": {
          "value": {
            "name": "USERNAME",
            "value": "octocat"
          }
        }
      }
    }
  },
  "required": true
}

Responses

Parameters

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "ref"
        ],
        "properties": {
          "ref": {
            "type": "string",
            "description": "The git reference for the workflow. The reference can be a branch or tag name."
          },
          "inputs": {
            "type": "object",
            "description": "Input keys and values configured in the workflow file. The maximum number of properties is 25. Any default properties configured in the workflow file will be used when `inputs` are omitted.",
            "maxProperties": 25,
            "additionalProperties": true
          },
          "return_run_details": {
            "type": "boolean",
            "description": "Whether the response should include the workflow run ID and URLs."
          }
        }
      },
      "examples": {
        "default": {
          "value": {
            "ref": "topic-branch",
            "inputs": {
              "home": "San Francisco, CA",
              "name": "Mona the Octocat"
            }
          }
        }
      }
    }
  },
  "required": true
}

Responses

Parameters

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "name",
          "value"
        ],
        "properties": {
          "name": {
            "type": "string",
            "description": "The name of the variable."
          },
          "value": {
            "type": "string",
            "description": "The value of the variable."
          }
        }
      },
      "examples": {
        "default": {
          "value": {
            "name": "USERNAME",
            "value": "octocat"
          }
        }
      }
    }
  },
  "required": true
}

Responses

Parameters

Responses

Parameters

Responses

Parameters

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "permissions": {
            "$ref": "#/components/schemas/app-permissions"
          },
          "repositories": {
            "type": "array",
            "items": {
              "type": "string",
              "example": "rails"
            },
            "description": "List of repository names that the token should have access to"
          },
          "repository_ids": {
            "type": "array",
            "items": {
              "type": "integer"
            },
            "example": [
              1
            ],
            "description": "List of repository IDs that the token should have access to"
          }
        }
      },
      "examples": {
        "default": {
          "value": {
            "permissions": {
              "issues": "write",
              "contents": "read"
            },
            "repositories": [
              "Hello-World"
            ]
          }
        }
      }
    }
  },
  "required": false
}

Responses

Parameters

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "access_token"
        ],
        "properties": {
          "access_token": {
            "type": "string",
            "description": "The access_token of the OAuth or GitHub application."
          }
        }
      },
      "examples": {
        "default": {
          "value": {
            "access_token": "e72e16c7e42f292c6912e7710c838347ae178b4a"
          }
        }
      }
    }
  },
  "required": true
}

Responses

Parameters

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "access_token"
        ],
        "properties": {
          "target": {
            "type": "string",
            "example": "octocat",
            "description": "The name of the user or organization to scope the user access token to. **Required** unless `target_id` is specified."
          },
          "target_id": {
            "type": "integer",
            "example": 1,
            "description": "The ID of the user or organization to scope the user access token to. **Required** unless `target` is specified."
          },
          "permissions": {
            "$ref": "#/components/schemas/app-permissions"
          },
          "access_token": {
            "type": "string",
            "example": "e72e16c7e42f292c6912e7710c838347ae178b4a",
            "description": "The access token used to authenticate to the GitHub API."
          },
          "repositories": {
            "type": "array",
            "items": {
              "type": "string",
              "example": "rails"
            },
            "description": "The list of repository names to scope the user access token to. `repositories` may not be specified if `repository_ids` is specified."
          },
          "repository_ids": {
            "type": "array",
            "items": {
              "type": "integer"
            },
            "example": [
              1
            ],
            "description": "The list of repository IDs to scope the user access token to. `repository_ids` may not be specified if `repositories` is specified."
          }
        }
      },
      "examples": {
        "default": {
          "value": {
            "target": "octocat",
            "permissions": {
              "issues": "write",
              "contents": "read",
              "metadata": "read"
            },
            "access_token": "e72e16c7e42f292c6912e7710c838347ae178b4a"
          }
        }
      }
    }
  },
  "required": true
}

Responses

Parameters

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "oneOf": [
          {
            "required": [
              "code_scanning_alerts"
            ]
          },
          {
            "required": [
              "secret_scanning_alerts"
            ]
          }
        ],
        "required": [
          "name",
          "description",
          "ends_at"
        ],
        "properties": {
          "name": {
            "type": "string",
            "maxLength": 50,
            "minLength": 1,
            "description": "The name of the campaign"
          },
          "ends_at": {
            "type": "string",
            "format": "date-time",
            "description": "The end date and time of the campaign. The date must be in the future."
          },
          "managers": {
            "type": "array",
            "items": {
              "type": "string",
              "description": "The login of each manager"
            },
            "maxItems": 10,
            "description": "The logins of the users to set as the campaign managers. At this time, only a single manager can be supplied."
          },
          "description": {
            "type": "string",
            "maxLength": 255,
            "minLength": 1,
            "description": "A description for the campaign"
          },
          "contact_link": {
            "type": "string",
            "format": "uri",
            "nullable": true,
            "description": "The contact link of the campaign. Must be a URI."
          },
          "team_managers": {
            "type": "array",
            "items": {
              "type": "string",
              "description": "The slug of each team"
            },
            "maxItems": 10,
            "description": "The slugs of the teams to set as the campaign managers."
          },
          "generate_issues": {
            "type": "boolean",
            "default": false,
            "description": "If true, will automatically generate issues for the campaign. The default is false."
          },
          "code_scanning_alerts": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "repository_id",
                "alert_numbers"
              ],
              "properties": {
                "alert_numbers": {
                  "type": "array",
                  "items": {
                    "type": "integer"
                  },
                  "minItems": 1,
                  "description": "The alert numbers"
                },
                "repository_id": {
                  "type": "integer",
                  "description": "The repository id"
                }
              },
              "additionalProperties": false
            },
            "minItems": 1,
            "nullable": true,
            "description": "The code scanning alerts to include in this campaign"
          }
        },
        "additionalProperties": false
      },
      "examples": {
        "default": {
          "value": {
            "name": "Critical CodeQL alerts",
            "ends_at": "2024-03-14T00:00:00Z",
            "managers": [
              "octocat"
            ],
            "description": "Address critical alerts before they are exploited to prevent breaches, protect sensitive data, and mitigate financial and reputational damage.",
            "code_scanning_alerts": [
              {
                "alert_numbers": [
                  1,
                  2
                ],
                "repository_id": 1296269
              }
            ]
          }
        }
      }
    }
  },
  "required": true
}

Responses

Parameters

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "oneOf": [
          {
            "required": [
              "status",
              "conclusion"
            ],
            "properties": {
              "status": {
                "enum": [
                  "completed"
                ]
              }
            },
            "additionalProperties": true
          },
          {
            "properties": {
              "status": {
                "enum": [
                  "queued",
                  "in_progress"
                ]
              }
            },
            "additionalProperties": true
          }
        ],
        "required": [
          "name",
          "head_sha"
        ],
        "properties": {
          "name": {
            "type": "string",
            "description": "The name of the check. For example, \"code-coverage\"."
          },
          "output": {
            "type": "object",
            "required": [
              "title",
              "summary"
            ],
            "properties": {
              "text": {
                "type": "string",
                "maxLength": 65535,
                "description": "The details of the check run. This parameter supports Markdown. **Maximum length**: 65535 characters."
              },
              "title": {
                "type": "string",
                "description": "The title of the check run."
              },
              "images": {
                "type": "array",
                "items": {
                  "type": "object",
                  "required": [
                    "alt",
                    "image_url"
                  ],
                  "properties": {
                    "alt": {
                      "type": "string",
                      "description": "The alternative text for the image."
                    },
                    "caption": {
                      "type": "string",
                      "description": "A short image description."
                    },
                    "image_url": {
                      "type": "string",
                      "description": "The full URL of the image."
                    }
                  }
                },
                "description": "Adds images to the output displayed in the GitHub pull request UI."
              },
              "summary": {
                "type": "string",
                "maxLength": 65535,
                "description": "The summary of the check run. This parameter supports Markdown. **Maximum length**: 65535 characters."
              },
              "annotations": {
                "type": "array",
                "items": {
                  "type": "object",
                  "required": [
                    "path",
                    "start_line",
                    "end_line",
                    "annotation_level",
                    "message"
                  ],
                  "properties": {
                    "path": {
                      "type": "string",
                      "description": "The path of the file to add an annotation to. For example, `assets/css/main.css`."
                    },
                    "title": {
                      "type": "string",
                      "description": "The title that represents the annotation. The maximum size is 255 characters."
                    },
                    "message": {
                      "type": "string",
                      "description": "A short description of the feedback for these lines of code. The maximum size is 64 KB."
                    },
                    "end_line": {
                      "type": "integer",
                      "description": "The end line of the annotation."
                    },
                    "end_column": {
                      "type": "integer",
                      "description": "The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values."
                    },
                    "start_line": {
                      "type": "integer",
                      "description": "The start line of the annotation. Line numbers start at 1."
                    },
                    "raw_details": {
                      "type": "string",
                      "description": "Details about this annotation. The maximum size is 64 KB."
                    },
                    "start_column": {
                      "type": "integer",
                      "description": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values. Column numbers start at 1."
                    },
                    "annotation_level": {
                      "enum": [
                        "notice",
                        "warning",
                        "failure"
                      ],
                      "type": "string",
                      "description": "The level of the annotation."
                    }
                  }
                },
                "maxItems": 50,
                "description": "Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the **Checks** and **Files changed** tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/rest/checks/runs#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. GitHub Actions are limited to 10 warning annotations and 10 error annotations per step. For details about how you can view annotations on GitHub, see \"[About status checks](https://docs.github.com/articles/about-status-checks#checks)\"."
              }
            },
            "description": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run."
          },
          "status": {
            "enum": [
              "queued",
              "in_progress",
              "completed",
              "waiting",
              "requested",
              "pending"
            ],
            "type": "string",
            "default": "queued",
            "description": "The current status of the check run. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`."
          },
          "actions": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "label",
                "description",
                "identifier"
              ],
              "properties": {
                "label": {
                  "type": "string",
                  "maxLength": 20,
                  "description": "The text to be displayed on a button in the web UI. The maximum size is 20 characters."
                },
                "identifier": {
                  "type": "string",
                  "maxLength": 20,
                  "description": "A reference for the action on the integrator's system. The maximum size is 20 characters."
                },
                "description": {
                  "type": "string",
                  "maxLength": 40,
                  "description": "A short explanation of what this action would do. The maximum size is 40 characters."
                }
              }
            },
            "maxItems": 3,
            "description": "Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the [`check_run.requested_action` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) to your app. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://docs.github.com/rest/guides/using-the-rest-api-to-interact-with-checks#check-runs-and-requested-actions).\""
          },
          "head_sha": {
            "type": "string",
            "description": "The SHA of the commit."
          },
          "conclusion": {
            "enum": [
              "action_required",
              "cancelled",
              "failure",
              "neutral",
              "success",
              "skipped",
              "stale",
              "timed_out"
            ],
            "type": "string",
            "description": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this."
          },
          "started_at": {
            "type": "string",
            "format": "date-time",
            "description": "The time that the check run began. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`."
          },
          "details_url": {
            "type": "string",
            "description": "The URL of the integrator's site that has the full details of the check. If the integrator does not provide this, then the homepage of the GitHub app is used."
          },
          "external_id": {
            "type": "string",
            "description": "A reference for the run on the integrator's system."
          },
          "completed_at": {
            "type": "string",
            "format": "date-time",
            "description": "The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`."
          }
        },
        "discriminator": {
          "propertyName": "status"
        }
      },
      "examples": {
        "example-of-completed-conclusion": {
          "value": {
            "name": "mighty_readme",
            "output": {
              "text": "You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app.",
              "title": "Mighty Readme report",
              "images": [
                {
                  "alt": "Super bananas",
                  "image_url": "http://example.com/images/42"
                }
              ],
              "summary": "There are 0 failures, 2 warnings, and 1 notices.",
              "annotations": [
                {
                  "path": "README.md",
                  "title": "Spell Checker",
                  "message": "Check your spelling for 'banaas'.",
                  "end_line": 2,
                  "start_line": 2,
                  "raw_details": "Do you mean 'bananas' or 'banana'?",
                  "annotation_level": "warning"
                },
                {
                  "path": "README.md",
                  "title": "Spell Checker",
                  "message": "Check your spelling for 'aples'",
                  "end_line": 4,
                  "start_line": 4,
                  "raw_details": "Do you mean 'apples' or 'Naples'",
                  "annotation_level": "warning"
                }
              ]
            },
            "status": "completed",
            "actions": [
              {
                "label": "Fix",
                "identifier": "fix_errors",
                "description": "Allow us to fix these errors for you"
              }
            ],
            "head_sha": "ce587453ced02b1526dfb4cb910479d431683101",
            "conclusion": "success",
            "started_at": "2017-11-30T19:39:10Z",
            "completed_at": "2017-11-30T19:49:10Z"
          },
          "summary": "Example of a completed conclusion"
        },
        "example-of-in-progress-conclusion": {
          "value": {
            "name": "mighty_readme",
            "output": {
              "text": "",
              "title": "Mighty Readme report",
              "summary": ""
            },
            "status": "in_progress",
            "head_sha": "ce587453ced02b1526dfb4cb910479d431683101",
            "started_at": "2018-05-04T01:14:52Z",
            "external_id": "42"
          },
          "summary": "Example of an in_progress conclusion"
        }
      }
    }
  },
  "required": true
}

Responses

Parameters

Responses

Parameters

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "head_sha"
        ],
        "properties": {
          "head_sha": {
            "type": "string",
            "description": "The sha of the head commit."
          }
        }
      },
      "examples": {
        "default": {
          "value": {
            "head_sha": "d6fde92930d4715a2b49857d24b940956b26d2d3"
          }
        }
      }
    }
  },
  "required": true
}

Responses

Parameters

Responses

Parameters

Responses

Parameters

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/code-scanning-autofix-commits"
      },
      "examples": {
        "default": {
          "$ref": "#/components/examples/code-scanning-autofix-commits"
        }
      }
    }
  },
  "required": false
}

Responses

Parameters

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "oneOf": [
          {
            "required": [
              "repositories"
            ]
          },
          {
            "required": [
              "repository_lists"
            ]
          },
          {
            "required": [
              "repository_owners"
            ]
          }
        ],
        "required": [
          "language",
          "query_pack"
        ],
        "properties": {
          "language": {
            "$ref": "#/components/schemas/code-scanning-variant-analysis-language"
          },
          "query_pack": {
            "type": "string",
            "description": "A Base64-encoded tarball containing a CodeQL query and all its dependencies"
          },
          "repositories": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "List of repository names (in the form `owner/repo-name`) to run the query against. Precisely one property from `repositories`, `repository_lists` and `repository_owners` is required."
          },
          "repository_lists": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "maxItems": 1,
            "description": "List of repository lists to run the query against. Precisely one property from `repositories`, `repository_lists` and `repository_owners` is required."
          },
          "repository_owners": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "maxItems": 1,
            "description": "List of organization or user names whose repositories the query should be run against. Precisely one property from `repositories`, `repository_lists` and `repository_owners` is required."
          }
        },
        "additionalProperties": false
      },
      "examples": {
        "repository_lists": {
          "value": {
            "language": "csharp",
            "query_pack": "aGVsbG8=",
            "repository_lists": [
              "top-100-csharp"
            ]
          },
          "summary": "Using the \"repository_lists\" field. \"query_pack\" is abridged."
        },
        "repository_owners": {
          "value": {
            "language": "csharp",
            "query_pack": "aGVsbG8=",
            "repository_owners": [
              "octocat"
            ]
          },
          "summary": "Using the \"repository_owners\" field. \"query_pack\" is abridged."
        },
        "repositories_parameter": {
          "value": {
            "language": "csharp",
            "query_pack": "aGVsbG8=",
            "repositories": [
              "octocat/Hello-World",
              "octocat/example"
            ]
          },
          "summary": "Using the \"repositories\" field. \"query_pack\" is abridged for brevity."
        }
      }
    }
  },
  "required": true
}

Responses

Parameters

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "commit_sha",
          "ref",
          "sarif"
        ],
        "properties": {
          "ref": {
            "$ref": "#/components/schemas/code-scanning-ref-full"
          },
          "sarif": {
            "$ref": "#/components/schemas/code-scanning-analysis-sarif-file"
          },
          "validate": {
            "type": "boolean",
            "description": "Whether the SARIF file will be validated according to the code scanning specifications.\nThis parameter is intended to help integrators ensure that the uploaded SARIF files are correctly rendered by code scanning."
          },
          "tool_name": {
            "type": "string",
            "description": "The name of the tool used to generate the code scanning analysis. If this parameter is not used, the tool name defaults to \"API\". If the uploaded SARIF contains a tool GUID, this will be available for filtering using the `tool_guid` parameter of operations such as `GET /repos/{owner}/{repo}/code-scanning/alerts`."
          },
          "commit_sha": {
            "$ref": "#/components/schemas/code-scanning-analysis-commit-sha"
          },
          "started_at": {
            "type": "string",
            "format": "date-time",
            "description": "The time that the analysis run began. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`."
          },
          "checkout_uri": {
            "type": "string",
            "format": "uri",
            "example": "file:///github/workspace/",
            "description": "The base directory used in the analysis, as it appears in the SARIF file.\nThis property is used to convert file paths from absolute to relative, so that alerts can be mapped to their correct location in the repository."
          }
        },
        "additionalProperties": false
      },
      "examples": {
        "default": {
          "value": {
            "ref": "refs/heads/master",
            "sarif": "H4sICMLGdF4AA2V4YW1wbGUuc2FyaWYAvVjdbts2FL7PUxDCijaA/CM7iRNfLkPXYgHSNstumlzQ0pHFVCI1korjFgH2ONtr7Ul2KFmy/mOn6QIkjsjDw0/nfN85NL8dEGL9pNwAImqRObECrWM1H40kXQ2XTAfJIlEgXcE1cD10RTQSVDE10K4aKSqZP1AxuKOIKg1ydJU60jSfSh8Hk6EzHA/vlOCWbfa7B6kYPpj90rlsWCZcmbHP5Bs+4oAWIjQD2SMOeJLh2vIQDnIaQerqXHjw8YIgxohybxAyDsS4cAPKsp03K4RcUs6+Up2D+JXpd8mibKIQN9fM/aMCdbyBujGSSQgVxJtx5qX2d2qUcIweQhEuDQf3GBO6CKHkogx/N3MVCKl/AeVKFuf4y5ubsMGDTj1ep+5I7sgmLIpxtU38hLtmMRGSuCFVyip5eKzs5ydh+LztVL6f2m6oih1BkYiuyQIIJWodxVpERPj4sEiWBNNH8EWT0DMG8EAjzKVHXCrB4FkPu/F64NMk1OeC+2yZSNoBOoR7CC0EzYWGbm+xFDFIzbI011+cLjfZtyJkmMZfumAh02uL3NpV2y+MZ6RAjxibyKrNxxJcVjANSb4eBGwZ1M0KsuyR2poLr5rMl8vaDSeVn6eTWEO2j2xIEcmhwlTKNOi4GMOI8gfuZYkvJ7b4v5Tiumyz7RnHeodFzpS8ASIZCH/AYdWi2z3sG8JtFxJ6fF9yR9CdifBr9Pd6d5V2+zbJKjjCFGGmsHuYFy2ytJq9tUxcLSRSQecppOGKrpUxYfxefMEFK+wOGa4hudQByBVT0L+EKtyACxnRsABhEx1QjVDs1KNI9MbpnhqfE45B6FJvu3hRu5VRU9MhZLmK7fqkKyQSTHNoyMqUFMqXCV3CwAeqEwmVokraK8IuBaGvHjQ0gMYrKjnjyw7uk9uD8tgmsBbFMPnU1bV2ZhkJNkuolUiWys3UPWzs5aaIUz9TBe8zMb+6+nT+6fLy91dlE3xzeDDT4zYszb0bW6NjJd0Rvn2EnLvWLFSdKPpBzInzfRgu8ETyMcH8nIfMnJCeC2PyfTA+UKngcnGH7Hw2hGkVQs5YlIRCtdWZYQ4/73es2JlxkfViOEIhoWJq5Oo6UBBfiKIqFBWhiE3jJGbFwVoxBHTRSuIS67sMeplei24X20shLjG+8gqbKC/bESiNMC+wd5q5id0yeS7CJEqXzmrTWNq3k05l84P6f4/bEmXFJjI0fIt1BGQssUnUDkBYeVhE5TqPnMH3jqogDcP0zKcTgLPTMSzOjhbjuVOmW23l1fYNStulfo6sXlFsGLhbDy5RECPRYGCTgOj2bd4nUQEivEd0H7KKYxqnEhFohuur3a3UPskbH/+Yg0+M5P2MHRJu3ziHh3Z2NCrWt3XF1rWTw8Ne/pfbWYXnDSE0SNZQQt1i18q7te2vOhu7ehWuvVyeu0wbLZi24mhoo6aOOTltzG/lgdVvVoXQq5V+pewkFIzL8fjEcadT55jOjpzFzHuOTtDNrMkJPMVQDd7F09RID72O/UPZ0tmctqZ7kWX6EmSZnDpP8GU67SXM8XE3YSrxbKsx6UReZ4y6n/FVZfJjs9Z7stma75W5yQtkzjk5eSJxk1lv4o7+j8TlhaJ2lsKWZO6lruDPBLib3x5ZN/KGWzZ+pn///evv7OOf4iIBv3oY9L/l1wiJ9p0Tc+F1zZnOE9NxXWEus6IQhr5pMfoqxi8WPsuu0azsns4UC6WzNzHIzbeEx4P/AJ3SefgcFAAA",
            "commit_sha": "4b6472266afd7b471e86085a6659e8c7f2b119da"
          }
        }
      }
    }
  },
  "required": true
}

Responses

Parameters

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "name",
          "description"
        ],
        "properties": {
          "name": {
            "type": "string",
            "description": "The name of the code security configuration. Must be unique within the enterprise."
          },
          "description": {
            "type": "string",
            "maxLength": 255,
            "description": "A description of the code security configuration"
          },
          "enforcement": {
            "enum": [
              "enforced",
              "unenforced"
            ],
            "type": "string",
            "default": "enforced",
            "description": "The enforcement status for a security configuration"
          },
          "code_security": {
            "enum": [
              "enabled",
              "disabled",
              "not_set"
            ],
            "type": "string",
            "description": "The enablement status of GitHub Code Security features."
          },
          "secret_scanning": {
            "enum": [
              "enabled",
              "disabled",
              "not_set"
            ],
            "type": "string",
            "default": "disabled",
            "description": "The enablement status of secret scanning"
          },
          "dependency_graph": {
            "enum": [
              "enabled",
              "disabled",
              "not_set"
            ],
            "type": "string",
            "default": "enabled",
            "description": "The enablement status of Dependency Graph"
          },
          "advanced_security": {
            "enum": [
              "enabled",
              "disabled",
              "code_security",
              "secret_protection"
            ],
            "type": "string",
            "default": "disabled",
            "description": "The enablement status of GitHub Advanced Security features. `enabled` will enable both Code Security and Secret Protection features.\n\n> [!WARNING]\n> `code_security` and `secret_protection` are deprecated values for this field. Prefer the individual `code_security` and `secret_protection` fields to set the status of these features.\n"
          },
          "dependabot_alerts": {
            "enum": [
              "enabled",
              "disabled",
              "not_set"
            ],
            "type": "string",
            "default": "disabled",
            "description": "The enablement status of Dependabot alerts"
          },
          "secret_protection": {
            "enum": [
              "enabled",
              "disabled",
              "not_set"
            ],
            "type": "string",
            "description": "The enablement status of GitHub Secret Protection features."
          },
          "code_scanning_options": {
            "$ref": "#/components/schemas/code-scanning-options"
          },
          "code_scanning_default_setup": {
            "enum": [
              "enabled",
              "disabled",
              "not_set"
            ],
            "type": "string",
            "default": "disabled",
            "description": "The enablement status of code scanning default setup"
          },
          "dependabot_security_updates": {
            "enum": [
              "enabled",
              "disabled",
              "not_set"
            ],
            "type": "string",
            "default": "disabled",
            "description": "The enablement status of Dependabot security updates"
          },
          "private_vulnerability_reporting": {
            "enum": [
              "enabled",
              "disabled",
              "not_set"
            ],
            "type": "string",
            "default": "disabled",
            "description": "The enablement status of private vulnerability reporting"
          },
          "secret_scanning_generic_secrets": {
            "enum": [
              "enabled",
              "disabled",
              "not_set"
            ],
            "type": "string",
            "default": "disabled",
            "description": "The enablement status of Copilot secret scanning"
          },
          "secret_scanning_push_protection": {
            "enum": [
              "enabled",
              "disabled",
              "not_set"
            ],
            "type": "string",
            "default": "disabled",
            "description": "The enablement status of secret scanning push protection"
          },
          "secret_scanning_validity_checks": {
            "enum": [
              "enabled",
              "disabled",
              "not_set"
            ],
            "type": "string",
            "default": "disabled",
            "description": "The enablement status of secret scanning validity checks"
          },
          "secret_scanning_extended_metadata": {
            "enum": [
              "enabled",
              "disabled",
              "not_set"
            ],
            "type": "string",
            "default": "disabled",
            "description": "The enablement status of secret scanning extended metadata"
          },
          "dependency_graph_autosubmit_action": {
            "enum": [
              "enabled",
              "disabled",
              "not_set"
            ],
            "type": "string",
            "default": "disabled",
            "description": "The enablement status of Automatic dependency submission"
          },
          "code_scanning_default_setup_options": {
            "$ref": "#/components/schemas/code-scanning-default-setup-options"
          },
          "secret_scanning_non_provider_patterns": {
            "enum": [
              "enabled",
              "disabled",
              "not_set"
            ],
            "type": "string",
            "default": "disabled",
            "description": "The enablement status of secret scanning non provider patterns"
          },
          "code_scanning_delegated_alert_dismissal": {
            "enum": [
              "enabled",
              "disabled",
              "not_set"
            ],
            "type": "string",
            "default": "disabled",
            "description": "The enablement status of code scanning delegated alert dismissal"
          },
          "secret_scanning_delegated_alert_dismissal": {
            "enum": [
              "enabled",
              "disabled",
              "not_set"
            ],
            "type": "string",
            "default": "disabled",
            "description": "The enablement status of secret scanning delegated alert dismissal"
          },
          "dependency_graph_autosubmit_action_options": {
            "type": "object",
            "properties": {
              "labeled_runners": {
                "type": "boolean",
                "default": false,
                "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners."
              }
            },
            "description": "Feature options for Automatic dependency submission"
          }
        },
        "additionalProperties": false
      },
      "examples": {
        "default": {
          "value": {
            "name": "High rish settings",
            "description": "This is a code security configuration for octo-enterprise",
            "secret_scanning": "enabled",
            "advanced_security": "enabled",
            "dependabot_alerts": "enabled",
            "dependabot_security_updates": "not_set"
          },
          "summary": "Example for a code security configuration"
        }
      }
    }
  },
  "required": true
}

Responses

Parameters

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "scope"
        ],
        "properties": {
          "scope": {
            "enum": [
              "all",
              "all_without_configurations"
            ],
            "type": "string",
            "description": "The type of repositories to attach the configuration to."
          }
        },
        "additionalProperties": false
      },
      "examples": {
        "default": {
          "value": {
            "scope": "all"
          },
          "summary": "Example for attaching a configuration to some repositories"
        }
      }
    }
  },
  "required": true
}

Responses

Parameters

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "name",
          "description"
        ],
        "properties": {
          "name": {
            "type": "string",
            "description": "The name of the code security configuration. Must be unique within the organization."
          },
          "description": {
            "type": "string",
            "maxLength": 255,
            "description": "A description of the code security configuration"
          },
          "enforcement": {
            "enum": [
              "enforced",
              "unenforced"
            ],
            "type": "string",
            "default": "enforced",
            "description": "The enforcement status for a security configuration"
          },
          "code_security": {
            "enum": [
              "enabled",
              "disabled",
              "not_set"
            ],
            "type": "string",
            "description": "The enablement status of GitHub Code Security features."
          },
          "secret_scanning": {
            "enum": [
              "enabled",
              "disabled",
              "not_set"
            ],
            "type": "string",
            "default": "disabled",
            "description": "The enablement status of secret scanning"
          },
          "dependency_graph": {
            "enum": [
              "enabled",
              "disabled",
              "not_set"
            ],
            "type": "string",
            "default": "enabled",
            "description": "The enablement status of Dependency Graph"
          },
          "advanced_security": {
            "enum": [
              "enabled",
              "disabled",
              "code_security",
              "secret_protection"
            ],
            "type": "string",
            "default": "disabled",
            "description": "The enablement status of GitHub Advanced Security features. `enabled` will enable both Code Security and Secret Protection features.\n\n> [!WARNING]\n> `code_security` and `secret_protection` are deprecated values for this field. Prefer the individual `code_security` and `secret_protection` fields to set the status of these features.\n"
          },
          "dependabot_alerts": {
            "enum": [
              "enabled",
              "disabled",
              "not_set"
            ],
            "type": "string",
            "default": "disabled",
            "description": "The enablement status of Dependabot alerts"
          },
          "secret_protection": {
            "enum": [
              "enabled",
              "disabled",
              "not_set"
            ],
            "type": "string",
            "description": "The enablement status of GitHub Secret Protection features."
          },
          "code_scanning_options": {
            "$ref": "#/components/schemas/code-scanning-options"
          },
          "code_scanning_default_setup": {
            "enum": [
              "enabled",
              "disabled",
              "not_set"
            ],
            "type": "string",
            "default": "disabled",
            "description": "The enablement status of code scanning default setup"
          },
          "dependabot_security_updates": {
            "enum": [
              "enabled",
              "disabled",
              "not_set"
            ],
            "type": "string",
            "default": "disabled",
            "description": "The enablement status of Dependabot security updates"
          },
          "private_vulnerability_reporting": {
            "enum": [
              "enabled",
              "disabled",
              "not_set"
            ],
            "type": "string",
            "default": "disabled",
            "description": "The enablement status of private vulnerability reporting"
          },
          "secret_scanning_generic_secrets": {
            "enum": [
              "enabled",
              "disabled",
              "not_set"
            ],
            "type": "string",
            "default": "disabled",
            "description": "The enablement status of Copilot secret scanning"
          },
          "secret_scanning_push_protection": {
            "enum": [
              "enabled",
              "disabled",
              "not_set"
            ],
            "type": "string",
            "default": "disabled",
            "description": "The enablement status of secret scanning push protection"
          },
          "secret_scanning_validity_checks": {
            "enum": [
              "enabled",
              "disabled",
              "not_set"
            ],
            "type": "string",
            "default": "disabled",
            "description": "The enablement status of secret scanning validity checks"
          },
          "secret_scanning_delegated_bypass": {
            "enum": [
              "enabled",
              "disabled",
              "not_set"
            ],
            "type": "string",
            "default": "disabled",
            "description": "The enablement status of secret scanning delegated bypass"
          },
          "secret_scanning_extended_metadata": {
            "enum": [
              "enabled",
              "disabled",
              "not_set"
            ],
            "type": "string",
            "description": "The enablement status of secret scanning extended metadata"
          },
          "dependency_graph_autosubmit_action": {
            "enum": [
              "enabled",
              "disabled",
              "not_set"
            ],
            "type": "string",
            "default": "disabled",
            "description": "The enablement status of Automatic dependency submission"
          },
          "code_scanning_default_setup_options": {
            "$ref": "#/components/schemas/code-scanning-default-setup-options"
          },
          "dependabot_delegated_alert_dismissal": {
            "enum": [
              "enabled",
              "disabled",
              "not_set"
            ],
            "type": "string",
            "default": "disabled",
            "description": "The enablement status of Dependabot delegated alert dismissal. Requires Dependabot alerts to be enabled."
          },
          "secret_scanning_non_provider_patterns": {
            "enum": [
              "enabled",
              "disabled",
              "not_set"
            ],
            "type": "string",
            "default": "disabled",
            "description": "The enablement status of secret scanning non provider patterns"
          },
          "code_scanning_delegated_alert_dismissal": {
            "enum": [
              "enabled",
              "disabled",
              "not_set"
            ],
            "type": "string",
            "default": "not_set",
            "description": "The enablement status of code scanning delegated alert dismissal"
          },
          "secret_scanning_delegated_bypass_options": {
            "type": "object",
            "properties": {
              "reviewers": {
                "type": "array",
                "items": {
                  "type": "object",
                  "required": [
                    "reviewer_id",
                    "reviewer_type"
                  ],
                  "properties": {
                    "mode": {
                      "enum": [
                        "ALWAYS",
                        "EXEMPT"
                      ],
                      "type": "string",
                      "default": "ALWAYS",
                      "description": "The bypass mode for the reviewer"
                    },
                    "reviewer_id": {
                      "type": "integer",
                      "description": "The ID of the team or role selected as a bypass reviewer"
                    },
                    "reviewer_type": {
                      "enum": [
                        "TEAM",
                        "ROLE"
                      ],
                      "type": "string",
                      "description": "The type of the bypass reviewer"
                    }
                  }
                },
                "description": "The bypass reviewers for secret scanning delegated bypass"
              }
            },
            "description": "Feature options for secret scanning delegated bypass"
          },
          "secret_scanning_delegated_alert_dismissal": {
            "enum": [
              "enabled",
              "disabled",
              "not_set"
            ],
            "type": "string",
            "description": "The enablement status of secret scanning delegated alert dismissal"
          },
          "dependency_graph_autosubmit_action_options": {
            "type": "object",
            "properties": {
              "labeled_runners": {
                "type": "boolean",
                "default": false,
                "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners."
              }
            },
            "description": "Feature options for Automatic dependency submission"
          }
        },
        "additionalProperties": false
      },
      "examples": {
        "default": {
          "value": {
            "name": "octo-org recommended settings",
            "description": "This is a code security configuration for octo-org",
            "secret_scanning": "enabled",
            "advanced_security": "enabled",
            "dependabot_alerts": "enabled",
            "dependabot_security_updates": "not_set"
          },
          "summary": "Example for a code security configuration"
        }
      }
    }
  },
  "required": true
}

Responses

Parameters

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "scope"
        ],
        "properties": {
          "scope": {
            "enum": [
              "all",
              "all_without_configurations",
              "public",
              "private_or_internal",
              "selected"
            ],
            "type": "string",
            "description": "The type of repositories to attach the configuration to. `selected` means the configuration will be attached to only the repositories specified by `selected_repository_ids`"
          },
          "selected_repository_ids": {
            "type": "array",
            "items": {
              "type": "integer",
              "description": "Unique identifier of the repository."
            },
            "description": "An array of repository IDs to attach the configuration to. You can only provide a list of repository ids when the `scope` is set to `selected`."
          }
        },
        "additionalProperties": false
      },
      "examples": {
        "default": {
          "value": {
            "scope": "selected",
            "selected_repository_ids": [
              32,
              91
            ]
          },
          "summary": "Example for attaching a configuration to some repositories"
        }
      }
    }
  },
  "required": true
}

Responses

Parameters

Responses

Parameters

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "nullable": true,
        "properties": {
          "geo": {
            "enum": [
              "EuropeWest",
              "SoutheastAsia",
              "UsEast",
              "UsWest"
            ],
            "type": "string",
            "description": "The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is closing down."
          },
          "ref": {
            "type": "string",
            "description": "Git ref (typically a branch name) for this codespace"
          },
          "machine": {
            "type": "string",
            "description": "Machine type to use for this codespace"
          },
          "location": {
            "type": "string",
            "description": "The requested location for a new codespace. Best efforts are made to respect this upon creation. Assigned by IP if not provided."
          },
          "client_ip": {
            "type": "string",
            "description": "IP for location auto-detection when proxying a request"
          },
          "display_name": {
            "type": "string",
            "description": "Display name for this codespace"
          },
          "devcontainer_path": {
            "type": "string",
            "description": "Path to devcontainer.json config to use for this codespace"
          },
          "working_directory": {
            "type": "string",
            "description": "Working directory for this codespace"
          },
          "idle_timeout_minutes": {
            "type": "integer",
            "description": "Time in minutes before codespace stops from inactivity"
          },
          "retention_period_minutes": {
            "type": "integer",
            "description": "Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days)."
          },
          "multi_repo_permissions_opt_out": {
            "type": "boolean",
            "description": "Whether to authorize requested permissions from devcontainer.json"
          }
        }
      },
      "examples": {
        "default": {
          "value": {
            "ref": "main",
            "machine": "standardLinux32gb"
          }
        }
      }
    }
  },
  "required": true
}

Responses

Parameters

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "nullable": true,
        "properties": {
          "geo": {
            "enum": [
              "EuropeWest",
              "SoutheastAsia",
              "UsEast",
              "UsWest"
            ],
            "type": "string",
            "description": "The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is closing down."
          },
          "machine": {
            "type": "string",
            "description": "Machine type to use for this codespace"
          },
          "location": {
            "type": "string",
            "description": "The requested location for a new codespace. Best efforts are made to respect this upon creation. Assigned by IP if not provided."
          },
          "client_ip": {
            "type": "string",
            "description": "IP for location auto-detection when proxying a request"
          },
          "display_name": {
            "type": "string",
            "description": "Display name for this codespace"
          },
          "devcontainer_path": {
            "type": "string",
            "description": "Path to devcontainer.json config to use for this codespace"
          },
          "working_directory": {
            "type": "string",
            "description": "Working directory for this codespace"
          },
          "idle_timeout_minutes": {
            "type": "integer",
            "description": "Time in minutes before codespace stops from inactivity"
          },
          "retention_period_minutes": {
            "type": "integer",
            "description": "Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days)."
          },
          "multi_repo_permissions_opt_out": {
            "type": "boolean",
            "description": "Whether to authorize requested permissions from devcontainer.json"
          }
        }
      },
      "examples": {
        "default": {
          "value": {
            "ref": "main",
            "repository_id": 1
          }
        }
      }
    }
  },
  "required": true
}

Responses

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "oneOf": [
          {
            "type": "object",
            "required": [
              "repository_id"
            ],
            "properties": {
              "geo": {
                "enum": [
                  "EuropeWest",
                  "SoutheastAsia",
                  "UsEast",
                  "UsWest"
                ],
                "type": "string",
                "description": "The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is closing down."
              },
              "ref": {
                "type": "string",
                "description": "Git ref (typically a branch name) for this codespace"
              },
              "machine": {
                "type": "string",
                "description": "Machine type to use for this codespace"
              },
              "location": {
                "type": "string",
                "description": "The requested location for a new codespace. Best efforts are made to respect this upon creation. Assigned by IP if not provided."
              },
              "client_ip": {
                "type": "string",
                "description": "IP for location auto-detection when proxying a request"
              },
              "display_name": {
                "type": "string",
                "description": "Display name for this codespace"
              },
              "repository_id": {
                "type": "integer",
                "description": "Repository id for this codespace"
              },
              "devcontainer_path": {
                "type": "string",
                "description": "Path to devcontainer.json config to use for this codespace"
              },
              "working_directory": {
                "type": "string",
                "description": "Working directory for this codespace"
              },
              "idle_timeout_minutes": {
                "type": "integer",
                "description": "Time in minutes before codespace stops from inactivity"
              },
              "retention_period_minutes": {
                "type": "integer",
                "description": "Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days)."
              },
              "multi_repo_permissions_opt_out": {
                "type": "boolean",
                "description": "Whether to authorize requested permissions from devcontainer.json"
              }
            }
          },
          {
            "type": "object",
            "required": [
              "pull_request"
            ],
            "properties": {
              "geo": {
                "enum": [
                  "EuropeWest",
                  "SoutheastAsia",
                  "UsEast",
                  "UsWest"
                ],
                "type": "string",
                "description": "The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is closing down."
              },
              "machine": {
                "type": "string",
                "description": "Machine type to use for this codespace"
              },
              "location": {
                "type": "string",
                "description": "The requested location for a new codespace. Best efforts are made to respect this upon creation. Assigned by IP if not provided."
              },
              "pull_request": {
                "type": "object",
                "required": [
                  "pull_request_number",
                  "repository_id"
                ],
                "properties": {
                  "repository_id": {
                    "type": "integer",
                    "description": "Repository id for this codespace"
                  },
                  "pull_request_number": {
                    "type": "integer",
                    "description": "Pull request number"
                  }
                },
                "description": "Pull request number for this codespace"
              },
              "devcontainer_path": {
                "type": "string",
                "description": "Path to devcontainer.json config to use for this codespace"
              },
              "working_directory": {
                "type": "string",
                "description": "Working directory for this codespace"
              },
              "idle_timeout_minutes": {
                "type": "integer",
                "description": "Time in minutes before codespace stops from inactivity"
              }
            }
          }
        ]
      },
      "examples": {
        "default": {
          "value": {
            "geo": "UsWest",
            "ref": "main",
            "repository_id": 1
          }
        }
      }
    }
  },
  "required": true
}

Responses

Parameters

Responses

Parameters

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "A name for the new repository."
          },
          "private": {
            "type": "boolean",
            "default": false,
            "description": "Whether the new repository should be private."
          }
        }
      },
      "examples": {
        "default": {
          "value": {
            "private": false,
            "repository": "monalisa-octocat-hello-world-g4wpq6h95q"
          }
        }
      }
    }
  },
  "required": true
}

Responses

Parameters

Responses

Parameters

Responses

Parameters

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "organizations": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "List of organization logins within the enterprise to enable Copilot coding agent for."
          },
          "custom_properties": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "property_name",
                "values"
              ],
              "properties": {
                "values": {
                  "type": "array",
                  "items": {
                    "type": "string"
                  },
                  "description": "The values of the custom property to match."
                },
                "property_name": {
                  "type": "string",
                  "description": "The name of the custom property to filter by."
                }
              }
            },
            "description": "List of custom property filters to match organizations. Organizations matching any of the specified property name/value pairs will be included. This is a one-time operation, setting the property on an organization in the future will not automatically update its coding agent policy."
          }
        }
      },
      "examples": {
        "default": {
          "value": {
            "organizations": [
              "my-org-1",
              "my-org-2"
            ],
            "custom_properties": [
              {
                "values": [
                  "engineering",
                  "security"
                ],
                "property_name": "department"
              }
            ]
          },
          "summary": "Add organizations that match a login or have a custom property"
        }
      }
    }
  },
  "required": true,
  "description": "The organizations to enable Copilot coding agent for"
}

Responses

Parameters

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "selected_teams"
        ],
        "properties": {
          "selected_teams": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "minItems": 1,
            "description": "List of team names within the organization to which to grant access to GitHub Copilot."
          }
        }
      },
      "examples": {
        "default": {
          "value": {
            "selected_teams": [
              "engteam1",
              "engteam2",
              "engteam3"
            ]
          }
        }
      }
    }
  },
  "required": true
}

Responses

Parameters

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "selected_usernames"
        ],
        "properties": {
          "selected_usernames": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "minItems": 1,
            "description": "The usernames of the organization members to be granted access to GitHub Copilot."
          }
        }
      },
      "examples": {
        "default": {
          "value": {
            "selected_usernames": [
              "cooluser1",
              "hacker2",
              "octocat"
            ]
          }
        }
      }
    }
  },
  "required": true
}

Responses

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "credentials"
        ],
        "properties": {
          "credentials": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "maxItems": 1000,
            "minItems": 1,
            "description": "A list of credentials to be revoked, up to 1000 per request."
          }
        }
      },
      "examples": {
        "default": {
          "value": {
            "credentials": [
              "ghp_1234567890abcdef1234567890abcdef12345678",
              "github_pat_0A1B2C3D4E5F6G7H8I9J0K_ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456",
              "gho_1234567890abcdef1234567890abcdef12345678",
              "ghu_1234567890abcdef1234567890abcdef12345678",
              "ghr_1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890ab"
            ]
          }
        }
      }
    }
  },
  "required": true
}

Responses

Parameters

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/snapshot"
      },
      "examples": {
        "example-of-a-dependency-submission": {
          "$ref": "#/components/examples/dependency-graph-create-snapshot-request"
        }
      }
    }
  },
  "required": true
}

Responses

Parameters

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "usernames"
        ],
        "properties": {
          "usernames": {
            "type": "array",
            "items": {
              "type": "string",
              "description": "The handle for the GitHub user account."
            },
            "description": "The GitHub user handles to add to the team."
          }
        }
      },
      "examples": {
        "default": {
          "value": {
            "usernames": [
              "monalisa",
              "octocat"
            ]
          }
        }
      }
    }
  },
  "required": true
}

Responses

Parameters

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "usernames"
        ],
        "properties": {
          "usernames": {
            "type": "array",
            "items": {
              "type": "string",
              "description": "The handle for the GitHub user account."
            },
            "description": "The GitHub user handles to be removed from the team."
          }
        }
      },
      "examples": {
        "default": {
          "value": {
            "usernames": [
              "monalisa",
              "octocat"
            ]
          }
        }
      }
    }
  },
  "required": true
}

Responses

Parameters

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "organization_slugs"
        ],
        "properties": {
          "organization_slugs": {
            "type": "array",
            "items": {
              "type": "string",
              "description": "Organization slug to assign the team to"
            },
            "description": "Organization slug to assign the team to."
          }
        }
      },
      "examples": {
        "default": {
          "value": {
            "organization_slugs": [
              "github"
            ]
          }
        }
      }
    }
  },
  "required": true
}

Responses

Parameters

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "organization_slugs"
        ],
        "properties": {
          "organization_slugs": {
            "type": "array",
            "items": {
              "type": "string",
              "description": "Organization slug to unassign the team from"
            },
            "description": "Organization slug to unassign the team from."
          }
        }
      },
      "examples": {
        "default": {
          "value": {
            "organization_slugs": [
              "github"
            ]
          }
        }
      }
    }
  },
  "required": true
}

Responses

Parameters

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "name"
        ],
        "properties": {
          "name": {
            "type": "string",
            "description": "The name of the team."
          },
          "group_id": {
            "type": "string",
            "nullable": true,
            "description": "The ID of the IdP group to assign team membership with. You can get this value from the [REST API endpoints for SCIM](https://docs.github.com/rest/scim#list-provisioned-scim-groups-for-an-enterprise)."
          },
          "description": {
            "type": "string",
            "nullable": true,
            "description": "A description of the team."
          },
          "sync_to_organizations": {
            "enum": [
              "all",
              "disabled"
            ],
            "type": "string",
            "default": "disabled",
            "description": "Retired: this field is no longer supported.\nWhether the enterprise team should be reflected in each organization.\nThis value cannot be set.\n"
          },
          "organization_selection_type": {
            "enum": [
              "disabled",
              "selected",
              "all"
            ],
            "type": "string",
            "default": "disabled",
            "description": "Specifies which organizations in the enterprise should have access to this team. Can be one of `disabled`, `selected`, or `all`.\n`disabled`: The team is not assigned to any organizations. This is the default when you create a new team.\n`selected`: The team is assigned to specific organizations. You can then use the [add organization assignments API](https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments) endpoint.\n`all`: The team is assigned to all current and future organizations in the enterprise.\n"
          }
        }
      },
      "examples": {
        "default": {
          "value": {
            "name": "Justice League",
            "group_id": "62ab9291-fae2-468e-974b-7e45096d5021",
            "description": "A great team."
          }
        }
      }
    }
  },
  "required": true
}

Responses

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "files"
        ],
        "properties": {
          "files": {
            "type": "object",
            "example": {
              "hello.rb": {
                "content": "puts \"Hello, World!\""
              }
            },
            "description": "Names and content for the files that make up the gist",
            "additionalProperties": {
              "type": "object",
              "required": [
                "content"
              ],
              "properties": {
                "content": {
                  "type": "string",
                  "readOnly": false,
                  "description": "Content of the file"
                }
              }
            }
          },
          "public": {
            "oneOf": [
              {
                "type": "boolean",
                "default": false,
                "example": true,
                "description": "Flag indicating whether the gist is public"
              },
              {
                "enum": [
                  "true",
                  "false"
                ],
                "type": "string",
                "default": "false",
                "example": "true"
              }
            ]
          },
          "description": {
            "type": "string",
            "example": "Example Ruby script",
            "description": "Description of the gist"
          }
        }
      },
      "examples": {
        "default": {
          "value": {
            "files": {
              "README.md": {
                "content": "Hello World"
              }
            },
            "public": false,
            "description": "Example of a gist"
          },
          "summary": "Creating a gist"
        }
      }
    }
  },
  "required": true
}

Responses

Parameters

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "body"
        ],
        "properties": {
          "body": {
            "type": "string",
            "example": "Body of the attachment",
            "maxLength": 65535,
            "description": "The comment text."
          }
        }
      },
      "examples": {
        "default": {
          "value": {
            "body": "This is a comment to a gist"
          },
          "summary": "Creating a comment in a gist"
        }
      }
    }
  },
  "required": true
}

Responses

Parameters

Responses

Parameters

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "content"
        ],
        "properties": {
          "content": {
            "type": "string",
            "description": "The new blob's content."
          },
          "encoding": {
            "type": "string",
            "default": "utf-8",
            "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported."
          }
        }
      },
      "examples": {
        "default": {
          "value": {
            "content": "Content of the blob",
            "encoding": "utf-8"
          }
        }
      }
    }
  },
  "required": true
}

Responses

Parameters

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "message",
          "tree"
        ],
        "properties": {
          "tree": {
            "type": "string",
            "description": "The SHA of the tree object this commit points to"
          },
          "author": {
            "type": "object",
            "required": [
              "name",
              "email"
            ],
            "properties": {
              "date": {
                "type": "string",
                "format": "date-time",
                "description": "Indicates when this commit was authored (or committed). This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`."
              },
              "name": {
                "type": "string",
                "description": "The name of the author (or committer) of the commit"
              },
              "email": {
                "type": "string",
                "description": "The email of the author (or committer) of the commit"
              }
            },
            "description": "Information about the author of the commit. By default, the `author` will be the authenticated user and the current date. See the `author` and `committer` object below for details."
          },
          "message": {
            "type": "string",
            "description": "The commit message"
          },
          "parents": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "The full SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided."
          },
          "committer": {
            "type": "object",
            "properties": {
              "date": {
                "type": "string",
                "format": "date-time",
                "description": "Indicates when this commit was authored (or committed). This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`."
              },
              "name": {
                "type": "string",
                "description": "The name of the author (or committer) of the commit"
              },
              "email": {
                "type": "string",
                "description": "The email of the author (or committer) of the commit"
              }
            },
            "description": "Information about the person who is making the commit. By default, `committer` will use the information set in `author`. See the `author` and `committer` object below for details."
          },
          "signature": {
            "type": "string",
            "description": "The [PGP signature](https://en.wikipedia.org/wiki/Pretty_Good_Privacy) of the commit. GitHub adds the signature to the `gpgsig` header of the created commit. For a commit signature to be verifiable by Git or GitHub, it must be an ASCII-armored detached PGP signature over the string commit as it would be written to the object database. To pass a `signature` parameter, you need to first manually create a valid PGP signature, which can be complicated. You may find it easier to [use the command line](https://git-scm.com/book/id/v2/Git-Tools-Signing-Your-Work) to create signed commits."
          }
        }
      },
      "examples": {
        "default": {
          "value": {
            "tree": "827efc6d56897b048c772eb4087f854f46256132",
            "author": {
              "date": "2008-07-09T16:13:30+12:00",
              "name": "Mona Octocat",
              "email": "octocat@github.com"
            },
            "message": "my commit message",
            "parents": [
              "7d1b31e74ee336d15cbd21741bc88a537ed063a0"
            ],
            "signature": "-----BEGIN PGP SIGNATURE-----\n\niQIzBAABAQAdFiEESn/54jMNIrGSE6Tp6cQjvhfv7nAFAlnT71cACgkQ6cQjvhfv\n7nCWwA//XVqBKWO0zF+bZl6pggvky3Oc2j1pNFuRWZ29LXpNuD5WUGXGG209B0hI\nDkmcGk19ZKUTnEUJV2Xd0R7AW01S/YSub7OYcgBkI7qUE13FVHN5ln1KvH2all2n\n2+JCV1HcJLEoTjqIFZSSu/sMdhkLQ9/NsmMAzpf/iIM0nQOyU4YRex9eD1bYj6nA\nOQPIDdAuaTQj1gFPHYLzM4zJnCqGdRlg0sOM/zC5apBNzIwlgREatOYQSCfCKV7k\nnrU34X8b9BzQaUx48Qa+Dmfn5KQ8dl27RNeWAqlkuWyv3pUauH9UeYW+KyuJeMkU\n+NyHgAsWFaCFl23kCHThbLStMZOYEnGagrd0hnm1TPS4GJkV4wfYMwnI4KuSlHKB\njHl3Js9vNzEUQipQJbgCgTiWvRJoK3ENwBTMVkKHaqT4x9U4Jk/XZB6Q8MA09ezJ\n3QgiTjTAGcum9E9QiJqMYdWQPWkaBIRRz5cET6HPB48YNXAAUsfmuYsGrnVLYbG+\nUpC6I97VybYHTy2O9XSGoaLeMI9CsFn38ycAxxbWagk5mhclNTP5mezIq6wKSwmr\nX11FW3n1J23fWZn5HJMBsRnUCgzqzX3871IqLYHqRJ/bpZ4h20RhTyPj5c/z7QXp\neSakNQMfbbMcljkha+ZMuVQX1K9aRlVqbmv3ZMWh+OijLYVU2bc=\n=5Io4\n-----END PGP SIGNATURE-----\n"
          }
        }
      }
    }
  },
  "required": true
}

Responses

Parameters

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "ref",
          "sha"
        ],
        "properties": {
          "ref": {
            "type": "string",
            "description": "The name of the fully qualified reference (ie: `refs/heads/master`). If it doesn't start with 'refs' and have at least two slashes, it will be rejected."
          },
          "sha": {
            "type": "string",
            "description": "The SHA1 value for this reference."
          }
        }
      },
      "examples": {
        "default": {
          "value": {
            "ref": "refs/heads/featureA",
            "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd"
          }
        }
      }
    }
  },
  "required": true
}

Responses

Parameters

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "tag",
          "message",
          "object",
          "type"
        ],
        "properties": {
          "tag": {
            "type": "string",
            "description": "The tag's name. This is typically a version (e.g., \"v0.0.1\")."
          },
          "type": {
            "enum": [
              "commit",
              "tree",
              "blob"
            ],
            "type": "string",
            "description": "The type of the object we're tagging. Normally this is a `commit` but it can also be a `tree` or a `blob`."
          },
          "object": {
            "type": "string",
            "description": "The SHA of the git object this is tagging."
          },
          "tagger": {
            "type": "object",
            "required": [
              "name",
              "email"
            ],
            "properties": {
              "date": {
                "type": "string",
                "format": "date-time",
                "description": "When this object was tagged. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`."
              },
              "name": {
                "type": "string",
                "description": "The name of the author of the tag"
              },
              "email": {
                "type": "string",
                "description": "The email of the author of the tag"
              }
            },
            "description": "An object with information about the individual creating the tag."
          },
          "message": {
            "type": "string",
            "description": "The tag message."
          }
        }
      },
      "examples": {
        "default": {
          "value": {
            "tag": "v0.0.1",
            "type": "commit",
            "object": "c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c",
            "tagger": {
              "date": "2011-06-17T14:53:35-07:00",
              "name": "Monalisa Octocat",
              "email": "octocat@github.com"
            },
            "message": "initial version"
          }
        }
      }
    }
  },
  "required": true
}

Responses

Parameters

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "tree"
        ],
        "properties": {
          "tree": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "sha": {
                  "type": "string",
                  "nullable": true,
                  "description": "The SHA1 checksum ID of the object in the tree. Also called `tree.sha`. If the value is `null` then the file will be deleted.  \n  \n**Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error."
                },
                "mode": {
                  "enum": [
                    "100644",
                    "100755",
                    "040000",
                    "160000",
                    "120000"
                  ],
                  "type": "string",
                  "description": "The file mode; one of `100644` for file (blob), `100755` for executable (blob), `040000` for subdirectory (tree), `160000` for submodule (commit), or `120000` for a blob that specifies the path of a symlink."
                },
                "path": {
                  "type": "string",
                  "description": "The file referenced in the tree."
                },
                "type": {
                  "enum": [
                    "blob",
                    "tree",
                    "commit"
                  ],
                  "type": "string",
                  "description": "Either `blob`, `tree`, or `commit`."
                },
                "content": {
                  "type": "string",
                  "description": "The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or `tree.sha`.  \n  \n**Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error."
                }
              }
            },
            "description": "Objects (of `path`, `mode`, `type`, and `sha`) specifying a tree structure."
          },
          "base_tree": {
            "type": "string",
            "description": "The SHA1 of an existing Git tree object which will be used as the base for the new tree. If provided, a new Git tree object will be created from entries in the Git tree object pointed to by `base_tree` and entries defined in the `tree` parameter. Entries defined in the `tree` parameter will overwrite items from `base_tree` with the same `path`. If you're creating new changes on a branch, then normally you'd set `base_tree` to the SHA1 of the Git tree object of the current latest commit on the branch you're working on.\nIf not provided, GitHub will create a new Git tree object from only the entries defined in the `tree` parameter. If you create a new commit pointing to such a tree, then all files which were a part of the parent commit's tree and were not defined in the `tree` parameter will be listed as deleted by the new commit."
          }
        }
      },
      "examples": {
        "default": {
          "value": {
            "tree": [
              {
                "sha": "44b4fc6d56897b048c772eb4087f854f46256132",
                "mode": "100644",
                "path": "file.rb",
                "type": "blob"
              }
            ],
            "base_tree": "9fb037999f264ba9a7fc6274d15fa3ae2ab98312"
          }
        }
      }
    }
  },
  "required": true
}

Responses

Parameters

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "name",
          "network_settings_ids"
        ],
        "properties": {
          "name": {
            "type": "string",
            "description": "Name of the network configuration. Must be between 1 and 100 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'."
          },
          "compute_service": {
            "enum": [
              "none",
              "actions"
            ],
            "type": "string",
            "description": "The hosted compute service to use for the network configuration."
          },
          "network_settings_ids": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "maxItems": 1,
            "minItems": 1,
            "description": "A list of identifiers of the network settings resources to use for the network configuration. Exactly one resource identifier must be specified in the list."
          },
          "failover_network_enabled": {
            "type": "boolean",
            "description": "Indicates whether the failover network resource is enabled."
          },
          "failover_network_settings_ids": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "maxItems": 1,
            "minItems": 0,
            "description": "A list of identifiers of the failover network settings resources to use for the network configuration. Exactly one resource identifier must be specified in the list."
          }
        }
      },
      "examples": {
        "default": {
          "value": {
            "name": "my-network-configuration",
            "compute_service": "actions",
            "network_settings_ids": [
              "23456789ABDCEF1"
            ]
          }
        }
      }
    }
  },
  "required": true
}

Responses

Parameters

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "title"
        ],
        "properties": {
          "body": {
            "type": "string",
            "description": "The contents of the issue."
          },
          "type": {
            "type": "string",
            "example": "Epic",
            "nullable": true,
            "description": "The name of the issue type to associate with this issue. _NOTE: Only users with push access can set the type for new issues. The type is silently dropped otherwise._"
          },
          "title": {
            "oneOf": [
              {
                "type": "string"
              },
              {
                "type": "integer"
              }
            ],
            "description": "The title of the issue."
          },
          "labels": {
            "type": "array",
            "items": {
              "oneOf": [
                {
                  "type": "string"
                },
                {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "integer"
                    },
                    "name": {
                      "type": "string"
                    },
                    "color": {
                      "type": "string",
                      "nullable": true
                    },
                    "description": {
                      "type": "string",
                      "nullable": true
                    }
                  }
                }
              ]
            },
            "description": "Labels to associate with this issue. _NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise._"
          },
          "assignee": {
            "type": "string",
            "nullable": true,
            "description": "Login for the user that this issue should be assigned to. _NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. **This field is closing down.**_"
          },
          "assignees": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "Logins for Users to assign to this issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._"
          },
          "milestone": {
            "oneOf": [
              {
                "type": "string"
              },
              {
                "type": "integer",
                "description": "The `number` of the milestone to associate this issue with. _NOTE: Only users with push access can set the milestone for new issues. The milestone is silently dropped otherwise._"
              }
            ],
            "nullable": true
          }
        }
      },
      "examples": {
        "default": {
          "value": {
            "body": "I'm having a problem with this.",
            "title": "Found a bug",
            "labels": [
              "bug"
            ],
            "assignees": [
              "octocat"
            ],
            "milestone": 1
          }
        }
      }
    }
  },
  "required": true
}

Responses

Parameters

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "assignees": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "Usernames of people to assign this issue to. _NOTE: Only users with push access can add assignees to an issue. Assignees are silently ignored otherwise._"
          }
        }
      },
      "examples": {
        "default": {
          "value": {
            "assignees": [
              "hubot",
              "other_user"
            ]
          }
        }
      }
    }
  },
  "required": false
}

Responses

Parameters

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "body"
        ],
        "properties": {
          "body": {
            "type": "string",
            "description": "The contents of the comment."
          }
        }
      },
      "examples": {
        "default": {
          "value": {
            "body": "Me too"
          }
        }
      }
    }
  },
  "required": true
}

Responses

Parameters

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "issue_id"
        ],
        "properties": {
          "issue_id": {
            "type": "integer",
            "description": "The id of the issue that blocks the current issue"
          }
        }
      },
      "examples": {
        "default": {
          "value": {
            "issue_id": 1
          }
        }
      }
    }
  },
  "required": true
}

Responses

Parameters

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "oneOf": [
          {
            "type": "object",
            "properties": {
              "labels": {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "minItems": 1,
                "description": "The names of the labels to add to the issue's existing labels. You can also pass an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. To replace all of the labels for an issue, use \"[Set labels for an issue](https://docs.github.com/rest/issues/labels#set-labels-for-an-issue).\""
              }
            }
          },
          {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "name"
              ],
              "properties": {
                "name": {
                  "type": "string"
                }
              }
            }
          }
        ]
      },
      "examples": {
        "default": {
          "value": {
            "labels": [
              "bug",
              "enhancement"
            ]
          }
        }
      }
    }
  },
  "required": false
}

Responses

Parameters

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "sub_issue_id"
        ],
        "properties": {
          "sub_issue_id": {
            "type": "integer",
            "description": "The id of the sub-issue to add. The sub-issue must belong to the same repository owner as the parent issue"
          },
          "replace_parent": {
            "type": "boolean",
            "description": "Option that, when true, instructs the operation to replace the sub-issues current parent issue"
          }
        }
      },
      "examples": {
        "default": {
          "value": {
            "sub_issue_id": 1
          }
        }
      }
    }
  },
  "required": true
}

Responses

Parameters

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "name"
        ],
        "properties": {
          "name": {
            "type": "string",
            "description": "The name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing `:strawberry:` will render the emoji ![:strawberry:](https://github.githubassets.com/images/icons/emoji/unicode/1f353.png \":strawberry:\"). For a full list of available emoji and codes, see \"[Emoji cheat sheet](https://github.com/ikatyang/emoji-cheat-sheet).\""
          },
          "color": {
            "type": "string",
            "description": "The [hexadecimal color code](http://www.color-hex.com/) for the label, without the leading `#`."
          },
          "description": {
            "type": "string",
            "description": "A short description of the label. Must be 100 characters or fewer."
          }
        }
      },
      "examples": {
        "default": {
          "value": {
            "name": "bug",
            "color": "f29513",
            "description": "Something isn't working"
          }
        }
      }
    }
  },
  "required": true
}

Responses

Parameters

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "title"
        ],
        "properties": {
          "state": {
            "enum": [
              "open",
              "closed"
            ],
            "type": "string",
            "default": "open",
            "description": "The state of the milestone. Either `open` or `closed`."
          },
          "title": {
            "type": "string",
            "description": "The title of the milestone."
          },
          "due_on": {
            "type": "string",
            "format": "date-time",
            "description": "The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`."
          },
          "description": {
            "type": "string",
            "description": "A description of the milestone."
          }
        }
      },
      "examples": {
        "default": {
          "value": {
            "state": "open",
            "title": "v1.0",
            "due_on": "2012-10-09T23:39:01Z",
            "description": "Tracking milestone for version 1.0"
          }
        }
      }
    }
  },
  "required": true
}

Responses

Parameters

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "issue_field_values": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "field_id",
                "value"
              ],
              "properties": {
                "value": {
                  "oneOf": [
                    {
                      "type": "string",
                      "description": "The value to set for text, single_select, or date fields"
                    },
                    {
                      "type": "number",
                      "description": "The value to set for number fields"
                    }
                  ],
                  "example": "Critical",
                  "description": "The value to set for the field. The type depends on the field's data type:\n- For text fields: provide a string value\n- For single_select fields: provide the option name as a string (must match an existing option)\n- For number fields: provide a numeric value\n- For date fields: provide an ISO 8601 date string"
                },
                "field_id": {
                  "type": "integer",
                  "example": 123,
                  "description": "The ID of the issue field to set"
                }
              },
              "additionalProperties": false
            },
            "maxItems": 25,
            "description": "An array of issue field values to add to this issue. Each field value must include the field ID and the value to set."
          }
        }
      },
      "examples": {
        "default": {
          "value": {
            "issue_field_values": [
              {
                "value": "Critical",
                "field_id": 123
              },
              {
                "value": 5,
                "field_id": 456
              },
              {
                "value": "2024-12-31",
                "field_id": 789
              }
            ]
          },
          "summary": "Add multiple field values"
        },
        "single-field": {
          "value": {
            "issue_field_values": [
              {
                "value": "High Priority",
                "field_id": 123
              }
            ]
          },
          "summary": "Add a single field value"
        }
      }
    }
  },
  "required": true
}

Responses

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "text"
        ],
        "properties": {
          "mode": {
            "enum": [
              "markdown",
              "gfm"
            ],
            "type": "string",
            "default": "markdown",
            "example": "markdown",
            "description": "The rendering mode."
          },
          "text": {
            "type": "string",
            "description": "The Markdown text to render in HTML."
          },
          "context": {
            "type": "string",
            "description": "The repository context to use when creating references in `gfm` mode.  For example, setting `context` to `octo-org/octo-repo` will change the text `#42` into an HTML link to issue 42 in the `octo-org/octo-repo` repository."
          }
        }
      },
      "examples": {
        "default": {
          "value": {
            "text": "Hello **world**"
          },
          "summary": "Rendering markdown"
        }
      }
    }
  },
  "required": true
}

Responses

Request Body

{
  "content": {
    "text/plain": {
      "schema": {
        "type": "string"
      },
      "examples": {
        "default": {
          "value": {
            "text": "Hello **world**"
          }
        }
      }
    },
    "text/x-markdown": {
      "schema": {
        "type": "string"
      },
      "examples": {
        "default": {
          "value": {
            "text": "Hello **world**"
          },
          "summary": "Rendering markdown"
        }
      }
    }
  },
  "required": false
}

Responses

Parameters

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "repositories"
        ],
        "properties": {
          "exclude": {
            "type": "array",
            "items": {
              "enum": [
                "repositories"
              ],
              "type": "string"
            },
            "description": "Exclude related items from being returned in the response in order to improve performance of the request."
          },
          "repositories": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "A list of arrays indicating which repositories should be migrated."
          },
          "exclude_git_data": {
            "type": "boolean",
            "default": false,
            "description": "Indicates whether the repository git data should be excluded from the migration."
          },
          "exclude_metadata": {
            "type": "boolean",
            "default": false,
            "description": "Indicates whether metadata should be excluded and only git source should be included for the migration."
          },
          "exclude_releases": {
            "type": "boolean",
            "default": false,
            "example": true,
            "description": "Indicates whether releases should be excluded from the migration (to reduce migration archive file size)."
          },
          "lock_repositories": {
            "type": "boolean",
            "default": false,
            "example": true,
            "description": "Indicates whether repositories should be locked (to prevent manipulation) while migrating data."
          },
          "org_metadata_only": {
            "type": "boolean",
            "default": false,
            "example": true,
            "description": "Indicates whether this should only include organization metadata (repositories array should be empty and will ignore other flags)."
          },
          "exclude_attachments": {
            "type": "boolean",
            "default": false,
            "example": true,
            "description": "Indicates whether attachments should be excluded from the migration (to reduce migration archive file size)."
          },
          "exclude_owner_projects": {
            "type": "boolean",
            "default": false,
            "example": true,
            "description": "Indicates whether projects owned by the organization or users should be excluded. from the migration."
          }
        }
      },
      "examples": {
        "default": {
          "value": {
            "repositories": [
              "github/Hello-World"
            ],
            "lock_repositories": true
          }
        }
      }
    }
  },
  "required": true
}

Responses

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "repositories"
        ],
        "properties": {
          "exclude": {
            "type": "array",
            "items": {
              "enum": [
                "repositories"
              ],
              "type": "string",
              "example": "repositories",
              "description": "Allowed values that can be passed to the exclude param."
            },
            "example": [
              "repositories"
            ],
            "readOnly": false,
            "description": "Exclude attributes from the API response to improve performance"
          },
          "repositories": {
            "type": "array",
            "items": {
              "type": "string",
              "example": "acme/widgets",
              "description": "Repository path, owner and name"
            }
          },
          "exclude_git_data": {
            "type": "boolean",
            "example": true,
            "readOnly": false,
            "description": "Indicates whether the repository git data should be excluded from the migration."
          },
          "exclude_metadata": {
            "type": "boolean",
            "example": true,
            "readOnly": false,
            "description": "Indicates whether metadata should be excluded and only git source should be included for the migration."
          },
          "exclude_releases": {
            "type": "boolean",
            "example": true,
            "readOnly": false,
            "description": "Do not include releases in the migration"
          },
          "lock_repositories": {
            "type": "boolean",
            "example": true,
            "readOnly": false,
            "description": "Lock the repositories being migrated at the start of the migration"
          },
          "org_metadata_only": {
            "type": "boolean",
            "default": false,
            "example": true,
            "description": "Indicates whether this should only include organization metadata (repositories array should be empty and will ignore other flags)."
          },
          "exclude_attachments": {
            "type": "boolean",
            "example": true,
            "readOnly": false,
            "description": "Do not include attachments in the migration"
          },
          "exclude_owner_projects": {
            "type": "boolean",
            "example": true,
            "readOnly": false,
            "description": "Indicates whether projects owned by the organization or users should be excluded."
          }
        }
      },
      "examples": {
        "default": {
          "value": {
            "repositories": [
              "octocat/Hello-World"
            ],
            "lock_repositories": true
          }
        }
      }
    }
  },
  "required": true
}

Responses

Parameters

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/oidc-custom-property-inclusion-input"
      },
      "examples": {
        "default": {
          "$ref": "#/components/examples/oidc-custom-property-inclusion"
        }
      }
    }
  },
  "required": true
}

Responses

Parameters

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/oidc-custom-property-inclusion-input"
      },
      "examples": {
        "default": {
          "$ref": "#/components/examples/oidc-custom-property-inclusion"
        }
      }
    }
  },
  "required": true
}

Responses

Parameters

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "name",
          "digest",
          "status",
          "logical_environment",
          "deployment_name"
        ],
        "properties": {
          "name": {
            "type": "string",
            "example": "libfoo",
            "maxLength": 256,
            "minLength": 1,
            "description": "The name of the artifact."
          },
          "tags": {
            "type": "object",
            "description": "The tags associated with the deployment.",
            "maxProperties": 5,
            "additionalProperties": {
              "type": "string"
            }
          },
          "digest": {
            "type": "string",
            "pattern": "^sha256:[a-f0-9]{64}$",
            "maxLength": 71,
            "minLength": 71,
            "description": "The hex encoded digest of the artifact."
          },
          "status": {
            "enum": [
              "deployed",
              "decommissioned"
            ],
            "type": "string",
            "description": "The status of the artifact. Can be either deployed or decommissioned."
          },
          "cluster": {
            "type": "string",
            "maxLength": 128,
            "description": "The deployment cluster."
          },
          "version": {
            "type": "string",
            "example": "1.2.3",
            "maxLength": 100,
            "minLength": 1,
            "description": "The artifact version.",
            "x-multi-segment": true
          },
          "runtime_risks": {
            "type": "array",
            "items": {
              "enum": [
                "critical-resource",
                "internet-exposed",
                "lateral-movement",
                "sensitive-data"
              ],
              "type": "string"
            },
            "maxItems": 4,
            "description": "A list of runtime risks associated with the deployment.",
            "uniqueItems": true
          },
          "return_records": {
            "type": "boolean",
            "default": true,
            "description": "If true, the endpoint will return the created or updated record in the response body.\n"
          },
          "deployment_name": {
            "type": "string",
            "maxLength": 256,
            "description": "The unique identifier for the deployment represented by the new record. To accommodate differing\ncontainers and namespaces within a cluster, the following format is recommended:\n{namespaceName}-{deploymentName}-{containerName}.\n"
          },
          "github_repository": {
            "type": "string",
            "example": "my-github-repo",
            "pattern": "^[A-Za-z0-9.\\-_]+$",
            "maxLength": 100,
            "minLength": 1,
            "description": "The name of the GitHub repository associated with the artifact. This should be used\nwhen there are no provenance attestations available for the artifact. The repository\nmust belong to the organization specified in the path parameter.\n\nIf a provenance attestation is available for the artifact, the API will use\nthe repository information from the attestation instead of this parameter."
          },
          "logical_environment": {
            "type": "string",
            "maxLength": 128,
            "minLength": 1,
            "description": "The stage of the deployment."
          },
          "physical_environment": {
            "type": "string",
            "maxLength": 128,
            "description": "The physical region of the deployment."
          }
        }
      },
      "examples": {
        "default": {
          "value": {
            "name": "awesome-image",
            "tags": {
              "data-access": "sensitive"
            },
            "digest": "sha256:1bb1e949e55dcefc6353e7b36c8897d2a107d8e8dca49d4e3c0ea8493fc0bc72",
            "status": "deployed",
            "cluster": "moda-1",
            "deployment_name": "deployment-pod",
            "logical_environment": "prod",
            "physical_environment": "pacific-east"
          }
        }
      }
    }
  },
  "required": true
}

Responses

Parameters

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "logical_environment",
          "deployments"
        ],
        "properties": {
          "deployments": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "name",
                "deployment_name",
                "digest"
              ],
              "properties": {
                "name": {
                  "type": "string",
                  "maxLength": 256,
                  "minLength": 1,
                  "description": "The name of the artifact. Note that if multiple deployments have identical 'digest' parameter values,\nthe name parameter must also be identical across all entries.\n"
                },
                "tags": {
                  "type": "object",
                  "description": "Key-value pairs to tag the deployment record.",
                  "additionalProperties": {
                    "type": "string"
                  }
                },
                "digest": {
                  "type": "string",
                  "pattern": "^sha256:[a-f0-9]{64}$",
                  "maxLength": 71,
                  "minLength": 71,
                  "description": "The hex encoded digest of the artifact. Note that if multiple deployments have identical 'digest' parameter values,\nthe name and version parameters must also be identical across all entries.\n"
                },
                "status": {
                  "enum": [
                    "deployed",
                    "decommissioned"
                  ],
                  "type": "string",
                  "default": "deployed",
                  "description": "The deployment status of the artifact."
                },
                "version": {
                  "type": "string",
                  "example": "1.2.3",
                  "maxLength": 100,
                  "description": "The artifact version. Note that if multiple deployments have identical 'digest' parameter values,\nthe version parameter must also be identical across all entries.\n",
                  "x-multi-segment": true
                },
                "runtime_risks": {
                  "type": "array",
                  "items": {
                    "enum": [
                      "critical-resource",
                      "internet-exposed",
                      "lateral-movement",
                      "sensitive-data"
                    ],
                    "type": "string"
                  },
                  "maxItems": 4,
                  "description": "A list of runtime risks associated with the deployment.",
                  "uniqueItems": true
                },
                "deployment_name": {
                  "type": "string",
                  "maxLength": 256,
                  "minLength": 1,
                  "description": "The unique identifier for the deployment represented by the new record. To accommodate differing\ncontainers and namespaces within a record set, the following format is recommended:\n{namespaceName}-{deploymentName}-{containerName}.\nThe deployment_name must be unique across all entries in the deployments array.\n"
                },
                "github_repository": {
                  "type": "string",
                  "example": "my-github-repo",
                  "pattern": "^[A-Za-z0-9.\\-_]+$",
                  "maxLength": 100,
                  "description": "The name of the GitHub repository associated with the artifact. This should be used\nwhen there are no provenance attestations available for the artifact. The repository\nmust belong to the organization specified in the path parameter.\n\nIf a provenance attestation is available for the artifact, the API will use\nthe repository information from the attestation instead of this parameter."
                }
              }
            },
            "maxItems": 1000,
            "description": "The list of deployments to record."
          },
          "return_records": {
            "type": "boolean",
            "default": true,
            "description": "If true, the endpoint will return the set records in the response body\n"
          },
          "logical_environment": {
            "type": "string",
            "maxLength": 128,
            "minLength": 1,
            "description": "The stage of the deployment."
          },
          "physical_environment": {
            "type": "string",
            "maxLength": 128,
            "description": "The physical region of the deployment."
          }
        }
      },
      "examples": {
        "default": {
          "value": {
            "deployments": [
              {
                "name": "awesome-image",
                "tags": {
                  "runtime-risk": "sensitive-data"
                },
                "digest": "sha256:1bb1e949e55dcefc6353e7b36c8897d2a107d8e8dca49d4e3c0ea8493fc0bc72",
                "status": "deployed",
                "version": "2.1.0",
                "deployment_name": "deployment-pod"
              }
            ],
            "logical_environment": "prod",
            "physical_environment": "pacific-east"
          }
        }
      }
    }
  },
  "required": true
}

Responses

Parameters

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "name",
          "digest",
          "registry_url"
        ],
        "properties": {
          "name": {
            "type": "string",
            "example": "libfoo",
            "maxLength": 256,
            "minLength": 1,
            "description": "The name of the artifact."
          },
          "path": {
            "type": "string",
            "format": "uri",
            "example": "com/github/bar/libfoo-1.2.3",
            "description": "The path of the artifact."
          },
          "digest": {
            "type": "string",
            "example": "sha256:0ecbaa601dba202129058746c7d8e3f282d0efb5fff0...",
            "pattern": "^sha256:[a-f0-9]{64}$",
            "maxLength": 71,
            "minLength": 71,
            "description": "The digest of the artifact (algorithm:hex-encoded-digest)."
          },
          "status": {
            "enum": [
              "active",
              "eol",
              "deleted"
            ],
            "type": "string",
            "default": "active",
            "example": "active",
            "description": "The status of the artifact (e.g., active, inactive)."
          },
          "version": {
            "type": "string",
            "example": "1.2.3",
            "maxLength": 100,
            "minLength": 1,
            "description": "The artifact version.",
            "x-multi-segment": true
          },
          "repository": {
            "type": "string",
            "example": "bar",
            "description": "The repository name within the registry."
          },
          "artifact_url": {
            "type": "string",
            "format": "uri",
            "example": "https://reg.example.com/artifactory/bar/libfoo-1.2.3",
            "pattern": "^https://",
            "description": "The URL where the artifact is stored."
          },
          "registry_url": {
            "type": "string",
            "format": "uri",
            "example": "https://reg.example.com/artifactory/",
            "pattern": "^https://",
            "minLength": 1,
            "description": "The base URL of the artifact registry."
          },
          "return_records": {
            "type": "boolean",
            "default": true,
            "description": "If true, the endpoint will return the created record in the response body.\n"
          },
          "github_repository": {
            "type": "string",
            "example": "my-github-repo",
            "pattern": "^[A-Za-z0-9.\\-_]+$",
            "maxLength": 100,
            "minLength": 1,
            "description": "The name of the GitHub repository associated with the artifact. This should be used\nwhen there are no provenance attestations available for the artifact. The repository\nmust belong to the organization specified in the path parameter.\n\nIf a provenance attestation is available for the artifact, the API will use\nthe repository information from the attestation instead of this parameter."
          }
        }
      },
      "examples": {
        "default": {
          "value": {
            "name": "libfoo",
            "digest": "sha256:1bb1e949e55dcefc6353e7b36c8897d2a107d8e8dca49d4e3c0ea8493fc0bc72",
            "status": "active",
            "version": "1.2.3",
            "repository": "bar",
            "artifact_url": "https://reg.example.com/artifactory/bar/libfoo-1.2.3",
            "registry_url": "https://reg.example.com/artifactory/"
          }
        }
      }
    }
  },
  "required": true
}

Responses

Parameters

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "subject_digests"
        ],
        "properties": {
          "predicate_type": {
            "type": "string",
            "description": "Optional filter for fetching attestations with a given predicate type.\nThis option accepts `provenance`, `sbom`, `release`, or freeform text\nfor custom predicate types."
          },
          "subject_digests": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "maxItems": 1024,
            "minItems": 1,
            "description": "List of subject digests to fetch attestations for."
          }
        }
      },
      "examples": {
        "default": {
          "$ref": "#/components/examples/bulk-subject-digest-body"
        },
        "withPredicateType": {
          "$ref": "#/components/examples/bulk-subject-digest-body-with-predicate-type"
        }
      }
    }
  },
  "required": true
}

Responses

Parameters

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "oneOf": [
          {
            "required": [
              "subject_digests"
            ],
            "properties": {
              "subject_digests": {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "maxItems": 1024,
                "minItems": 1,
                "description": "List of subject digests associated with the artifact attestations to delete."
              }
            }
          },
          {
            "required": [
              "attestation_ids"
            ],
            "properties": {
              "attestation_ids": {
                "type": "array",
                "items": {
                  "type": "integer"
                },
                "maxItems": 1024,
                "minItems": 1,
                "description": "List of unique IDs associated with the artifact attestations to delete."
              }
            }
          }
        ],
        "description": "The request body must include either `subject_digests` or `attestation_ids`, but not both."
      },
      "examples": {
        "by-attestation-ids": {
          "value": {
            "attestation_ids": [
              111,
              222
            ]
          },
          "summary": "Delete by attestation IDs"
        },
        "by-subject-digests": {
          "value": {
            "subject_digests": [
              "sha256:abc123",
              "sha512:def456"
            ]
          },
          "summary": "Delete by subject digests"
        }
      }
    }
  },
  "required": true
}

Responses

Parameters

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "name",
          "config"
        ],
        "properties": {
          "name": {
            "type": "string",
            "description": "Must be passed as \"web\"."
          },
          "active": {
            "type": "boolean",
            "default": true,
            "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications."
          },
          "config": {
            "type": "object",
            "required": [
              "url"
            ],
            "properties": {
              "url": {
                "$ref": "#/components/schemas/webhook-config-url"
              },
              "secret": {
                "$ref": "#/components/schemas/webhook-config-secret"
              },
              "password": {
                "type": "string",
                "example": "\"password\""
              },
              "username": {
                "type": "string",
                "example": "\"kdaigle\""
              },
              "content_type": {
                "$ref": "#/components/schemas/webhook-config-content-type"
              },
              "insecure_ssl": {
                "$ref": "#/components/schemas/webhook-config-insecure-ssl"
              }
            },
            "description": "Key/value pairs to provide settings for this webhook."
          },
          "events": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "default": [
              "push"
            ],
            "description": "Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for. Set to `[\"*\"]` to receive all possible events."
          }
        }
      },
      "examples": {
        "default": {
          "value": {
            "name": "web",
            "active": true,
            "config": {
              "url": "http://example.com/webhook",
              "content_type": "json"
            },
            "events": [
              "push",
              "pull_request"
            ]
          }
        }
      }
    }
  },
  "required": true
}

Responses

Parameters

Responses

Parameters

Responses

Parameters

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "role": {
            "enum": [
              "admin",
              "direct_member",
              "billing_manager",
              "reinstate"
            ],
            "type": "string",
            "default": "direct_member",
            "description": "The role for the new member. \n * `admin` - Organization owners with full administrative rights to the organization and complete access to all repositories and teams.  \n * `direct_member` - Non-owner organization members with ability to see other members and join teams by invitation.  \n * `billing_manager` - Non-owner organization members with ability to manage the billing settings of your organization. \n * `reinstate` - The previous role assigned to the invitee before they were removed from your organization. Can be one of the roles listed above. Only works if the invitee was previously part of your organization."
          },
          "email": {
            "type": "string",
            "description": "**Required unless you provide `invitee_id`**. Email address of the person you are inviting, which can be an existing GitHub user."
          },
          "team_ids": {
            "type": "array",
            "items": {
              "type": "integer"
            },
            "description": "Specify IDs for the teams you want to invite new members to."
          },
          "invitee_id": {
            "type": "integer",
            "description": "**Required unless you provide `email`**. GitHub user ID for the person you are inviting."
          }
        }
      },
      "examples": {
        "default": {
          "value": {
            "role": "direct_member",
            "email": "octocat@github.com",
            "team_ids": [
              12,
              26
            ]
          }
        }
      }
    }
  },
  "required": false
}

Responses

Parameters

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/organization-create-issue-field"
      },
      "examples": {
        "default": {
          "value": {
            "name": "Priority",
            "options": [
              {
                "name": "High",
                "color": "red",
                "description": "High priority"
              },
              {
                "name": "Medium",
                "color": "yellow",
                "description": "Medium priority"
              },
              {
                "name": "Low",
                "color": "green",
                "description": "Low priority"
              }
            ],
            "data_type": "single_select",
            "description": "Level of importance for the issue"
          }
        }
      }
    }
  },
  "required": true
}

Responses

Parameters

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/organization-create-issue-type"
      },
      "examples": {
        "default": {
          "value": {
            "name": "Epic",
            "color": "green",
            "is_enabled": true,
            "description": "An issue type for a multi-week tracking of work"
          }
        }
      }
    }
  },
  "required": true
}

Responses

Parameters

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "action"
        ],
        "properties": {
          "action": {
            "enum": [
              "approve",
              "deny"
            ],
            "type": "string",
            "description": "Action to apply to the requests."
          },
          "reason": {
            "type": "string",
            "nullable": true,
            "maxLength": 1024,
            "description": "Reason for approving or denying the requests. Max 1024 characters."
          },
          "pat_request_ids": {
            "type": "array",
            "items": {
              "type": "integer"
            },
            "maxItems": 100,
            "minItems": 1,
            "description": "Unique identifiers of the requests for access via fine-grained personal access token. Must be formed of between 1 and 100 `pat_request_id` values."
          }
        }
      },
      "examples": {
        "204": {
          "value": {
            "action": "deny",
            "reason": "Access is too broad.",
            "pat_request_ids": [
              42,
              73
            ]
          },
          "summary": "Example of denying a request"
        }
      }
    }
  },
  "required": true
}

Responses

Parameters

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "action"
        ],
        "properties": {
          "action": {
            "enum": [
              "approve",
              "deny"
            ],
            "type": "string",
            "description": "Action to apply to the request."
          },
          "reason": {
            "type": "string",
            "nullable": true,
            "maxLength": 1024,
            "description": "Reason for approving or denying the request. Max 1024 characters."
          }
        }
      },
      "examples": {
        "204": {
          "value": {
            "action": "deny",
            "reason": "This request is denied because the access is too broad."
          },
          "summary": "Example of denying a request"
        }
      }
    }
  },
  "required": true
}

Responses

Parameters

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "action",
          "pat_ids"
        ],
        "properties": {
          "action": {
            "enum": [
              "revoke"
            ],
            "type": "string",
            "description": "Action to apply to the fine-grained personal access token."
          },
          "pat_ids": {
            "type": "array",
            "items": {
              "type": "integer",
              "description": "Unique identifier of the fine-grained personal access token."
            },
            "maxItems": 100,
            "minItems": 1,
            "description": "The IDs of the fine-grained personal access tokens."
          }
        }
      },
      "examples": {
        "204": {
          "value": {
            "action": "revoke",
            "pat_ids": [
              1296269,
              1296280
            ]
          },
          "summary": "Example of revoking a fine-grained personal access token."
        }
      }
    }
  },
  "required": true
}

Responses

Parameters

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "action"
        ],
        "properties": {
          "action": {
            "enum": [
              "revoke"
            ],
            "type": "string",
            "description": "Action to apply to the fine-grained personal access token."
          }
        }
      },
      "examples": {
        "204": {
          "value": {
            "action": "revoke"
          },
          "summary": "Example of revoking a fine-grained personal access token."
        }
      }
    }
  },
  "required": true
}

Responses

Parameters

Responses

Parameters

Responses

Parameters

Responses

Parameters

Responses

Parameters

Responses

Parameters

Responses

Parameters

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "registry_type",
          "url",
          "visibility"
        ],
        "properties": {
          "url": {
            "type": "string",
            "format": "uri",
            "description": "The URL of the private registry."
          },
          "domain": {
            "type": "string",
            "description": "The CodeArtifact domain. Required when `auth_type` is `oidc_aws`."
          },
          "key_id": {
            "type": "string",
            "description": "The ID of the key you used to encrypt the secret. Required when `auth_type` is `token` or `username_password`. Should be omitted for OIDC auth types."
          },
          "audience": {
            "type": "string",
            "description": "The OIDC audience. Optional for `oidc_aws` and `oidc_jfrog` auth types."
          },
          "username": {
            "type": "string",
            "nullable": true,
            "description": "The username to use when authenticating with the private registry. This field should be omitted if the private registry does not require a username for authentication."
          },
          "auth_type": {
            "enum": [
              "token",
              "username_password",
              "oidc_azure",
              "oidc_aws",
              "oidc_jfrog"
            ],
            "type": "string",
            "description": "The authentication type for the private registry. Defaults to `token` if not specified. Use `oidc_azure`, `oidc_aws`, or `oidc_jfrog` for OIDC authentication."
          },
          "client_id": {
            "type": "string",
            "description": "The client ID of the Azure AD application. Required when `auth_type` is `oidc_azure`."
          },
          "role_name": {
            "type": "string",
            "description": "The AWS IAM role name. Required when `auth_type` is `oidc_aws`."
          },
          "tenant_id": {
            "type": "string",
            "description": "The tenant ID of the Azure AD application. Required when `auth_type` is `oidc_azure`."
          },
          "account_id": {
            "type": "string",
            "description": "The AWS account ID. Required when `auth_type` is `oidc_aws`."
          },
          "aws_region": {
            "type": "string",
            "description": "The AWS region. Required when `auth_type` is `oidc_aws`."
          },
          "visibility": {
            "enum": [
              "all",
              "private",
              "selected"
            ],
            "type": "string",
            "description": "Which type of organization repositories have access to the private registry. `selected` means only the repositories specified by `selected_repository_ids` can access the private registry."
          },
          "domain_owner": {
            "type": "string",
            "description": "The CodeArtifact domain owner (AWS account ID). Required when `auth_type` is `oidc_aws`."
          },
          "registry_type": {
            "enum": [
              "maven_repository",
              "nuget_feed",
              "goproxy_server",
              "npm_registry",
              "rubygems_server",
              "cargo_registry",
              "composer_repository",
              "docker_registry",
              "git_source",
              "helm_registry",
              "hex_organization",
              "hex_repository",
              "pub_repository",
              "python_index",
              "terraform_registry"
            ],
            "type": "string",
            "description": "The registry type."
          },
          "replaces_base": {
            "type": "boolean",
            "default": false,
            "description": "Whether this private registry should replace the base registry (e.g., npmjs.org for npm, rubygems.org for rubygems). When set to `true`, Dependabot will only use this registry and will not fall back to the public registry. When set to `false` (default), Dependabot will use this registry for scoped packages but may fall back to the public registry for other packages."
          },
          "encrypted_value": {
            "type": "string",
            "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$",
            "description": "The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get private registries public key for an organization](https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) endpoint. Required when `auth_type` is `token` or `username_password`. Should be omitted for OIDC auth types."
          },
          "identity_mapping_name": {
            "type": "string",
            "description": "The JFrog identity mapping name. Optional for `oidc_jfrog` auth type."
          },
          "selected_repository_ids": {
            "type": "array",
            "items": {
              "type": "integer"
            },
            "description": "An array of repository IDs that can access the organization private registry. You can only provide a list of repository IDs when `visibility` is set to `selected`. You can manage the list of selected repositories using the [Update a private registry for an organization](https://docs.github.com/rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization) endpoint. This field should be omitted if `visibility` is set to `all` or `private`."
          },
          "jfrog_oidc_provider_name": {
            "type": "string",
            "description": "The JFrog OIDC provider name. Required when `auth_type` is `oidc_jfrog`."
          }
        }
      },
      "examples": {
        "org-private-registry-with-oidc-azure": {
          "value": {
            "url": "https://myregistry.azurecr.io",
            "auth_type": "oidc_azure",
            "client_id": "abcdef01-2345-6789-abcd-ef0123456789",
            "tenant_id": "12345678-1234-1234-1234-123456789012",
            "visibility": "all",
            "registry_type": "docker_registry"
          },
          "summary": "Example of an OIDC private registry configuration using Azure"
        },
        "org-private-registry-with-private-visibility": {
          "value": {
            "url": "https://maven.pkg.github.com/organization/",
            "key_id": "012345678912345678",
            "username": "monalisa",
            "visibility": "private",
            "registry_type": "maven_repository",
            "replaces_base": true,
            "encrypted_value": "c2VjcmV0"
          },
          "summary": "Example of a private registry configuration with private visibility"
        },
        "org-private-registry-with-selected-visibility": {
          "value": {
            "url": "https://maven.pkg.github.com/organization/",
            "key_id": "012345678912345678",
            "username": "monalisa",
            "visibility": "selected",
            "registry_type": "maven_repository",
            "encrypted_value": "c2VjcmV0",
            "selected_repository_ids": [
              1296269,
              1296280
            ]
          },
          "summary": "Example of a private registry configuration with selected visibility"
        }
      }
    }
  },
  "required": true
}

Responses

Parameters

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "title"
        ],
        "properties": {
          "body": {
            "type": "string",
            "description": "The body content of the draft issue item to create in the project."
          },
          "title": {
            "type": "string",
            "description": "The title of the draft issue item to create in the project."
          }
        }
      },
      "examples": {
        "body": {
          "value": {
            "body": "This is the body content of the draft issue.",
            "title": "Sample Draft Issue Title"
          },
          "summary": "Example with Sample Draft Issue Title and Body"
        },
        "title": {
          "value": {
            "title": "Sample Draft Issue Title"
          },
          "summary": "Example with Sample Draft Issue Title"
        }
      }
    }
  },
  "required": true,
  "description": "Details of the draft item to create in the project."
}

Responses

Parameters

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "oneOf": [
          {
            "type": "object",
            "required": [
              "issue_field_id"
            ],
            "properties": {
              "issue_field_id": {
                "type": "integer",
                "description": "The ID of the IssueField to create the field for."
              }
            },
            "additionalProperties": false
          },
          {
            "type": "object",
            "required": [
              "name",
              "data_type"
            ],
            "properties": {
              "name": {
                "type": "string",
                "description": "The name of the field."
              },
              "data_type": {
                "enum": [
                  "text",
                  "number",
                  "date"
                ],
                "type": "string",
                "description": "The field's data type."
              }
            },
            "additionalProperties": false
          },
          {
            "type": "object",
            "required": [
              "name",
              "data_type",
              "single_select_options"
            ],
            "properties": {
              "name": {
                "type": "string",
                "description": "The name of the field."
              },
              "data_type": {
                "enum": [
                  "single_select"
                ],
                "type": "string",
                "description": "The field's data type."
              },
              "single_select_options": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/projects-v2-field-single-select-option"
                },
                "description": "The options available for single select fields. At least one option must be provided when creating a single select field."
              }
            },
            "additionalProperties": false
          },
          {
            "type": "object",
            "required": [
              "name",
              "data_type",
              "iteration_configuration"
            ],
            "properties": {
              "name": {
                "type": "string",
                "description": "The name of the field."
              },
              "data_type": {
                "enum": [
                  "iteration"
                ],
                "type": "string",
                "description": "The field's data type."
              },
              "iteration_configuration": {
                "$ref": "#/components/schemas/projects-v2-field-iteration-configuration"
              }
            },
            "additionalProperties": false
          }
        ]
      },
      "examples": {
        "date_field": {
          "value": {
            "name": "Due date",
            "data_type": "date"
          },
          "summary": "Create a date field"
        },
        "text_field": {
          "value": {
            "name": "Team notes",
            "data_type": "text"
          },
          "summary": "Create a text field"
        },
        "number_field": {
          "value": {
            "name": "Story points",
            "data_type": "number"
          },
          "summary": "Create a number field"
        },
        "iteration_field": {
          "$ref": "#/components/examples/projects-v2-field-iteration-request"
        },
        "single_select_field": {
          "$ref": "#/components/examples/projects-v2-field-single-select-request"
        }
      }
    }
  },
  "required": true
}

Responses

Parameters

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "oneOf": [
          {
            "required": [
              "id"
            ]
          },
          {
            "required": [
              "owner",
              "repo",
              "number"
            ]
          }
        ],
        "required": [
          "type"
        ],
        "properties": {
          "id": {
            "type": "integer",
            "description": "The unique identifier of the issue or pull request to add to the project."
          },
          "repo": {
            "type": "string",
            "description": "The repository name."
          },
          "type": {
            "enum": [
              "Issue",
              "PullRequest"
            ],
            "type": "string",
            "description": "The type of item to add to the project. Must be either Issue or PullRequest."
          },
          "owner": {
            "type": "string",
            "description": "The repository owner login."
          },
          "number": {
            "type": "integer",
            "description": "The issue or pull request number."
          }
        },
        "additionalProperties": false
      },
      "examples": {
        "issue_with_id": {
          "value": {
            "id": 3,
            "type": "Issue"
          },
          "summary": "Add an issue using its unique ID"
        },
        "issue_with_nwo": {
          "value": {
            "repo": "hello-world",
            "type": "Issue",
            "owner": "octocat",
            "number": 42
          },
          "summary": "Add an issue using repository owner, name, and issue number"
        },
        "pull_request_with_id": {
          "value": {
            "id": 3,
            "type": "PullRequest"
          },
          "summary": "Add a pull request using its unique ID"
        },
        "pull_request_with_nwo": {
          "value": {
            "repo": "hello-world",
            "type": "PullRequest",
            "owner": "octocat",
            "number": 123
          },
          "summary": "Add a pull request using repository owner, name, and PR number"
        }
      }
    }
  },
  "required": true,
  "description": "Details of the item to add to the project. You can specify either the unique ID or the repository owner, name, and issue/PR number."
}

Responses

Parameters

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "name",
          "layout"
        ],
        "properties": {
          "name": {
            "type": "string",
            "example": "Sprint Board",
            "description": "The name of the view."
          },
          "filter": {
            "type": "string",
            "example": "is:issue is:open",
            "description": "The filter query for the view. See [Filtering projects](https://docs.github.com/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) for more information."
          },
          "layout": {
            "enum": [
              "table",
              "board",
              "roadmap"
            ],
            "type": "string",
            "example": "board",
            "description": "The layout of the view."
          },
          "visible_fields": {
            "type": "array",
            "items": {
              "type": "integer"
            },
            "example": [
              123,
              456,
              789
            ],
            "description": "`visible_fields` is not applicable to `roadmap` layout views.\nFor `table` and `board` layouts, this represents the field IDs that should be visible in the view. If not provided, the default visible fields will be used."
          }
        },
        "additionalProperties": false
      },
      "examples": {
        "board_view": {
          "value": {
            "name": "Sprint Board",
            "filter": "is:issue is:open label:sprint",
            "layout": "board",
            "visible_fields": [
              123,
              456,
              789
            ]
          },
          "summary": "Create a board view with filter"
        },
        "table_view": {
          "value": {
            "name": "All Issues",
            "filter": "is:issue",
            "layout": "table",
            "visible_fields": [
              123,
              456,
              789
            ]
          },
          "summary": "Create a table view"
        },
        "roadmap_view": {
          "value": {
            "name": "Product Roadmap",
            "layout": "roadmap"
          },
          "summary": "Create a roadmap view"
        }
      }
    }
  },
  "required": true
}

Responses

Parameters

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "title"
        ],
        "properties": {
          "body": {
            "type": "string",
            "description": "The body content of the draft issue item to create in the project."
          },
          "title": {
            "type": "string",
            "description": "The title of the draft issue item to create in the project."
          }
        }
      },
      "examples": {
        "body": {
          "value": {
            "body": "This is the body content of the draft issue.",
            "title": "Sample Draft Issue Title"
          },
          "summary": "Example with Sample Draft Issue Title and Body"
        },
        "title": {
          "value": {
            "title": "Sample Draft Issue Title"
          },
          "summary": "Example with Sample Draft Issue Title"
        }
      }
    }
  },
  "required": true,
  "description": "Details of the draft item to create in the project."
}

Responses

Parameters

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "name",
          "layout"
        ],
        "properties": {
          "name": {
            "type": "string",
            "example": "Sprint Board",
            "description": "The name of the view."
          },
          "filter": {
            "type": "string",
            "example": "is:issue is:open",
            "description": "The filter query for the view. See [Filtering projects](https://docs.github.com/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) for more information."
          },
          "layout": {
            "enum": [
              "table",
              "board",
              "roadmap"
            ],
            "type": "string",
            "example": "board",
            "description": "The layout of the view."
          },
          "visible_fields": {
            "type": "array",
            "items": {
              "type": "integer"
            },
            "example": [
              123,
              456,
              789
            ],
            "description": "`visible_fields` is not applicable to `roadmap` layout views.\nFor `table` and `board` layouts, this represents the field IDs that should be visible in the view. If not provided, the default visible fields will be used."
          }
        },
        "additionalProperties": false
      },
      "examples": {
        "board_view": {
          "value": {
            "name": "Sprint Board",
            "filter": "is:issue is:open label:sprint",
            "layout": "board",
            "visible_fields": [
              123,
              456,
              789
            ]
          },
          "summary": "Create a board view with filter"
        },
        "table_view": {
          "value": {
            "name": "All Issues",
            "filter": "is:issue",
            "layout": "table",
            "visible_fields": [
              123,
              456,
              789
            ]
          },
          "summary": "Create a table view"
        },
        "roadmap_view": {
          "value": {
            "name": "Product Roadmap",
            "layout": "roadmap"
          },
          "summary": "Create a roadmap view"
        }
      }
    }
  },
  "required": true
}

Responses

Parameters

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "oneOf": [
          {
            "type": "object",
            "required": [
              "name",
              "data_type"
            ],
            "properties": {
              "name": {
                "type": "string",
                "description": "The name of the field."
              },
              "data_type": {
                "enum": [
                  "text",
                  "number",
                  "date"
                ],
                "type": "string",
                "description": "The field's data type."
              }
            },
            "additionalProperties": false
          },
          {
            "type": "object",
            "required": [
              "name",
              "data_type",
              "single_select_options"
            ],
            "properties": {
              "name": {
                "type": "string",
                "description": "The name of the field."
              },
              "data_type": {
                "enum": [
                  "single_select"
                ],
                "type": "string",
                "description": "The field's data type."
              },
              "single_select_options": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/projects-v2-field-single-select-option"
                },
                "description": "The options available for single select fields. At least one option must be provided when creating a single select field."
              }
            },
            "additionalProperties": false
          },
          {
            "type": "object",
            "required": [
              "name",
              "data_type",
              "iteration_configuration"
            ],
            "properties": {
              "name": {
                "type": "string",
                "description": "The name of the field."
              },
              "data_type": {
                "enum": [
                  "iteration"
                ],
                "type": "string",
                "description": "The field's data type."
              },
              "iteration_configuration": {
                "$ref": "#/components/schemas/projects-v2-field-iteration-configuration"
              }
            },
            "additionalProperties": false
          }
        ]
      },
      "examples": {
        "date_field": {
          "value": {
            "name": "Due date",
            "data_type": "date"
          },
          "summary": "Create a date field"
        },
        "text_field": {
          "value": {
            "name": "Team notes",
            "data_type": "text"
          },
          "summary": "Create a text field"
        },
        "number_field": {
          "value": {
            "name": "Story points",
            "data_type": "number"
          },
          "summary": "Create a number field"
        },
        "iteration_field": {
          "$ref": "#/components/examples/projects-v2-field-iteration-request"
        },
        "single_select_field": {
          "$ref": "#/components/examples/projects-v2-field-single-select-request"
        }
      }
    }
  },
  "required": true
}

Responses

Parameters

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "oneOf": [
          {
            "required": [
              "id"
            ]
          },
          {
            "required": [
              "owner",
              "repo",
              "number"
            ]
          }
        ],
        "required": [
          "type"
        ],
        "properties": {
          "id": {
            "type": "integer",
            "description": "The unique identifier of the issue or pull request to add to the project."
          },
          "repo": {
            "type": "string",
            "description": "The repository name."
          },
          "type": {
            "enum": [
              "Issue",
              "PullRequest"
            ],
            "type": "string",
            "description": "The type of item to add to the project. Must be either Issue or PullRequest."
          },
          "owner": {
            "type": "string",
            "description": "The repository owner login."
          },
          "number": {
            "type": "integer",
            "description": "The issue or pull request number."
          }
        },
        "additionalProperties": false
      },
      "examples": {
        "issue_with_id": {
          "value": {
            "id": 3,
            "type": "Issue"
          },
          "summary": "Add an issue using its unique ID"
        },
        "issue_with_nwo": {
          "value": {
            "repo": "hello-world",
            "type": "Issue",
            "owner": "octocat",
            "number": 42
          },
          "summary": "Add an issue using repository owner, name, and issue number"
        },
        "pull_request_with_id": {
          "value": {
            "id": 3,
            "type": "PullRequest"
          },
          "summary": "Add a pull request using its unique ID"
        },
        "pull_request_with_nwo": {
          "value": {
            "repo": "hello-world",
            "type": "PullRequest",
            "owner": "octocat",
            "number": 123
          },
          "summary": "Add a pull request using repository owner, name, and PR number"
        }
      }
    }
  },
  "required": true,
  "description": "Details of the item to add to the project. You can specify either the unique ID or the repository owner, name, and issue/PR number."
}

Responses

Parameters

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "head",
          "base"
        ],
        "properties": {
          "base": {
            "type": "string",
            "description": "The name of the branch you want the changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repository that requests a merge to a base of another repository."
          },
          "body": {
            "type": "string",
            "description": "The contents of the pull request."
          },
          "head": {
            "type": "string",
            "description": "The name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace `head` with a user like this: `username:branch`."
          },
          "draft": {
            "type": "boolean",
            "description": "Indicates whether the pull request is a draft. See \"[Draft Pull Requests](https://docs.github.com/articles/about-pull-requests#draft-pull-requests)\" in the GitHub Help documentation to learn more."
          },
          "issue": {
            "type": "integer",
            "format": "int64",
            "example": 1,
            "description": "An issue in the repository to convert to a pull request. The issue title, body, and comments will become the title, body, and comments on the new pull request. Required unless `title` is specified."
          },
          "title": {
            "type": "string",
            "description": "The title of the new pull request. Required unless `issue` is specified."
          },
          "head_repo": {
            "type": "string",
            "format": "repo.nwo",
            "example": "octo-org/octo-repo",
            "description": "The name of the repository where the changes in the pull request were made. This field is required for cross-repository pull requests if both repositories are owned by the same organization."
          },
          "maintainer_can_modify": {
            "type": "boolean",
            "description": "Indicates whether [maintainers can modify](https://docs.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request."
          }
        }
      },
      "examples": {
        "default": {
          "value": {
            "base": "master",
            "body": "Please pull these awesome changes in!",
            "head": "octocat:new-feature",
            "title": "Amazing new feature"
          }
        }
      }
    }
  },
  "required": true
}

Responses

Parameters

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "body",
          "commit_id",
          "path"
        ],
        "properties": {
          "body": {
            "type": "string",
            "description": "The text of the review comment."
          },
          "line": {
            "type": "integer",
            "description": "**Required unless using `subject_type:file`**. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to."
          },
          "path": {
            "type": "string",
            "description": "The relative path to the file that necessitates a comment."
          },
          "side": {
            "enum": [
              "LEFT",
              "RIGHT"
            ],
            "type": "string",
            "description": "In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"[Diff view options](https://docs.github.com/articles/about-comparing-branches-in-pull-requests#diff-view-options)\" in the GitHub Help documentation."
          },
          "position": {
            "type": "integer",
            "x-github": {
              "deprecationDate": "2022-11-01"
            },
            "deprecated": true,
            "description": "**This parameter is closing down. Use `line` instead**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file."
          },
          "commit_id": {
            "type": "string",
            "description": "The SHA of the commit needing a comment. Not using the latest commit SHA may render your comment outdated if a subsequent commit modifies the line you specify as the `position`."
          },
          "start_line": {
            "type": "integer",
            "description": "**Required when using multi-line comments unless using `in_reply_to`**. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"[Commenting on a pull request](https://docs.github.com/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation."
          },
          "start_side": {
            "enum": [
              "LEFT",
              "RIGHT",
              "side"
            ],
            "type": "string",
            "description": "**Required when using multi-line comments unless using `in_reply_to`**. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see \"[Commenting on a pull request](https://docs.github.com/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation. See `side` in this table for additional context."
          },
          "in_reply_to": {
            "type": "integer",
            "example": 2,
            "description": "The ID of the review comment to reply to. To find the ID of a review comment with [\"List review comments on a pull request\"](#list-review-comments-on-a-pull-request). When specified, all parameters other than `body` in the request body are ignored."
          },
          "subject_type": {
            "enum": [
              "line",
              "file"
            ],
            "type": "string",
            "description": "The level at which the comment is targeted."
          }
        }
      },
      "examples": {
        "example-for-a-multi-line-comment": {
          "value": {
            "body": "Great stuff!",
            "line": 2,
            "path": "file1.txt",
            "side": "RIGHT",
            "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
            "start_line": 1,
            "start_side": "RIGHT"
          },
          "summary": "Example for a multi-line comment"
        }
      }
    }
  },
  "required": true
}

Responses

Parameters

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "body"
        ],
        "properties": {
          "body": {
            "type": "string",
            "description": "The text of the review comment."
          }
        }
      },
      "examples": {
        "default": {
          "value": {
            "body": "Great stuff!"
          }
        }
      }
    }
  },
  "required": true
}

Responses

Parameters

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "anyOf": [
          {
            "required": [
              "reviewers"
            ]
          },
          {
            "required": [
              "team_reviewers"
            ]
          }
        ],
        "properties": {
          "reviewers": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "An array of user `login`s that will be requested."
          },
          "team_reviewers": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "An array of team `slug`s that will be requested."
          }
        }
      },
      "examples": {
        "default": {
          "value": {
            "reviewers": [
              "octocat",
              "hubot",
              "other_user"
            ],
            "team_reviewers": [
              "justice-league"
            ]
          }
        }
      }
    }
  },
  "required": false
}

Responses

Parameters

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "body": {
            "type": "string",
            "description": "**Required** when using `REQUEST_CHANGES` or `COMMENT` for the `event` parameter. The body text of the pull request review."
          },
          "event": {
            "enum": [
              "APPROVE",
              "REQUEST_CHANGES",
              "COMMENT"
            ],
            "type": "string",
            "description": "The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. By leaving this blank, you set the review action state to `PENDING`, which means you will need to [submit the pull request review](https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request) when you are ready."
          },
          "comments": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "path",
                "body"
              ],
              "properties": {
                "body": {
                  "type": "string",
                  "description": "Text of the review comment."
                },
                "line": {
                  "type": "integer",
                  "example": 28
                },
                "path": {
                  "type": "string",
                  "description": "The relative path to the file that necessitates a review comment."
                },
                "side": {
                  "type": "string",
                  "example": "RIGHT"
                },
                "position": {
                  "type": "integer",
                  "description": "The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. The `position` value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file."
                },
                "start_line": {
                  "type": "integer",
                  "example": 26
                },
                "start_side": {
                  "type": "string",
                  "example": "LEFT"
                }
              }
            },
            "description": "Use the following table to specify the location, destination, and contents of the draft review comment."
          },
          "commit_id": {
            "type": "string",
            "description": "The SHA of the commit that needs a review. Not using the latest commit SHA may render your review comment outdated if a subsequent commit modifies the line you specify as the `position`. Defaults to the most recent commit in the pull request when you do not specify a value."
          }
        }
      },
      "examples": {
        "default": {
          "value": {
            "body": "This is close to perfect! Please address the suggested inline change.",
            "event": "REQUEST_CHANGES",
            "comments": [
              {
                "body": "Please add more information here, and fix this typo.",
                "path": "file.md",
                "position": 6
              }
            ],
            "commit_id": "ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091"
          }
        }
      }
    }
  },
  "required": false
}

Responses

Parameters

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "event"
        ],
        "properties": {
          "body": {
            "type": "string",
            "description": "The body text of the pull request review"
          },
          "event": {
            "enum": [
              "APPROVE",
              "REQUEST_CHANGES",
              "COMMENT"
            ],
            "type": "string",
            "description": "The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. When you leave this blank, the API returns _HTTP 422 (Unrecognizable entity)_ and sets the review action state to `PENDING`, which means you will need to re-submit the pull request review using a review action."
          }
        }
      },
      "examples": {
        "default": {
          "value": {
            "body": "Here is the body for the review.",
            "event": "REQUEST_CHANGES"
          }
        }
      }
    }
  },
  "required": true
}

Responses

Parameters

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "content"
        ],
        "properties": {
          "content": {
            "enum": [
              "+1",
              "-1",
              "laugh",
              "confused",
              "heart",
              "hooray",
              "rocket",
              "eyes"
            ],
            "type": "string",
            "description": "The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the commit comment."
          }
        }
      },
      "examples": {
        "default": {
          "value": {
            "content": "heart"
          }
        }
      }
    }
  },
  "required": true
}

Responses

Parameters

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "content"
        ],
        "properties": {
          "content": {
            "enum": [
              "+1",
              "-1",
              "laugh",
              "confused",
              "heart",
              "hooray",
              "rocket",
              "eyes"
            ],
            "type": "string",
            "description": "The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the issue comment."
          }
        }
      },
      "examples": {
        "default": {
          "value": {
            "content": "heart"
          }
        }
      }
    }
  },
  "required": true
}

Responses

Parameters

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "content"
        ],
        "properties": {
          "content": {
            "enum": [
              "+1",
              "-1",
              "laugh",
              "confused",
              "heart",
              "hooray",
              "rocket",
              "eyes"
            ],
            "type": "string",
            "description": "The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the issue."
          }
        }
      },
      "examples": {
        "default": {
          "value": {
            "content": "heart"
          }
        }
      }
    }
  },
  "required": true
}

Responses

Parameters

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "content"
        ],
        "properties": {
          "content": {
            "enum": [
              "+1",
              "-1",
              "laugh",
              "confused",
              "heart",
              "hooray",
              "rocket",
              "eyes"
            ],
            "type": "string",
            "description": "The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the pull request review comment."
          }
        }
      },
      "examples": {
        "default": {
          "value": {
            "content": "heart"
          }
        }
      }
    }
  },
  "required": true
}

Responses

Parameters

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "content"
        ],
        "properties": {
          "content": {
            "enum": [
              "+1",
              "laugh",
              "heart",
              "hooray",
              "rocket",
              "eyes"
            ],
            "type": "string",
            "description": "The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the release."
          }
        }
      },
      "examples": {
        "default": {
          "value": {
            "content": "heart"
          }
        }
      }
    }
  },
  "required": true
}

Responses

Parameters

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "name"
        ],
        "properties": {
          "name": {
            "type": "string",
            "description": "The name of the repository."
          },
          "private": {
            "type": "boolean",
            "default": false,
            "description": "Whether the repository is private."
          },
          "team_id": {
            "type": "integer",
            "description": "The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization."
          },
          "has_wiki": {
            "type": "boolean",
            "default": true,
            "description": "Either `true` to enable the wiki for this repository or `false` to disable it."
          },
          "homepage": {
            "type": "string",
            "description": "A URL with more information about the repository."
          },
          "auto_init": {
            "type": "boolean",
            "default": false,
            "description": "Pass `true` to create an initial commit with empty README."
          },
          "has_issues": {
            "type": "boolean",
            "default": true,
            "description": "Either `true` to enable issues for this repository or `false` to disable them."
          },
          "visibility": {
            "enum": [
              "public",
              "private"
            ],
            "type": "string",
            "description": "The visibility of the repository."
          },
          "description": {
            "type": "string",
            "description": "A short description of the repository."
          },
          "is_template": {
            "type": "boolean",
            "default": false,
            "description": "Either `true` to make this repo available as a template repository or `false` to prevent it."
          },
          "has_projects": {
            "type": "boolean",
            "default": true,
            "description": "Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error."
          },
          "has_downloads": {
            "type": "boolean",
            "default": true,
            "example": true,
            "description": "Whether downloads are enabled."
          },
          "allow_auto_merge": {
            "type": "boolean",
            "default": false,
            "description": "Either `true` to allow auto-merge on pull requests, or `false` to disallow auto-merge."
          },
          "license_template": {
            "type": "string",
            "description": "Choose an [open source license template](https://choosealicense.com/) that best suits your needs, and then use the [license keyword](https://docs.github.com/articles/licensing-a-repository/#searching-github-by-license-type) as the `license_template` string. For example, \"mit\" or \"mpl-2.0\"."
          },
          "custom_properties": {
            "type": "object",
            "description": "The custom properties for the new repository. The keys are the custom property names, and the values are the corresponding custom property values.",
            "additionalProperties": true
          },
          "allow_merge_commit": {
            "type": "boolean",
            "default": true,
            "description": "Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits."
          },
          "allow_rebase_merge": {
            "type": "boolean",
            "default": true,
            "description": "Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging."
          },
          "allow_squash_merge": {
            "type": "boolean",
            "default": true,
            "description": "Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging."
          },
          "gitignore_template": {
            "type": "string",
            "description": "Desired language or platform [.gitignore template](https://github.com/github/gitignore) to apply. Use the name of the template without the extension. For example, \"Haskell\"."
          },
          "merge_commit_title": {
            "enum": [
              "PR_TITLE",
              "MERGE_MESSAGE"
            ],
            "type": "string",
            "description": "Required when using `merge_commit_message`.\n\nThe default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)."
          },
          "merge_commit_message": {
            "enum": [
              "PR_BODY",
              "PR_TITLE",
              "BLANK"
            ],
            "type": "string",
            "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message."
          },
          "delete_branch_on_merge": {
            "type": "boolean",
            "default": false,
            "description": "Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion. **The authenticated user must be an organization owner to set this property to `true`.**"
          },
          "squash_merge_commit_title": {
            "enum": [
              "PR_TITLE",
              "COMMIT_OR_PR_TITLE"
            ],
            "type": "string",
            "description": "Required when using `squash_merge_commit_message`.\n\nThe default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)."
          },
          "squash_merge_commit_message": {
            "enum": [
              "PR_BODY",
              "COMMIT_MESSAGES",
              "BLANK"
            ],
            "type": "string",
            "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message."
          },
          "use_squash_pr_title_as_default": {
            "type": "boolean",
            "default": false,
            "deprecated": true,
            "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property is closing down. Please use `squash_merge_commit_title` instead."
          }
        }
      },
      "examples": {
        "default": {
          "value": {
            "name": "Hello-World",
            "private": false,
            "has_wiki": true,
            "homepage": "https://github.com",
            "has_issues": true,
            "description": "This is your first repository",
            "has_projects": true
          }
        }
      }
    }
  },
  "required": true
}

Responses

Parameters

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "name",
          "enforcement"
        ],
        "properties": {
          "name": {
            "type": "string",
            "description": "The name of the ruleset."
          },
          "rules": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/org-rules"
            },
            "description": "An array of rules within the ruleset."
          },
          "target": {
            "enum": [
              "branch",
              "tag",
              "push",
              "repository"
            ],
            "type": "string",
            "default": "branch",
            "description": "The target of the ruleset"
          },
          "conditions": {
            "$ref": "#/components/schemas/org-ruleset-conditions"
          },
          "enforcement": {
            "$ref": "#/components/schemas/repository-rule-enforcement"
          },
          "bypass_actors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/repository-ruleset-bypass-actor"
            },
            "description": "The actors that can bypass the rules in this ruleset"
          }
        }
      },
      "examples": {
        "default": {
          "value": {
            "name": "super cool ruleset",
            "rules": [
              {
                "type": "commit_author_email_pattern",
                "parameters": {
                  "pattern": "github",
                  "operator": "contains"
                }
              }
            ],
            "target": "branch",
            "conditions": {
              "ref_name": {
                "exclude": [
                  "refs/heads/dev*"
                ],
                "include": [
                  "refs/heads/main",
                  "refs/heads/master"
                ]
              },
              "repository_name": {
                "exclude": [
                  "unimportant_repository"
                ],
                "include": [
                  "important_repository",
                  "another_important_repository"
                ],
                "protected": true
              }
            },
            "enforcement": "active",
            "bypass_actors": [
              {
                "actor_id": 234,
                "actor_type": "Team",
                "bypass_mode": "always"
              }
            ]
          }
        }
      }
    }
  },
  "required": true,
  "description": "Request body"
}

Responses

Parameters

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "bundle"
        ],
        "properties": {
          "bundle": {
            "type": "object",
            "properties": {
              "mediaType": {
                "type": "string"
              },
              "dsseEnvelope": {
                "type": "object",
                "properties": {},
                "additionalProperties": true
              },
              "verificationMaterial": {
                "type": "object",
                "properties": {},
                "additionalProperties": true
              }
            },
            "description": "The attestation's Sigstore Bundle.\nRefer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information."
          }
        }
      },
      "examples": {
        "default": {
          "$ref": "#/components/examples/attestation"
        }
      }
    }
  },
  "required": true
}

Responses

Parameters

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "key_prefix",
          "url_template"
        ],
        "properties": {
          "key_prefix": {
            "type": "string",
            "description": "This prefix appended by certain characters will generate a link any time it is found in an issue, pull request, or commit."
          },
          "url_template": {
            "type": "string",
            "description": "The URL must contain `<num>` for the reference number. `<num>` matches different characters depending on the value of `is_alphanumeric`."
          },
          "is_alphanumeric": {
            "type": "boolean",
            "default": true,
            "description": "Whether this autolink reference matches alphanumeric characters. If true, the `<num>` parameter of the `url_template` matches alphanumeric characters `A-Z` (case insensitive), `0-9`, and `-`. If false, this autolink reference only matches numeric characters."
          }
        }
      },
      "examples": {
        "default": {
          "value": {
            "key_prefix": "TICKET-",
            "url_template": "https://example.com/TICKET?query=<num>",
            "is_alphanumeric": true
          }
        }
      }
    }
  },
  "required": true
}

Responses

Parameters

Responses

Parameters

Responses

Parameters

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "oneOf": [
          {
            "type": "object",
            "example": {
              "contexts": [
                "contexts"
              ]
            },
            "required": [
              "contexts"
            ],
            "properties": {
              "contexts": {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "description": "The name of the status checks"
              }
            }
          },
          {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "The name of the status checks"
          }
        ]
      },
      "examples": {
        "default": {
          "value": {
            "contexts": [
              "continuous-integration/travis-ci",
              "continuous-integration/jenkins"
            ]
          },
          "summary": "Example adding status checks to a branch protection rule"
        }
      }
    }
  },
  "required": false
}

Responses

Parameters

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "example": {
          "apps": [
            "my-app"
          ]
        },
        "required": [
          "apps"
        ],
        "properties": {
          "apps": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "The GitHub Apps that have push access to this branch. Use the slugified version of the app name. **Note**: The list of users, apps, and teams in total is limited to 100 items."
          }
        }
      },
      "examples": {
        "default": {
          "value": {
            "apps": [
              "octoapp"
            ]
          }
        }
      }
    }
  },
  "required": true
}

Responses

Parameters

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "oneOf": [
          {
            "type": "object",
            "example": {
              "teams": [
                "my-team"
              ]
            },
            "required": [
              "teams"
            ],
            "properties": {
              "teams": {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "description": "The slug values for teams"
              }
            }
          },
          {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "The slug values for teams"
          }
        ]
      },
      "examples": {
        "default": {
          "value": {
            "teams": [
              "justice-league"
            ]
          },
          "summary": "Example adding a team in a branch protection rule"
        }
      }
    }
  },
  "required": false
}

Responses

Parameters

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "example": {
          "users": [
            "mona"
          ]
        },
        "required": [
          "users"
        ],
        "properties": {
          "users": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "The username for users"
          }
        }
      },
      "examples": {
        "default": {
          "value": {
            "users": [
              "octocat"
            ]
          },
          "summary": "Example adding a user in a branch protection rule"
        }
      }
    }
  },
  "required": true
}

Responses

Parameters

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "new_name"
        ],
        "properties": {
          "new_name": {
            "type": "string",
            "description": "The new name of the branch."
          }
        }
      },
      "examples": {
        "default": {
          "value": {
            "new_name": "my_renamed_branch"
          }
        }
      }
    }
  },
  "required": true
}

Responses

Parameters

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "body"
        ],
        "properties": {
          "body": {
            "type": "string",
            "description": "The contents of the comment."
          },
          "line": {
            "type": "integer",
            "description": "**Closing down notice**. Use **position** parameter instead. Line number in the file to comment on."
          },
          "path": {
            "type": "string",
            "description": "Relative path of the file to comment on."
          },
          "position": {
            "type": "integer",
            "description": "Line index in the diff to comment on."
          }
        }
      },
      "examples": {
        "default": {
          "value": {
            "body": "Great stuff",
            "line": 1,
            "path": "file1.txt",
            "position": 4
          }
        }
      }
    }
  },
  "required": true
}

Responses

Parameters

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "ref"
        ],
        "properties": {
          "ref": {
            "type": "string",
            "description": "The ref to deploy. This can be a branch, tag, or SHA."
          },
          "task": {
            "type": "string",
            "default": "deploy",
            "description": "Specifies a task to execute (e.g., `deploy` or `deploy:migrations`)."
          },
          "payload": {
            "oneOf": [
              {
                "type": "object",
                "additionalProperties": true
              },
              {
                "type": "string",
                "default": "",
                "description": "JSON payload with extra information about the deployment."
              }
            ]
          },
          "auto_merge": {
            "type": "boolean",
            "default": true,
            "description": "Attempts to automatically merge the default branch into the requested ref, if it's behind the default branch."
          },
          "description": {
            "type": "string",
            "default": "",
            "nullable": true,
            "description": "Short description of the deployment."
          },
          "environment": {
            "type": "string",
            "default": "production",
            "description": "Name for the target deployment environment (e.g., `production`, `staging`, `qa`)."
          },
          "required_contexts": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "The [status](https://docs.github.com/rest/commits/statuses) contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts."
          },
          "transient_environment": {
            "type": "boolean",
            "default": false,
            "description": "Specifies if the given environment is specific to the deployment and will no longer exist at some point in the future. Default: `false`"
          },
          "production_environment": {
            "type": "boolean",
            "description": "Specifies if the given environment is one that end-users directly interact with. Default: `true` when `environment` is `production` and `false` otherwise."
          }
        }
      },
      "examples": {
        "simple-example": {
          "value": {
            "ref": "topic-branch",
            "payload": "{ \"deploy\": \"migrate\" }",
            "description": "Deploy request from hubot"
          },
          "summary": "Simple example"
        },
        "advanced-example": {
          "value": {
            "ref": "topic-branch",
            "payload": "{ \"deploy\": \"migrate\" }",
            "auto_merge": false,
            "description": "Deploy request from hubot",
            "required_contexts": [
              "ci/janky",
              "security/brakeman"
            ]
          },
          "summary": "Advanced example"
        }
      }
    }
  },
  "required": true
}

Responses

Parameters

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "state"
        ],
        "properties": {
          "state": {
            "enum": [
              "error",
              "failure",
              "inactive",
              "in_progress",
              "queued",
              "pending",
              "success"
            ],
            "type": "string",
            "description": "The state of the status. When you set a transient deployment to `inactive`, the deployment will be shown as `destroyed` in GitHub."
          },
          "log_url": {
            "type": "string",
            "default": "",
            "description": "The full URL of the deployment's output. This parameter replaces `target_url`. We will continue to accept `target_url` to support legacy uses, but we recommend replacing `target_url` with `log_url`. Setting `log_url` will automatically set `target_url` to the same value. Default: `\"\"`"
          },
          "target_url": {
            "type": "string",
            "default": "",
            "description": "The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment.\n\n> [!NOTE]\n> It's recommended to use the `log_url` parameter, which replaces `target_url`."
          },
          "description": {
            "type": "string",
            "default": "",
            "description": "A short description of the status. The maximum description length is 140 characters."
          },
          "environment": {
            "type": "string",
            "description": "Name for the target deployment environment, which can be changed when setting a deploy status. For example, `production`, `staging`, or `qa`. If not defined, the environment of the previous status on the deployment will be used, if it exists. Otherwise, the environment of the deployment will be used."
          },
          "auto_inactive": {
            "type": "boolean",
            "description": "Adds a new `inactive` status to all prior non-transient, non-production environment deployments with the same repository and `environment` name as the created status's deployment. An `inactive` status is only added to deployments that had a `success` state. Default: `true`"
          },
          "environment_url": {
            "type": "string",
            "default": "",
            "description": "Sets the URL for accessing your environment. Default: `\"\"`"
          }
        }
      },
      "examples": {
        "default": {
          "value": {
            "state": "success",
            "log_url": "https://example.com/deployment/42/output",
            "description": "Deployment finished successfully.",
            "environment": "production"
          }
        }
      }
    }
  },
  "required": true
}

Responses

Parameters

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "event_type"
        ],
        "properties": {
          "event_type": {
            "type": "string",
            "maxLength": 100,
            "minLength": 1,
            "description": "A custom webhook event name. Must be 100 characters or fewer."
          },
          "client_payload": {
            "type": "object",
            "description": "JSON payload with extra information about the webhook event that your action or workflow may use. The maximum number of top-level properties is 10. The total size of the JSON payload must be less than 64KB.",
            "maxProperties": 10,
            "additionalProperties": true
          }
        }
      },
      "examples": {
        "default": {
          "value": {
            "event_type": "on-demand-test",
            "client_payload": {
              "unit": false,
              "integration": true
            }
          }
        }
      }
    }
  },
  "required": true
}

Responses

Parameters

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/deployment-branch-policy-name-pattern-with-type"
      },
      "examples": {
        "example-wildcard": {
          "value": {
            "name": "release/*"
          },
          "summary": "Example of a wildcard name pattern"
        },
        "example-single-tag": {
          "value": {
            "name": "v1",
            "type": "tag"
          },
          "summary": "Example of a single tag name pattern"
        },
        "example-single-branch": {
          "value": {
            "name": "main",
            "type": "branch"
          },
          "summary": "Example of a single branch name pattern"
        }
      }
    }
  },
  "required": true
}

Responses

Parameters

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "integration_id": {
            "type": "integer",
            "description": "The ID of the custom app that will be enabled on the environment."
          }
        }
      },
      "examples": {
        "default": {
          "value": {
            "integration_id": 5
          }
        }
      }
    }
  },
  "required": true
}

Responses

Parameters

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "nullable": true,
        "properties": {
          "name": {
            "type": "string",
            "description": "When forking from an existing repository, a new name for the fork."
          },
          "organization": {
            "type": "string",
            "description": "Optional parameter to specify the organization name if forking into an organization."
          },
          "default_branch_only": {
            "type": "boolean",
            "description": "When forking from an existing repository, fork with only the default branch."
          }
        }
      },
      "examples": {
        "default": {
          "value": {
            "name": "Hello-World",
            "organization": "octocat",
            "default_branch_only": true
          }
        }
      }
    }
  },
  "required": false
}

Responses

Parameters

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "nullable": true,
        "properties": {
          "name": {
            "type": "string",
            "description": "Use `web` to create a webhook. Default: `web`. This parameter only accepts the value `web`."
          },
          "active": {
            "type": "boolean",
            "default": true,
            "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications."
          },
          "config": {
            "type": "object",
            "properties": {
              "url": {
                "$ref": "#/components/schemas/webhook-config-url"
              },
              "secret": {
                "$ref": "#/components/schemas/webhook-config-secret"
              },
              "content_type": {
                "$ref": "#/components/schemas/webhook-config-content-type"
              },
              "insecure_ssl": {
                "$ref": "#/components/schemas/webhook-config-insecure-ssl"
              }
            },
            "description": "Key/value pairs to provide settings for this webhook."
          },
          "events": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "default": [
              "push"
            ],
            "description": "Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for."
          }
        },
        "additionalProperties": false
      },
      "examples": {
        "default": {
          "value": {
            "name": "web",
            "active": true,
            "config": {
              "url": "https://example.com/webhook",
              "content_type": "json",
              "insecure_ssl": "0"
            },
            "events": [
              "push",
              "pull_request"
            ]
          }
        }
      }
    }
  },
  "required": false
}

Responses

Parameters

Responses