{ "id": "@itentialopensource/adapter-github", "type": "Adapter", "export": "GitHub", "displayName": "GitHub", "title": "GitHub", "src": "adapter.js", "roles": [ "admin" ], "methods": [ { "name": "iapUpdateAdapterConfiguration", "summary": "Updates the adapter configuration", "description": "Updates the adapter configuration file with the provided changes", "input": [ { "name": "configFile", "type": "string", "info": "The name of the file to change", "required": true, "schema": { "title": "configFile", "type": "string" } }, { "name": "changes", "type": "object", "info": "JSON object containing the configuration changes", "required": true, "schema": { "title": "changes", "type": "object" } }, { "name": "entity", "type": "string", "info": "The entity in which the changes are being made", "required": false, "schema": { "title": "entity", "type": "string" } }, { "name": "type", "type": "string", "info": "The type of file to change - action, schema, or mock", "required": false, "schema": { "title": "type", "type": "string" } }, { "name": "action", "type": "string", "info": "The action to be changed", "required": false, "schema": { "title": "action", "type": "string" } }, { "name": "replace", "type": "boolean", "info": "True to replace entire mock data, false to merge/append", "required": false, "schema": { "title": "replace", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapUpdateAdapterConfiguration" }, "task": true }, { "name": "iapSuspendAdapter", "summary": "Suspends the adapter", "description": "Suspends the adapter", "input": [ { "name": "mode", "type": "enum", "enumerals": [ "pause", "error" ], "info": "How incoming requests are handled. Defaults to 'pause'", "description": "How incoming requests are handled. Defaults to 'pause'", "schema": { "title": "mode", "type": "string" }, "required": false } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the adapter suspended status", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapSuspendAdapter" }, "task": true }, { "name": "iapUnsuspendAdapter", "summary": "Unsuspends the adapter", "description": "Unsuspends the adapter", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the adapter suspended status", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapUnsuspendAdapter" }, "task": true }, { "name": "iapGetAdapterQueue", "summary": "Return the requests that are waiting in the queue if throttling is enabled", "description": "Return the requests that are waiting in the queue if throttling is enabled", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the adapter queue", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapGetAdapterQueue" }, "task": true }, { "name": "iapFindAdapterPath", "summary": "Provides the ability to see if a particular API path is supported by the adapter", "description": "Provides the ability to see if a particular API path is supported by the adapter", "input": [ { "name": "apiPath", "type": "string", "info": "The API Path you want to check - make sure to not include base path and version", "description": "The API Path you want to check - make sure to not include base path and version", "schema": { "title": "apiPath", "type": "string" }, "required": true } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapFindAdapterPath" }, "task": true }, { "name": "iapTroubleshootAdapter", "summary": "Runs troubleshoot script for adapter", "description": "Runs troubleshoot script for adapter", "input": [ { "name": "props", "type": "object", "info": "Object containing configuration, healthcheck and auth properties {'connProps':{'host': 'api.service.com', 'base_path': '/', 'protocol': 'http', 'port': 443, 'version': 'v1'},'healthCheckEndpoint': '/healthcheck', 'auth': {'auth_method': 'no authentication', 'username': 'username', 'password': 'password'}}", "required": true, "schema": { "title": "props", "type": "object" } }, { "name": "persistFlag", "type": "boolean", "info": "Whether the input properties should be saved", "required": true, "schema": { "title": "persistFlag", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the test results", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapTroubleshootAdapter" }, "task": true }, { "name": "iapRunAdapterHealthcheck", "summary": "Runs healthcheck script for adapter", "description": "Runs healthcheck script for adapter", "input": [], "output": { "name": "result", "type": "boolean", "description": "Whether healthcheck passed or failed", "schema": { "title": "result", "type": "boolean" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapRunAdapterHealthcheck" }, "task": true }, { "name": "iapRunAdapterConnectivity", "summary": "Runs connectivity check script for adapter", "description": "Runs connectivity check script for adapter", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the test results", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapRunAdapterConnectivity" }, "task": true }, { "name": "iapRunAdapterBasicGet", "summary": "Runs basicGet script for adapter", "description": "Runs basicGet script for adapter", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the test results", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapRunAdapterBasicGet" }, "task": true }, { "name": "iapMoveAdapterEntitiesToDB", "summary": "Moves entities from an adapter into the IAP database", "description": "Moves entities from an adapter into the IAP database", "input": [], "output": { "name": "res", "type": "object", "description": "A JSON Object containing status, code and the response from the mongo transaction", "schema": { "title": "res", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapMoveAdapterEntitiesToDB" }, "task": true }, { "name": "iapDeactivateTasks", "summary": "Deactivate the inputted tasks", "description": "Deactivate the inputted tasks", "input": [ { "name": "tasks", "type": "array", "description": "Tasks to deactivate", "schema": { "title": "tasks", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing success status", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapDeactivateTasks" }, "task": true }, { "name": "iapActivateTasks", "summary": "Activate the inputted tasks", "description": "activate the inputted tasks", "input": [ { "name": "tasks", "type": "array", "description": "Tasks to activate", "schema": { "title": "tasks", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing success status", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapActivateTasks" }, "task": true }, { "name": "iapPopulateEntityCache", "summary": "Populate the cache for the given entities", "description": "Populate the cache for the given entities", "input": [ { "name": "entityTypes", "type": "array", "info": "the entity type(s) to populate", "required": true, "schema": { "title": "entityTypes", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapPopulateEntityCache" }, "task": true }, { "name": "iapRetrieveEntitiesCache", "summary": "Retrieves data from cache for specified entity type", "description": "Retrieves data from cache for specified entity type", "input": [ { "name": "entityType", "type": "string", "info": "entity of which to retrieve", "required": true, "schema": { "title": "entityType", "type": "string" } }, { "name": "options", "type": "object", "info": "settings of which data to return and how to return it", "required": false, "schema": { "title": "options", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapRetrieveEntitiesCache" }, "task": true }, { "name": "getDevice", "summary": "Get the Appliance", "description": "Get the Appliance", "input": [ { "name": "deviceName", "type": "string", "info": "An Appliance Device Name", "required": true, "schema": { "title": "deviceName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getDevice" }, "task": false }, { "name": "getDevicesFiltered", "summary": "Get Appliances that match the filter", "description": "Get Appliances that match the filter", "input": [ { "name": "options", "type": "object", "info": "options - e.g. { 'start': 1, 'limit': 20, 'filter': { 'name': 'abc123' } }", "required": true, "schema": { "title": "options", "type": "object" } } ], "output": { "name": "result", "type": "array", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getDevicesFiltered" }, "task": false }, { "name": "isAlive", "summary": "Checks the status for the provided Appliance", "description": "Checks the status for the provided Appliance", "input": [ { "name": "deviceName", "type": "string", "info": "An Appliance Device Name", "required": true, "schema": { "title": "deviceName", "type": "string" } } ], "output": { "name": "result", "type": "boolean", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "boolean" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/isAlive" }, "task": false }, { "name": "getConfig", "summary": "Gets a config for the provided Appliance", "description": "Gets a config for the provided Appliance", "input": [ { "name": "deviceName", "type": "string", "info": "An Appliance Device Name", "required": true, "schema": { "title": "deviceName", "type": "string" } }, { "name": "format", "type": "string", "info": "The format to be returned - this is ignored as we always return json", "required": false, "schema": { "title": "format", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getConfig" }, "task": false }, { "name": "iapGetDeviceCount", "summary": "Gets a device count from the system", "description": "Gets a device count from the system", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapGetDeviceCount" }, "task": false }, { "name": "iapExpandedGenericAdapterRequest", "summary": "Makes the requested generic call with additional options", "description": "Makes the requested generic call with additional options via metadata", "input": [ { "name": "metadata", "type": "object", "info": "metadata for the call (optional)", "description": "metadata for the call - allows for many enhancements (optional)", "schema": { "title": "metadata", "type": "object" }, "required": false }, { "name": "uriPath", "type": "string", "info": "the path of the api call - do not include the host, port, base path or version", "description": "the path of the api call", "schema": { "title": "uriPath", "type": "string" }, "required": false }, { "name": "restMethod", "type": "string", "info": "the rest method (GET, POST, PUT, PATCH, DELETE)", "description": "the rest method (GET, POST, PUT, PATCH, DELETE)", "schema": { "title": "restMethod", "type": "string" }, "required": false }, { "name": "pathVars", "type": "object", "info": "the parameters to be put within the url path (optional)", "description": "the parameters to be put within the url path (optional)", "schema": { "title": "pathVars", "type": "object" }, "required": false }, { "name": "queryData", "type": "object", "info": "the query parameters to be put on the url (optional)", "description": "the query parameters to be put on the url (optional)", "schema": { "title": "queryData", "type": "object" }, "required": false }, { "name": "requestBody", "type": "object", "info": "the payload to be sent with the request (optional)", "description": "the payload to be sent with the request (optional)", "schema": { "title": "requestBody", "type": "object" }, "required": false }, { "name": "addlHeaders", "type": "object", "info": "additional headers to be put on the call (optional)", "description": "additional headers to be put on the call (optional)", "schema": { "title": "addlHeaders", "type": "object" }, "required": false } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapExpandedGenericAdapterRequest" }, "task": true }, { "name": "genericAdapterRequest", "summary": "Makes the requested generic call", "description": "Makes the requested generic call", "input": [ { "name": "uriPath", "type": "string", "info": "the path of the api call - do not include the host, port, base path or version", "description": "the path of the api call", "schema": { "title": "uriPath", "type": "string" }, "required": true }, { "name": "restMethod", "type": "string", "info": "the rest method (GET, POST, PUT, PATCH, DELETE)", "description": "the rest method (GET, POST, PUT, PATCH, DELETE)", "schema": { "title": "restMethod", "type": "string" }, "required": true }, { "name": "queryData", "type": "object", "info": "the query parameters to be put on the url (optional)", "description": "the query parameters to be put on the url (optional)", "schema": { "title": "queryData", "type": "object" }, "required": false }, { "name": "requestBody", "type": "object", "info": "the payload to be sent with the request (optional)", "description": "the payload to be sent with the request (optional)", "schema": { "title": "requestBody", "type": "object" }, "required": false }, { "name": "addlHeaders", "type": "object", "info": "additional headers to be put on the call (optional)", "description": "additional headers to be put on the call (optional)", "schema": { "title": "addlHeaders", "type": "object" }, "required": false } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/genericAdapterRequest" }, "task": true }, { "name": "genericAdapterRequestNoBasePath", "summary": "Makes the requested generic call", "description": "Makes the requested generic call", "input": [ { "name": "uriPath", "type": "string", "info": "the path of the api call - do not include the host, port, base path or version", "description": "the path of the api call", "schema": { "title": "uriPath", "type": "string" }, "required": true }, { "name": "restMethod", "type": "string", "info": "the rest method (GET, POST, PUT, PATCH, DELETE)", "description": "the rest method (GET, POST, PUT, PATCH, DELETE)", "schema": { "title": "restMethod", "type": "string" }, "required": true }, { "name": "queryData", "type": "object", "info": "the query parameters to be put on the url (optional)", "description": "the query parameters to be put on the url (optional)", "schema": { "title": "queryData", "type": "object" }, "required": false }, { "name": "requestBody", "type": "object", "info": "the payload to be sent with the request (optional)", "description": "the payload to be sent with the request (optional)", "schema": { "title": "requestBody", "type": "object" }, "required": false }, { "name": "addlHeaders", "type": "object", "info": "additional headers to be put on the call (optional)", "description": "additional headers to be put on the call (optional)", "schema": { "title": "addlHeaders", "type": "object" }, "required": false } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/genericAdapterRequestNoBasePath" }, "task": true }, { "name": "iapRunAdapterLint", "summary": "Run the adapter lint script to return the results", "description": "Run the adapter lint script to return the results", "input": [], "output": { "name": "result", "type": "string", "description": "A string containing the run results", "schema": { "title": "result", "type": "string" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/iapRunAdapterLint" }, "task": true }, { "name": "iapRunAdapterTests", "summary": "Run the adapter test scripts (baseunit and unit) to return the results", "description": "Run the adapter test scripts (baseunit and unit) to return the results", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/iapRunAdapterTests" }, "task": true }, { "name": "iapGetAdapterInventory", "summary": "Provide inventory information abbout the adapter", "description": "Provide inventory information abbout the adapter", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/iapGetAdapterInventory" }, "task": true }, { "name": "getEmojis", "summary": "Lists all the emojis available to use on GitHub.", "description": "Lists all the emojis available to use on GitHub.", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/getEmojis" }, "task": true }, { "name": "getEvents", "summary": "List public events.", "description": "List public events.", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/getEvents" }, "task": true }, { "name": "getFeeds", "summary": "List Feeds.\nGitHub provides several timeline resources in Atom format. The Feeds API\n lists all the feeds available to the authenticating user.", "description": "List Feeds.\nGitHub provides several timeline resources in Atom format. The Feeds API\n lists all the feeds available to the authenticating user.", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/getFeeds" }, "task": true }, { "name": "getGists", "summary": "List the authenticated user's gists or if called anonymously, this will\nreturn all public gists.", "description": "List the authenticated user's gists or if called anonymously, this will\nreturn all public gists.", "input": [ { "name": "since", "type": "string", "info": "Timestamp in ISO 8601 format YYYY-MM-DDTHH:MM:SSZ.\nOnly gists updated at or after this time are returned.", "required": false, "schema": { "title": "since", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getGists" }, "task": true }, { "name": "postGists", "summary": "Create a gist.", "description": "Create a gist.", "input": [ { "name": "body", "type": "object", "info": "", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postGists" }, "task": true }, { "name": "getGistsPublic", "summary": "List all public gists.", "description": "List all public gists.", "input": [ { "name": "since", "type": "string", "info": "Timestamp in ISO 8601 format YYYY-MM-DDTHH:MM:SSZ.\nOnly gists updated at or after this time are returned.", "required": false, "schema": { "title": "since", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getGistsPublic" }, "task": true }, { "name": "getGistsStarred", "summary": "List the authenticated user's starred gists.", "description": "List the authenticated user's starred gists.", "input": [ { "name": "since", "type": "string", "info": "Timestamp in ISO 8601 format YYYY-MM-DDTHH:MM:SSZ.\nOnly gists updated at or after this time are returned.", "required": false, "schema": { "title": "since", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getGistsStarred" }, "task": true }, { "name": "deleteGistsId", "summary": "Delete a gist.", "description": "Delete a gist.", "input": [ { "name": "id", "type": "number", "info": "Id of gist.", "required": true, "schema": { "title": "id", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteGistsId" }, "task": true }, { "name": "getGistsId", "summary": "Get a single gist.", "description": "Get a single gist.", "input": [ { "name": "id", "type": "number", "info": "Id of gist.", "required": true, "schema": { "title": "id", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getGistsId" }, "task": true }, { "name": "patchGistsId", "summary": "Edit a gist.", "description": "Edit a gist.", "input": [ { "name": "id", "type": "number", "info": "Id of gist.", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "body", "type": "object", "info": "", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchGistsId" }, "task": true }, { "name": "getGistsIdComments", "summary": "List comments on a gist.", "description": "List comments on a gist.", "input": [ { "name": "id", "type": "number", "info": "Id of gist.", "required": true, "schema": { "title": "id", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getGistsIdComments" }, "task": true }, { "name": "postGistsIdComments", "summary": "Create a commen", "description": "Create a commen", "input": [ { "name": "id", "type": "number", "info": "Id of gist.", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "body", "type": "object", "info": "", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postGistsIdComments" }, "task": true }, { "name": "deleteGistsIdCommentsCommentId", "summary": "Delete a comment.", "description": "Delete a comment.", "input": [ { "name": "id", "type": "number", "info": "Id of gist.", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "commentId", "type": "number", "info": "Id of comment.", "required": true, "schema": { "title": "commentId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteGistsIdCommentsCommentId" }, "task": true }, { "name": "getGistsIdCommentsCommentId", "summary": "Get a single comment.", "description": "Get a single comment.", "input": [ { "name": "id", "type": "number", "info": "Id of gist.", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "commentId", "type": "number", "info": "Id of comment.", "required": true, "schema": { "title": "commentId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getGistsIdCommentsCommentId" }, "task": true }, { "name": "patchGistsIdCommentsCommentId", "summary": "Edit a comment.", "description": "Edit a comment.", "input": [ { "name": "id", "type": "number", "info": "Id of gist.", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "commentId", "type": "number", "info": "Id of comment.", "required": true, "schema": { "title": "commentId", "type": "number" } }, { "name": "body", "type": "object", "info": "", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchGistsIdCommentsCommentId" }, "task": true }, { "name": "postGistsIdForks", "summary": "Fork a gist.", "description": "Fork a gist.", "input": [ { "name": "id", "type": "number", "info": "Id of gist.", "required": true, "schema": { "title": "id", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postGistsIdForks" }, "task": true }, { "name": "deleteGistsIdStar", "summary": "Unstar a gist.", "description": "Unstar a gist.", "input": [ { "name": "id", "type": "number", "info": "Id of gist.", "required": true, "schema": { "title": "id", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteGistsIdStar" }, "task": true }, { "name": "getGistsIdStar", "summary": "Check if a gist is starred.", "description": "Check if a gist is starred.", "input": [ { "name": "id", "type": "number", "info": "Id of gist.", "required": true, "schema": { "title": "id", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getGistsIdStar" }, "task": true }, { "name": "putGistsIdStar", "summary": "Star a gist.", "description": "Star a gist.", "input": [ { "name": "id", "type": "number", "info": "Id of gist.", "required": true, "schema": { "title": "id", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putGistsIdStar" }, "task": true }, { "name": "getGitignoreTemplates", "summary": "Listing available templates.\nList all templates available to pass as an option when creating a repository.", "description": "Listing available templates.\nList all templates available to pass as an option when creating a repository.", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/getGitignoreTemplates" }, "task": true }, { "name": "getGitignoreTemplatesLanguage", "summary": "Get a single template.", "description": "Get a single template.", "input": [ { "name": "language", "type": "string", "info": "", "required": true, "schema": { "title": "language", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getGitignoreTemplatesLanguage" }, "task": true }, { "name": "getIssues", "summary": "List issues.\nList all issues across all the authenticated user's visible repositories.", "description": "List issues.\nList all issues across all the authenticated user's visible repositories.", "input": [ { "name": "filter", "type": "string", "info": "Issues assigned to you / created by you / mentioning you / you're\nsubscribed to updates for / All issues the authenticated user can see", "required": true, "schema": { "title": "filter", "type": "string" } }, { "name": "state", "type": "string", "info": "", "required": true, "schema": { "title": "state", "type": "string" } }, { "name": "labels", "type": "string", "info": "String list of comma separated Label names. Example - bug,ui,@high.", "required": true, "schema": { "title": "labels", "type": "string" } }, { "name": "sort", "type": "string", "info": "", "required": true, "schema": { "title": "sort", "type": "string" } }, { "name": "direction", "type": "string", "info": "", "required": true, "schema": { "title": "direction", "type": "string" } }, { "name": "since", "type": "string", "info": "Optional string of a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.\nOnly issues updated at or after this time are returned.", "required": false, "schema": { "title": "since", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getIssues" }, "task": true }, { "name": "getLegacyIssuesSearchOwnerRepositoryStateKeyword", "summary": "Find issues by state and keyword.", "description": "Find issues by state and keyword.", "input": [ { "name": "keyword", "type": "string", "info": "The search term.", "required": true, "schema": { "title": "keyword", "type": "string" } }, { "name": "state", "type": "string", "info": "Indicates the state of the issues to return. Can be either open or closed.", "required": true, "schema": { "title": "state", "type": "string" } }, { "name": "owner", "type": "string", "info": "", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repository", "type": "string", "info": "", "required": true, "schema": { "title": "repository", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getLegacyIssuesSearchOwnerRepositoryStateKeyword" }, "task": true }, { "name": "getLegacyReposSearchKeyword", "summary": "Find repositories by keyword. Note, this legacy method does not follow the v3 pagination pattern. This method returns up to 100 results per page and pages can be fetched using the start_page parameter.", "description": "Find repositories by keyword. Note, this legacy method does not follow the v3 pagination pattern. This method returns up to 100 results per page and pages can be fetched using the start_page parameter.", "input": [ { "name": "keyword", "type": "string", "info": "The search term", "required": true, "schema": { "title": "keyword", "type": "string" } }, { "name": "order", "type": "string", "info": "The sort field. if sort param is provided. Can be either asc or desc.", "required": false, "schema": { "title": "order", "type": "string" } }, { "name": "language", "type": "string", "info": "Filter results by language", "required": false, "schema": { "title": "language", "type": "string" } }, { "name": "startPage", "type": "string", "info": "The page number to fetch", "required": false, "schema": { "title": "startPage", "type": "string" } }, { "name": "sort", "type": "string", "info": "The sort field. One of stars, forks, or updated. Default: results are sorted by best match.", "required": false, "schema": { "title": "sort", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getLegacyReposSearchKeyword" }, "task": true }, { "name": "getLegacyUserEmailEmail", "summary": "This API call is added for compatibility reasons only.", "description": "This API call is added for compatibility reasons only.", "input": [ { "name": "email", "type": "string", "info": "The email address", "required": true, "schema": { "title": "email", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getLegacyUserEmailEmail" }, "task": true }, { "name": "getLegacyUserSearchKeyword", "summary": "Find users by keyword.", "description": "Find users by keyword.", "input": [ { "name": "keyword", "type": "string", "info": "The search term", "required": true, "schema": { "title": "keyword", "type": "string" } }, { "name": "order", "type": "string", "info": "The sort field. if sort param is provided. Can be either asc or desc.", "required": false, "schema": { "title": "order", "type": "string" } }, { "name": "startPage", "type": "string", "info": "The page number to fetch", "required": false, "schema": { "title": "startPage", "type": "string" } }, { "name": "sort", "type": "string", "info": "The sort field. One of stars, forks, or updated. Default: results are sorted by best match.", "required": false, "schema": { "title": "sort", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getLegacyUserSearchKeyword" }, "task": true }, { "name": "postMarkdown", "summary": "Render an arbitrary Markdown document", "description": "Render an arbitrary Markdown document", "input": [ { "name": "body", "type": "object", "info": "", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postMarkdown" }, "task": true }, { "name": "postMarkdownRaw", "summary": "Render a Markdown document in raw mode", "description": "Render a Markdown document in raw mode", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/postMarkdownRaw" }, "task": true }, { "name": "getMeta", "summary": "This gives some information about GitHub.com, the service.", "description": "This gives some information about GitHub.com, the service.", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/getMeta" }, "task": true }, { "name": "getNetworksOwnerRepoEvents", "summary": "List public events for a network of repositories.", "description": "List public events for a network of repositories.", "input": [ { "name": "owner", "type": "string", "info": "Name of the owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getNetworksOwnerRepoEvents" }, "task": true }, { "name": "getNotifications", "summary": "List your notifications.\nList all notifications for the current user, grouped by repository.", "description": "List your notifications.\nList all notifications for the current user, grouped by repository.", "input": [ { "name": "all", "type": "boolean", "info": "True to show notifications marked as read.", "required": false, "schema": { "title": "all", "type": "boolean" } }, { "name": "participating", "type": "boolean", "info": "True to show only notifications in which the user is directly participating\nor mentioned.", "required": false, "schema": { "title": "participating", "type": "boolean" } }, { "name": "since", "type": "string", "info": "The time should be passed in as UTC in the ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.\nExample: \"2012-10-09T23:39:01Z\".", "required": false, "schema": { "title": "since", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getNotifications" }, "task": true }, { "name": "putNotifications", "summary": "Mark as read.\nMarking a notification as \"read\" removes it from the default view on GitHub.com.", "description": "Mark as read.\nMarking a notification as \"read\" removes it from the default view on GitHub.com.", "input": [ { "name": "body", "type": "object", "info": "", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putNotifications" }, "task": true }, { "name": "getNotificationsThreadsId", "summary": "View a single thread.", "description": "View a single thread.", "input": [ { "name": "id", "type": "number", "info": "Id of thread.", "required": true, "schema": { "title": "id", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getNotificationsThreadsId" }, "task": true }, { "name": "patchNotificationsThreadsId", "summary": "Mark a thread as read", "description": "Mark a thread as read", "input": [ { "name": "id", "type": "number", "info": "Id of thread.", "required": true, "schema": { "title": "id", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchNotificationsThreadsId" }, "task": true }, { "name": "deleteNotificationsThreadsIdSubscription", "summary": "Delete a Thread Subscription.", "description": "Delete a Thread Subscription.", "input": [ { "name": "id", "type": "number", "info": "Id of thread.", "required": true, "schema": { "title": "id", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteNotificationsThreadsIdSubscription" }, "task": true }, { "name": "getNotificationsThreadsIdSubscription", "summary": "Get a Thread Subscription.", "description": "Get a Thread Subscription.", "input": [ { "name": "id", "type": "number", "info": "Id of thread.", "required": true, "schema": { "title": "id", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getNotificationsThreadsIdSubscription" }, "task": true }, { "name": "putNotificationsThreadsIdSubscription", "summary": "Set a Thread Subscription.\nThis lets you subscribe to a thread, or ignore it. Subscribing to a thread\nis unnecessary if the user is already subscribed to the repository. Ignoring\na thread will mute all future notifications (until you comment or get @mentioned).", "description": "Set a Thread Subscription.\nThis lets you subscribe to a thread, or ignore it. Subscribing to a thread\nis unnecessary if the user is already subscribed to the repository. Ignoring\na thread will mute all future notifications (until you comment or get @mentioned).", "input": [ { "name": "id", "type": "number", "info": "Id of thread.", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "body", "type": "object", "info": "", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putNotificationsThreadsIdSubscription" }, "task": true }, { "name": "getOrgsOrg", "summary": "Get an Organization.", "description": "Get an Organization.", "input": [ { "name": "org", "type": "string", "info": "Name of organisation.", "required": true, "schema": { "title": "org", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getOrgsOrg" }, "task": true }, { "name": "patchOrgsOrg", "summary": "Edit an Organization.", "description": "Edit an Organization.", "input": [ { "name": "org", "type": "string", "info": "Name of organisation.", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "body", "type": "object", "info": "", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchOrgsOrg" }, "task": true }, { "name": "getOrgsOrgEvents", "summary": "List public events for an organization.", "description": "List public events for an organization.", "input": [ { "name": "org", "type": "string", "info": "Name of organisation.", "required": true, "schema": { "title": "org", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getOrgsOrgEvents" }, "task": true }, { "name": "getOrgsOrgIssues", "summary": "List issues.\nList all issues for a given organization for the authenticated user.", "description": "List issues.\nList all issues for a given organization for the authenticated user.", "input": [ { "name": "org", "type": "string", "info": "Name of organisation.", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "filter", "type": "string", "info": "Issues assigned to you / created by you / mentioning you / you're\nsubscribed to updates for / All issues the authenticated user can see", "required": true, "schema": { "title": "filter", "type": "string" } }, { "name": "state", "type": "string", "info": "", "required": true, "schema": { "title": "state", "type": "string" } }, { "name": "labels", "type": "string", "info": "String list of comma separated Label names. Example - bug,ui,@high.", "required": true, "schema": { "title": "labels", "type": "string" } }, { "name": "sort", "type": "string", "info": "", "required": true, "schema": { "title": "sort", "type": "string" } }, { "name": "direction", "type": "string", "info": "", "required": true, "schema": { "title": "direction", "type": "string" } }, { "name": "since", "type": "string", "info": "Optional string of a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.\nOnly issues updated at or after this time are returned.", "required": false, "schema": { "title": "since", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getOrgsOrgIssues" }, "task": true }, { "name": "getOrgsOrgMembers", "summary": "Members list.\nList all users who are members of an organization. A member is a user tha\nbelongs to at least 1 team in the organization. If the authenticated user\nis also an owner of this organization then both concealed and public members\nwill be returned. If the requester is not an owner of the organization the\nquery will be redirected to the public members list.", "description": "Members list.\nList all users who are members of an organization. A member is a user tha\nbelongs to at least 1 team in the organization. If the authenticated user\nis also an owner of this organization then both concealed and public members\nwill be returned. If the requester is not an owner of the organization the\nquery will be redirected to the public members list.", "input": [ { "name": "org", "type": "string", "info": "Name of organisation.", "required": true, "schema": { "title": "org", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getOrgsOrgMembers" }, "task": true }, { "name": "deleteOrgsOrgMembersUsername", "summary": "Remove a member.\nRemoving a user from this list will remove them from all teams and they\nwill no longer have any access to the organization's repositories.", "description": "Remove a member.\nRemoving a user from this list will remove them from all teams and they\nwill no longer have any access to the organization's repositories.", "input": [ { "name": "org", "type": "string", "info": "Name of organisation.", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "username", "type": "string", "info": "Name of the user.", "required": true, "schema": { "title": "username", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteOrgsOrgMembersUsername" }, "task": true }, { "name": "getOrgsOrgMembersUsername", "summary": "Check if a user is, publicly or privately, a member of the organization.", "description": "Check if a user is, publicly or privately, a member of the organization.", "input": [ { "name": "org", "type": "string", "info": "Name of organisation.", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "username", "type": "string", "info": "Name of the user.", "required": true, "schema": { "title": "username", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getOrgsOrgMembersUsername" }, "task": true }, { "name": "getOrgsOrgPublicMembers", "summary": "Public members list.\nMembers of an organization can choose to have their membership publicized\nor not.", "description": "Public members list.\nMembers of an organization can choose to have their membership publicized\nor not.", "input": [ { "name": "org", "type": "string", "info": "Name of organisation.", "required": true, "schema": { "title": "org", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getOrgsOrgPublicMembers" }, "task": true }, { "name": "deleteOrgsOrgPublicMembersUsername", "summary": "Conceal a user's membership.", "description": "Conceal a user's membership.", "input": [ { "name": "org", "type": "string", "info": "Name of organisation.", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "username", "type": "string", "info": "Name of the user.", "required": true, "schema": { "title": "username", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteOrgsOrgPublicMembersUsername" }, "task": true }, { "name": "getOrgsOrgPublicMembersUsername", "summary": "Check public membership.", "description": "Check public membership.", "input": [ { "name": "org", "type": "string", "info": "Name of organisation.", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "username", "type": "string", "info": "Name of the user.", "required": true, "schema": { "title": "username", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getOrgsOrgPublicMembersUsername" }, "task": true }, { "name": "putOrgsOrgPublicMembersUsername", "summary": "Publicize a user's membership.", "description": "Publicize a user's membership.", "input": [ { "name": "org", "type": "string", "info": "Name of organisation.", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "username", "type": "string", "info": "Name of the user.", "required": true, "schema": { "title": "username", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putOrgsOrgPublicMembersUsername" }, "task": true }, { "name": "getOrgsOrgRepos", "summary": "List repositories for the specified org.", "description": "List repositories for the specified org.", "input": [ { "name": "org", "type": "string", "info": "Name of organisation.", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "type", "type": "string", "info": "", "required": false, "schema": { "title": "type", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getOrgsOrgRepos" }, "task": true }, { "name": "postOrgsOrgRepos", "summary": "Create a new repository for the authenticated user. OAuth users must supply\nrepo scope.", "description": "Create a new repository for the authenticated user. OAuth users must supply\nrepo scope.", "input": [ { "name": "org", "type": "string", "info": "Name of organisation.", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "body", "type": "object", "info": "", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postOrgsOrgRepos" }, "task": true }, { "name": "getOrgsOrgTeams", "summary": "List teams.", "description": "List teams.", "input": [ { "name": "org", "type": "string", "info": "Name of organisation.", "required": true, "schema": { "title": "org", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getOrgsOrgTeams" }, "task": true }, { "name": "postOrgsOrgTeams", "summary": "Create team.\nIn order to create a team, the authenticated user must be an owner of organization.", "description": "Create team.\nIn order to create a team, the authenticated user must be an owner of organization.", "input": [ { "name": "org", "type": "string", "info": "Name of organisation.", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "body", "type": "object", "info": "", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postOrgsOrgTeams" }, "task": true }, { "name": "getRateLimit", "summary": "Get your current rate limit status\nNote: Accessing this endpoint does not count against your rate limit.", "description": "Get your current rate limit status\nNote: Accessing this endpoint does not count against your rate limit.", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/getRateLimit" }, "task": true }, { "name": "deleteReposOwnerRepo", "summary": "Delete a Repository.\nDeleting a repository requires admin access. If OAuth is used, the delete_repo\nscope is required.", "description": "Delete a Repository.\nDeleting a repository requires admin access. If OAuth is used, the delete_repo\nscope is required.", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteReposOwnerRepo" }, "task": true }, { "name": "getReposOwnerRepo", "summary": "Get repository.", "description": "Get repository.", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getReposOwnerRepo" }, "task": true }, { "name": "patchReposOwnerRepo", "summary": "Edit repository.", "description": "Edit repository.", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "body", "type": "object", "info": "", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchReposOwnerRepo" }, "task": true }, { "name": "getReposOwnerRepoAssignees", "summary": "List assignees.\nThis call lists all the available assignees (owner + collaborators) to which\nissues may be assigned.", "description": "List assignees.\nThis call lists all the available assignees (owner + collaborators) to which\nissues may be assigned.", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getReposOwnerRepoAssignees" }, "task": true }, { "name": "getReposOwnerRepoAssigneesAssignee", "summary": "Check assignee.\nYou may also check to see if a particular user is an assignee for a repository.", "description": "Check assignee.\nYou may also check to see if a particular user is an assignee for a repository.", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "assignee", "type": "string", "info": "Login of the assignee.", "required": true, "schema": { "title": "assignee", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getReposOwnerRepoAssigneesAssignee" }, "task": true }, { "name": "getReposOwnerRepoBranches", "summary": "Get list of branches", "description": "Get list of branches", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getReposOwnerRepoBranches" }, "task": true }, { "name": "getReposOwnerRepoBranchesBranch", "summary": "Get Branch", "description": "Get Branch", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "branch", "type": "string", "info": "Name of the branch.", "required": true, "schema": { "title": "branch", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getReposOwnerRepoBranchesBranch" }, "task": true }, { "name": "getReposOwnerRepoCollaborators", "summary": "List.\nWhen authenticating as an organization owner of an organization-owned\nrepository, all organization owners are included in the list of\ncollaborators. Otherwise, only users with access to the repository are\nreturned in the collaborators list.", "description": "List.\nWhen authenticating as an organization owner of an organization-owned\nrepository, all organization owners are included in the list of\ncollaborators. Otherwise, only users with access to the repository are\nreturned in the collaborators list.", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getReposOwnerRepoCollaborators" }, "task": true }, { "name": "deleteReposOwnerRepoCollaboratorsUser", "summary": "Remove collaborator.", "description": "Remove collaborator.", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "user", "type": "string", "info": "Login of the user.", "required": true, "schema": { "title": "user", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteReposOwnerRepoCollaboratorsUser" }, "task": true }, { "name": "getReposOwnerRepoCollaboratorsUser", "summary": "Check if user is a collaborator", "description": "Check if user is a collaborator", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "user", "type": "string", "info": "Login of the user.", "required": true, "schema": { "title": "user", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getReposOwnerRepoCollaboratorsUser" }, "task": true }, { "name": "putReposOwnerRepoCollaboratorsUser", "summary": "Add collaborator.", "description": "Add collaborator.", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "user", "type": "string", "info": "Login of the user.", "required": true, "schema": { "title": "user", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putReposOwnerRepoCollaboratorsUser" }, "task": true }, { "name": "getReposOwnerRepoComments", "summary": "List commit comments for a repository.\nComments are ordered by ascending ID.", "description": "List commit comments for a repository.\nComments are ordered by ascending ID.", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getReposOwnerRepoComments" }, "task": true }, { "name": "deleteReposOwnerRepoCommentsCommentId", "summary": "Delete a commit comment", "description": "Delete a commit comment", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "commentId", "type": "number", "info": "Id of comment.", "required": true, "schema": { "title": "commentId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteReposOwnerRepoCommentsCommentId" }, "task": true }, { "name": "getReposOwnerRepoCommentsCommentId", "summary": "Get a single commit comment.", "description": "Get a single commit comment.", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "commentId", "type": "number", "info": "Id of comment.", "required": true, "schema": { "title": "commentId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getReposOwnerRepoCommentsCommentId" }, "task": true }, { "name": "patchReposOwnerRepoCommentsCommentId", "summary": "Update a commit comment.", "description": "Update a commit comment.", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "commentId", "type": "number", "info": "Id of comment.", "required": true, "schema": { "title": "commentId", "type": "number" } }, { "name": "body", "type": "object", "info": "", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchReposOwnerRepoCommentsCommentId" }, "task": true }, { "name": "getReposOwnerRepoCommits", "summary": "List commits on a repository.", "description": "List commits on a repository.", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "since", "type": "string", "info": "The time should be passed in as UTC in the ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.\nExample: \"2012-10-09T23:39:01Z\".", "required": false, "schema": { "title": "since", "type": "string" } }, { "name": "sha", "type": "string", "info": "Sha or branch to start listing commits from.", "required": false, "schema": { "title": "sha", "type": "string" } }, { "name": "pathParam", "type": "string", "info": "Only commits containing this file path will be returned.", "required": false, "schema": { "title": "pathParam", "type": "string" } }, { "name": "author", "type": "string", "info": "GitHub login, name, or email by which to filter by commit author.", "required": false, "schema": { "title": "author", "type": "string" } }, { "name": "until", "type": "string", "info": "ISO 8601 Date - Only commits before this date will be returned.", "required": false, "schema": { "title": "until", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getReposOwnerRepoCommits" }, "task": true }, { "name": "getReposOwnerRepoCommitsRefStatus", "summary": "Get the combined Status for a specific Ref\nThe Combined status endpoint is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the blog post for full details.\nTo access this endpoint during the preview period, you must provide a custom media type in the Accept header:\napplication/vnd.github.she-hulk-preview+json", "description": "Get the combined Status for a specific Ref\nThe Combined status endpoint is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the blog post for full details.\nTo access this endpoint during the preview period, you must provide a custom media type in the Accept header:\napplication/vnd.github.she-hulk-preview+json", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "ref", "type": "string", "info": "", "required": true, "schema": { "title": "ref", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getReposOwnerRepoCommitsRefStatus" }, "task": true }, { "name": "getReposOwnerRepoCommitsShaCode", "summary": "Get a single commit.", "description": "Get a single commit.", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "shaCode", "type": "string", "info": "SHA-1 code of the commit.", "required": true, "schema": { "title": "shaCode", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getReposOwnerRepoCommitsShaCode" }, "task": true }, { "name": "getReposOwnerRepoCommitsShaCodeComments", "summary": "List comments for a single commitList comments for a single commit.", "description": "List comments for a single commitList comments for a single commit.", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "shaCode", "type": "string", "info": "SHA-1 code of the commit.", "required": true, "schema": { "title": "shaCode", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getReposOwnerRepoCommitsShaCodeComments" }, "task": true }, { "name": "postReposOwnerRepoCommitsShaCodeComments", "summary": "Create a commit comment.", "description": "Create a commit comment.", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "shaCode", "type": "string", "info": "SHA-1 code of the commit.", "required": true, "schema": { "title": "shaCode", "type": "string" } }, { "name": "body", "type": "object", "info": "", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postReposOwnerRepoCommitsShaCodeComments" }, "task": true }, { "name": "getReposOwnerRepoCompareBaseIdHeadId", "summary": "Compare two commits", "description": "Compare two commits", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "baseId", "type": "string", "info": "", "required": true, "schema": { "title": "baseId", "type": "string" } }, { "name": "headId", "type": "string", "info": "", "required": true, "schema": { "title": "headId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getReposOwnerRepoCompareBaseIdHeadId" }, "task": true }, { "name": "deleteReposOwnerRepoContentsPath", "summary": "Delete a file.\nThis method deletes a file in a repository.", "description": "Delete a file.\nThis method deletes a file in a repository.", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "pathParam", "type": "string", "info": "", "required": true, "schema": { "title": "pathParam", "type": "string" } }, { "name": "body", "type": "object", "info": "", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteReposOwnerRepoContentsPath" }, "task": true }, { "name": "getReposOwnerRepoContentsPath", "summary": "Get contents.\nThis method returns the contents of a file or directory in a repository.\nFiles and symlinks support a custom media type for getting the raw content.\nDirectories and submodules do not support custom media types.\nNote: This API supports files up to 1 megabyte in size.\nHere can be many outcomes. For details see \"http://developer.github.com/v3/repos/contents/\"", "description": "Get contents.\nThis method returns the contents of a file or directory in a repository.\nFiles and symlinks support a custom media type for getting the raw content.\nDirectories and submodules do not support custom media types.\nNote: This API supports files up to 1 megabyte in size.\nHere can be many outcomes. For details see \"http://developer.github.com/v3/repos/contents/\"", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "pathParam", "type": "string", "info": "", "required": true, "schema": { "title": "pathParam", "type": "string" } }, { "name": "pathParamQuery", "type": "string", "info": "The content path.", "required": false, "schema": { "title": "pathParamQuery", "type": "string" } }, { "name": "ref", "type": "string", "info": "The String name of the Commit/Branch/Tag. Defaults to 'master'.", "required": false, "schema": { "title": "ref", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getReposOwnerRepoContentsPath" }, "task": true }, { "name": "putReposOwnerRepoContentsPath", "summary": "Create a file.", "description": "Create a file.", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "pathParam", "type": "string", "info": "", "required": true, "schema": { "title": "pathParam", "type": "string" } }, { "name": "body", "type": "object", "info": "", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putReposOwnerRepoContentsPath" }, "task": true }, { "name": "pushMultipleFiles", "summary": "Create multiple files", "description": "Create multiple files.", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "files", "type": "array", "info": "Array of file objects with `path` and `content`. The format will be [{\"path\":\"string1\",\"content\":\"object1\"},{\"path\":\"string2\",\"content\":\"object2\"}]", "required": true, "schema": { "title": "files", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/pushMultipleFiles" }, "task": true }, { "name": "getReposOwnerRepoContributors", "summary": "Get list of contributors.", "description": "Get list of contributors.", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "anon", "type": "string", "info": "Set to 1 or true to include anonymous contributors in results.", "required": true, "schema": { "title": "anon", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getReposOwnerRepoContributors" }, "task": true }, { "name": "getReposOwnerRepoDeployments", "summary": "Users with pull access can view deployments for a repository", "description": "Users with pull access can view deployments for a repository", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getReposOwnerRepoDeployments" }, "task": true }, { "name": "postReposOwnerRepoDeployments", "summary": "Users with push access can create a deployment for a given ref", "description": "Users with push access can create a deployment for a given ref", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "body", "type": "object", "info": "", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postReposOwnerRepoDeployments" }, "task": true }, { "name": "getReposOwnerRepoDeploymentsIdStatuses", "summary": "Users with pull access can view deployment statuses for a deployment", "description": "Users with pull access can view deployment statuses for a deployment", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "id", "type": "number", "info": "The Deployment ID to list the statuses from.", "required": true, "schema": { "title": "id", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getReposOwnerRepoDeploymentsIdStatuses" }, "task": true }, { "name": "postReposOwnerRepoDeploymentsIdStatuses", "summary": "Create a Deployment Status\nUsers with push access can create deployment statuses for a given deployment:", "description": "Create a Deployment Status\nUsers with push access can create deployment statuses for a given deployment:", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "id", "type": "number", "info": "The Deployment ID to list the statuses from.", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "body", "type": "object", "info": "", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postReposOwnerRepoDeploymentsIdStatuses" }, "task": true }, { "name": "getReposOwnerRepoDownloads", "summary": "Deprecated. List downloads for a repository.", "description": "Deprecated. List downloads for a repository.", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getReposOwnerRepoDownloads" }, "task": true }, { "name": "deleteReposOwnerRepoDownloadsDownloadId", "summary": "Deprecated. Delete a download.", "description": "Deprecated. Delete a download.", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "downloadId", "type": "number", "info": "Id of download.", "required": true, "schema": { "title": "downloadId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteReposOwnerRepoDownloadsDownloadId" }, "task": true }, { "name": "getReposOwnerRepoDownloadsDownloadId", "summary": "Deprecated. Get a single download.", "description": "Deprecated. Get a single download.", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "downloadId", "type": "number", "info": "Id of download.", "required": true, "schema": { "title": "downloadId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getReposOwnerRepoDownloadsDownloadId" }, "task": true }, { "name": "getReposOwnerRepoEvents", "summary": "Get list of repository events.", "description": "Get list of repository events.", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getReposOwnerRepoEvents" }, "task": true }, { "name": "getReposOwnerRepoForks", "summary": "List forks.", "description": "List forks.", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "sort", "type": "string", "info": "", "required": false, "schema": { "title": "sort", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getReposOwnerRepoForks" }, "task": true }, { "name": "postReposOwnerRepoForks", "summary": "Create a fork.\nForking a Repository happens asynchronously. Therefore, you may have to wai\na short period before accessing the git objects. If this takes longer than 5\nminutes, be sure to contact Support.", "description": "Create a fork.\nForking a Repository happens asynchronously. Therefore, you may have to wai\na short period before accessing the git objects. If this takes longer than 5\nminutes, be sure to contact Support.", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "body", "type": "object", "info": "", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postReposOwnerRepoForks" }, "task": true }, { "name": "postReposOwnerRepoGitBlobs", "summary": "Create a Blob.", "description": "Create a Blob.", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "body", "type": "object", "info": "", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postReposOwnerRepoGitBlobs" }, "task": true }, { "name": "getReposOwnerRepoGitBlobsShaCode", "summary": "Get a Blob.\nSince blobs can be any arbitrary binary data, the input and responses for\nthe blob API takes an encoding parameter that can be either utf-8 or\nbase64. If your data cannot be losslessly sent as a UTF-8 string, you can\nbase64 encode it.", "description": "Get a Blob.\nSince blobs can be any arbitrary binary data, the input and responses for\nthe blob API takes an encoding parameter that can be either utf-8 or\nbase64. If your data cannot be losslessly sent as a UTF-8 string, you can\nbase64 encode it.", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "shaCode", "type": "string", "info": "SHA-1 code.", "required": true, "schema": { "title": "shaCode", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getReposOwnerRepoGitBlobsShaCode" }, "task": true }, { "name": "postReposOwnerRepoGitCommits", "summary": "Create a Commit.", "description": "Create a Commit.", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "body", "type": "object", "info": "", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postReposOwnerRepoGitCommits" }, "task": true }, { "name": "getReposOwnerRepoGitCommitsShaCode", "summary": "Get a Commit.", "description": "Get a Commit.", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "shaCode", "type": "string", "info": "SHA-1 code.", "required": true, "schema": { "title": "shaCode", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getReposOwnerRepoGitCommitsShaCode" }, "task": true }, { "name": "getReposOwnerRepoGitRefs", "summary": "Get all References", "description": "Get all References", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getReposOwnerRepoGitRefs" }, "task": true }, { "name": "postReposOwnerRepoGitRefs", "summary": "Create a Reference", "description": "Create a Reference", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "body", "type": "object", "info": "", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postReposOwnerRepoGitRefs" }, "task": true }, { "name": "deleteReposOwnerRepoGitRefsRef", "summary": "Delete a Reference\nExample: Deleting a branch: DELETE /repos/octocat/Hello-World/git/refs/heads/feature-a\nExample: Deleting a tag: DELETE /repos/octocat/Hello-World/git/refs/tags/v1.0", "description": "Delete a Reference\nExample: Deleting a branch: DELETE /repos/octocat/Hello-World/git/refs/heads/feature-a\nExample: Deleting a tag: DELETE /repos/octocat/Hello-World/git/refs/tags/v1.0", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "ref", "type": "string", "info": "", "required": true, "schema": { "title": "ref", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteReposOwnerRepoGitRefsRef" }, "task": true }, { "name": "getReposOwnerRepoGitMatchingRefs", "summary": "Get all Matching References", "description": "Get all Matching References", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "ref", "type": "string", "info": "Name of reference.", "required": true, "schema": { "title": "ref", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getReposOwnerRepoGitMatchingRefs" }, "task": true }, { "name": "getReposOwnerRepoGitRefsRef", "summary": "Get a Reference", "description": "Get a Reference", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "ref", "type": "string", "info": "", "required": true, "schema": { "title": "ref", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getReposOwnerRepoGitRefsRef" }, "task": true }, { "name": "patchReposOwnerRepoGitRefsRef", "summary": "Update a Reference", "description": "Update a Reference", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "ref", "type": "string", "info": "", "required": true, "schema": { "title": "ref", "type": "string" } }, { "name": "body", "type": "object", "info": "", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchReposOwnerRepoGitRefsRef" }, "task": true }, { "name": "postReposOwnerRepoGitTags", "summary": "Create a Tag Object.\nNote that creating a tag object does not create the reference that makes a\ntag in Git. If you want to create an annotated tag in Git, you have to do\nthis call to create the tag object, and then create the refs/tags/[tag]\nreference. If you want to create a lightweight tag, you only have to create\nthe tag reference - this call would be unnecessary.", "description": "Create a Tag Object.\nNote that creating a tag object does not create the reference that makes a\ntag in Git. If you want to create an annotated tag in Git, you have to do\nthis call to create the tag object, and then create the refs/tags/[tag]\nreference. If you want to create a lightweight tag, you only have to create\nthe tag reference - this call would be unnecessary.", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "body", "type": "object", "info": "", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postReposOwnerRepoGitTags" }, "task": true }, { "name": "getReposOwnerRepoGitTagsShaCode", "summary": "Get a Tag.", "description": "Get a Tag.", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "shaCode", "type": "string", "info": "", "required": true, "schema": { "title": "shaCode", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getReposOwnerRepoGitTagsShaCode" }, "task": true }, { "name": "postReposOwnerRepoGitTrees", "summary": "Create a Tree.\nThe tree creation API will take nested entries as well. If both a tree and\na nested path modifying that tree are specified, it will overwrite the\ncontents of that tree with the new path contents and write a new tree out.", "description": "Create a Tree.\nThe tree creation API will take nested entries as well. If both a tree and\na nested path modifying that tree are specified, it will overwrite the\ncontents of that tree with the new path contents and write a new tree out.", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "body", "type": "object", "info": "", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postReposOwnerRepoGitTrees" }, "task": true }, { "name": "getReposOwnerRepoGitTreesShaCode", "summary": "Get a Tree.", "description": "Get a Tree.", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "shaCode", "type": "string", "info": "Tree SHA.", "required": true, "schema": { "title": "shaCode", "type": "string" } }, { "name": "recursive", "type": "number", "info": "Get a Tree Recursively. (0 or 1)", "required": false, "schema": { "title": "recursive", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getReposOwnerRepoGitTreesShaCode" }, "task": true }, { "name": "getReposOwnerRepoHooks", "summary": "Get list of hooks.", "description": "Get list of hooks.", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getReposOwnerRepoHooks" }, "task": true }, { "name": "postReposOwnerRepoHooks", "summary": "Create a hook.", "description": "Create a hook.", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "body", "type": "object", "info": "", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postReposOwnerRepoHooks" }, "task": true }, { "name": "deleteReposOwnerRepoHooksHookId", "summary": "Delete a hook.", "description": "Delete a hook.", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "hookId", "type": "number", "info": "Id of hook.", "required": true, "schema": { "title": "hookId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteReposOwnerRepoHooksHookId" }, "task": true }, { "name": "getReposOwnerRepoHooksHookId", "summary": "Get single hook.", "description": "Get single hook.", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "hookId", "type": "number", "info": "Id of hook.", "required": true, "schema": { "title": "hookId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getReposOwnerRepoHooksHookId" }, "task": true }, { "name": "patchReposOwnerRepoHooksHookId", "summary": "Edit a hook.", "description": "Edit a hook.", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "hookId", "type": "number", "info": "Id of hook.", "required": true, "schema": { "title": "hookId", "type": "number" } }, { "name": "body", "type": "object", "info": "", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchReposOwnerRepoHooksHookId" }, "task": true }, { "name": "postReposOwnerRepoHooksHookIdTests", "summary": "Test a push hook.\nThis will trigger the hook with the latest push to the current repository\nif the hook is subscribed to push events. If the hook is not subscribed\nto push events, the server will respond with 204 but no test POST will\nbe generated.\nNote: Previously /repos/:owner/:repo/hooks/:id/tes", "description": "Test a push hook.\nThis will trigger the hook with the latest push to the current repository\nif the hook is subscribed to push events. If the hook is not subscribed\nto push events, the server will respond with 204 but no test POST will\nbe generated.\nNote: Previously /repos/:owner/:repo/hooks/:id/tes", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "hookId", "type": "number", "info": "Id of hook.", "required": true, "schema": { "title": "hookId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postReposOwnerRepoHooksHookIdTests" }, "task": true }, { "name": "getReposOwnerRepoIssues", "summary": "List issues for a repository.", "description": "List issues for a repository.", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "filter", "type": "string", "info": "Issues assigned to you / created by you / mentioning you / you're\nsubscribed to updates for / All issues the authenticated user can see", "required": true, "schema": { "title": "filter", "type": "string" } }, { "name": "state", "type": "string", "info": "", "required": true, "schema": { "title": "state", "type": "string" } }, { "name": "labels", "type": "string", "info": "String list of comma separated Label names. Example - bug,ui,@high.", "required": true, "schema": { "title": "labels", "type": "string" } }, { "name": "sort", "type": "string", "info": "", "required": true, "schema": { "title": "sort", "type": "string" } }, { "name": "direction", "type": "string", "info": "", "required": true, "schema": { "title": "direction", "type": "string" } }, { "name": "since", "type": "string", "info": "Optional string of a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.\nOnly issues updated at or after this time are returned.", "required": false, "schema": { "title": "since", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getReposOwnerRepoIssues" }, "task": true }, { "name": "postReposOwnerRepoIssues", "summary": "Create an issue.\nAny user with pull access to a repository can create an issue.", "description": "Create an issue.\nAny user with pull access to a repository can create an issue.", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "body", "type": "object", "info": "", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postReposOwnerRepoIssues" }, "task": true }, { "name": "getReposOwnerRepoIssuesComments", "summary": "List comments in a repository.", "description": "List comments in a repository.", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "direction", "type": "string", "info": "Ignored without 'sort' parameter.", "required": false, "schema": { "title": "direction", "type": "string" } }, { "name": "sort", "type": "string", "info": "", "required": false, "schema": { "title": "sort", "type": "string" } }, { "name": "since", "type": "string", "info": "The time should be passed in as UTC in the ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.\nExample: \"2012-10-09T23:39:01Z\".", "required": false, "schema": { "title": "since", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getReposOwnerRepoIssuesComments" }, "task": true }, { "name": "deleteReposOwnerRepoIssuesCommentsCommentId", "summary": "Delete a comment.", "description": "Delete a comment.", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "commentId", "type": "number", "info": "ID of comment.", "required": true, "schema": { "title": "commentId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteReposOwnerRepoIssuesCommentsCommentId" }, "task": true }, { "name": "getReposOwnerRepoIssuesCommentsCommentId", "summary": "Get a single comment.", "description": "Get a single comment.", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "commentId", "type": "number", "info": "ID of comment.", "required": true, "schema": { "title": "commentId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getReposOwnerRepoIssuesCommentsCommentId" }, "task": true }, { "name": "patchReposOwnerRepoIssuesCommentsCommentId", "summary": "Edit a comment.", "description": "Edit a comment.", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "commentId", "type": "number", "info": "ID of comment.", "required": true, "schema": { "title": "commentId", "type": "number" } }, { "name": "body", "type": "object", "info": "", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchReposOwnerRepoIssuesCommentsCommentId" }, "task": true }, { "name": "getReposOwnerRepoIssuesEvents", "summary": "List issue events for a repository.", "description": "List issue events for a repository.", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getReposOwnerRepoIssuesEvents" }, "task": true }, { "name": "getReposOwnerRepoIssuesEventsEventId", "summary": "Get a single event.", "description": "Get a single event.", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "eventId", "type": "number", "info": "Id of the event.", "required": true, "schema": { "title": "eventId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getReposOwnerRepoIssuesEventsEventId" }, "task": true }, { "name": "getReposOwnerRepoIssuesNumber", "summary": "Get a single issue", "description": "Get a single issue", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "number", "type": "number", "info": "Number of issue.", "required": true, "schema": { "title": "number", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getReposOwnerRepoIssuesNumber" }, "task": true }, { "name": "patchReposOwnerRepoIssuesNumber", "summary": "Edit an issue.\nIssue owners and users with push access can edit an issue.", "description": "Edit an issue.\nIssue owners and users with push access can edit an issue.", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "number", "type": "number", "info": "Number of issue.", "required": true, "schema": { "title": "number", "type": "number" } }, { "name": "body", "type": "object", "info": "", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchReposOwnerRepoIssuesNumber" }, "task": true }, { "name": "getReposOwnerRepoIssuesNumberComments", "summary": "List comments on an issue.", "description": "List comments on an issue.", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "number", "type": "number", "info": "Number of issue.", "required": true, "schema": { "title": "number", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getReposOwnerRepoIssuesNumberComments" }, "task": true }, { "name": "postReposOwnerRepoIssuesNumberComments", "summary": "Create a comment.", "description": "Create a comment.", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "number", "type": "number", "info": "Number of issue.", "required": true, "schema": { "title": "number", "type": "number" } }, { "name": "body", "type": "object", "info": "", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postReposOwnerRepoIssuesNumberComments" }, "task": true }, { "name": "getReposOwnerRepoIssuesNumberEvents", "summary": "List events for an issue.", "description": "List events for an issue.", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "number", "type": "number", "info": "Number of issue.", "required": true, "schema": { "title": "number", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getReposOwnerRepoIssuesNumberEvents" }, "task": true }, { "name": "deleteReposOwnerRepoIssuesNumberLabels", "summary": "Remove all labels from an issue.", "description": "Remove all labels from an issue.", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "number", "type": "number", "info": "Number of issue.", "required": true, "schema": { "title": "number", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteReposOwnerRepoIssuesNumberLabels" }, "task": true }, { "name": "getReposOwnerRepoIssuesNumberLabels", "summary": "List labels on an issue.", "description": "List labels on an issue.", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "number", "type": "number", "info": "Number of issue.", "required": true, "schema": { "title": "number", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getReposOwnerRepoIssuesNumberLabels" }, "task": true }, { "name": "postReposOwnerRepoIssuesNumberLabels", "summary": "Add labels to an issue.", "description": "Add labels to an issue.", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "number", "type": "number", "info": "Number of issue.", "required": true, "schema": { "title": "number", "type": "number" } }, { "name": "body", "type": "array", "info": "", "required": true, "schema": { "title": "body", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postReposOwnerRepoIssuesNumberLabels" }, "task": true }, { "name": "putReposOwnerRepoIssuesNumberLabels", "summary": "Replace all labels for an issue.\nSending an empty array ([]) will remove all Labels from the Issue.", "description": "Replace all labels for an issue.\nSending an empty array ([]) will remove all Labels from the Issue.", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "number", "type": "number", "info": "Number of issue.", "required": true, "schema": { "title": "number", "type": "number" } }, { "name": "body", "type": "array", "info": "", "required": true, "schema": { "title": "body", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putReposOwnerRepoIssuesNumberLabels" }, "task": true }, { "name": "deleteReposOwnerRepoIssuesNumberLabelsName", "summary": "Remove a label from an issue.", "description": "Remove a label from an issue.", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "number", "type": "number", "info": "Number of issue.", "required": true, "schema": { "title": "number", "type": "number" } }, { "name": "name", "type": "string", "info": "Name of the label.", "required": true, "schema": { "title": "name", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteReposOwnerRepoIssuesNumberLabelsName" }, "task": true }, { "name": "getReposOwnerRepoKeys", "summary": "Get list of keys.", "description": "Get list of keys.", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getReposOwnerRepoKeys" }, "task": true }, { "name": "postReposOwnerRepoKeys", "summary": "Create a key.", "description": "Create a key.", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "body", "type": "object", "info": "", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postReposOwnerRepoKeys" }, "task": true }, { "name": "deleteReposOwnerRepoKeysKeyId", "summary": "Delete a key.", "description": "Delete a key.", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "keyId", "type": "number", "info": "Id of key.", "required": true, "schema": { "title": "keyId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteReposOwnerRepoKeysKeyId" }, "task": true }, { "name": "getReposOwnerRepoKeysKeyId", "summary": "Get a key", "description": "Get a key", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "keyId", "type": "number", "info": "Id of key.", "required": true, "schema": { "title": "keyId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getReposOwnerRepoKeysKeyId" }, "task": true }, { "name": "getReposOwnerRepoLabels", "summary": "List all labels for this repository.", "description": "List all labels for this repository.", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getReposOwnerRepoLabels" }, "task": true }, { "name": "postReposOwnerRepoLabels", "summary": "Create a label.", "description": "Create a label.", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "body", "type": "array", "info": "", "required": true, "schema": { "title": "body", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postReposOwnerRepoLabels" }, "task": true }, { "name": "deleteReposOwnerRepoLabelsName", "summary": "Delete a label.", "description": "Delete a label.", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "name", "type": "string", "info": "Name of the label.", "required": true, "schema": { "title": "name", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteReposOwnerRepoLabelsName" }, "task": true }, { "name": "getReposOwnerRepoLabelsName", "summary": "Get a single label.", "description": "Get a single label.", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "name", "type": "string", "info": "Name of the label.", "required": true, "schema": { "title": "name", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getReposOwnerRepoLabelsName" }, "task": true }, { "name": "patchReposOwnerRepoLabelsName", "summary": "Update a label.", "description": "Update a label.", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "name", "type": "string", "info": "Name of the label.", "required": true, "schema": { "title": "name", "type": "string" } }, { "name": "body", "type": "array", "info": "", "required": true, "schema": { "title": "body", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchReposOwnerRepoLabelsName" }, "task": true }, { "name": "getReposOwnerRepoLanguages", "summary": "List languages.\nList languages for the specified repository. The value on the right of a\nlanguage is the number of bytes of code written in that language.", "description": "List languages.\nList languages for the specified repository. The value on the right of a\nlanguage is the number of bytes of code written in that language.", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getReposOwnerRepoLanguages" }, "task": true }, { "name": "postReposOwnerRepoMerges", "summary": "Perform a merge.", "description": "Perform a merge.", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "body", "type": "object", "info": "", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postReposOwnerRepoMerges" }, "task": true }, { "name": "getReposOwnerRepoMilestones", "summary": "List milestones for a repository.", "description": "List milestones for a repository.", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "state", "type": "string", "info": "String to filter by state.", "required": false, "schema": { "title": "state", "type": "string" } }, { "name": "direction", "type": "string", "info": "Ignored without 'sort' parameter.", "required": false, "schema": { "title": "direction", "type": "string" } }, { "name": "sort", "type": "string", "info": "", "required": false, "schema": { "title": "sort", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getReposOwnerRepoMilestones" }, "task": true }, { "name": "postReposOwnerRepoMilestones", "summary": "Create a milestone.", "description": "Create a milestone.", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "body", "type": "object", "info": "", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postReposOwnerRepoMilestones" }, "task": true }, { "name": "deleteReposOwnerRepoMilestonesNumber", "summary": "Delete a milestone.", "description": "Delete a milestone.", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "number", "type": "number", "info": "Number of milestone.", "required": true, "schema": { "title": "number", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteReposOwnerRepoMilestonesNumber" }, "task": true }, { "name": "getReposOwnerRepoMilestonesNumber", "summary": "Get a single milestone.", "description": "Get a single milestone.", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "number", "type": "number", "info": "Number of milestone.", "required": true, "schema": { "title": "number", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getReposOwnerRepoMilestonesNumber" }, "task": true }, { "name": "patchReposOwnerRepoMilestonesNumber", "summary": "Update a milestone.", "description": "Update a milestone.", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "number", "type": "number", "info": "Number of milestone.", "required": true, "schema": { "title": "number", "type": "number" } }, { "name": "body", "type": "object", "info": "", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchReposOwnerRepoMilestonesNumber" }, "task": true }, { "name": "getReposOwnerRepoMilestonesNumberLabels", "summary": "Get labels for every issue in a milestone.", "description": "Get labels for every issue in a milestone.", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "number", "type": "number", "info": "Number of milestone.", "required": true, "schema": { "title": "number", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getReposOwnerRepoMilestonesNumberLabels" }, "task": true }, { "name": "getReposOwnerRepoNotifications", "summary": "List your notifications in a repository\nList all notifications for the current user.", "description": "List your notifications in a repository\nList all notifications for the current user.", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "all", "type": "boolean", "info": "True to show notifications marked as read.", "required": false, "schema": { "title": "all", "type": "boolean" } }, { "name": "participating", "type": "boolean", "info": "True to show only notifications in which the user is directly participating\nor mentioned.", "required": false, "schema": { "title": "participating", "type": "boolean" } }, { "name": "since", "type": "string", "info": "The time should be passed in as UTC in the ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.\nExample: \"2012-10-09T23:39:01Z\".", "required": false, "schema": { "title": "since", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getReposOwnerRepoNotifications" }, "task": true }, { "name": "putReposOwnerRepoNotifications", "summary": "Mark notifications as read in a repository.\nMarking all notifications in a repository as \"read\" removes them from the\ndefault view on GitHub.com.", "description": "Mark notifications as read in a repository.\nMarking all notifications in a repository as \"read\" removes them from the\ndefault view on GitHub.com.", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "body", "type": "object", "info": "", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putReposOwnerRepoNotifications" }, "task": true }, { "name": "getReposOwnerRepoPulls", "summary": "List pull requests.", "description": "List pull requests.", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "state", "type": "string", "info": "String to filter by state.", "required": false, "schema": { "title": "state", "type": "string" } }, { "name": "head", "type": "string", "info": "Filter pulls by head user and branch name in the format of 'user:ref-name'.\nExample: github:new-script-format.", "required": false, "schema": { "title": "head", "type": "string" } }, { "name": "base", "type": "string", "info": "Filter pulls by base branch name. Example - gh-pages.", "required": false, "schema": { "title": "base", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getReposOwnerRepoPulls" }, "task": true }, { "name": "postReposOwnerRepoPulls", "summary": "Create a pull request.", "description": "Create a pull request.", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "body", "type": "object", "info": "", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postReposOwnerRepoPulls" }, "task": true }, { "name": "getReposOwnerRepoPullsComments", "summary": "List comments in a repository.\nBy default, Review Comments are ordered by ascending ID.", "description": "List comments in a repository.\nBy default, Review Comments are ordered by ascending ID.", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "direction", "type": "string", "info": "Ignored without 'sort' parameter.", "required": false, "schema": { "title": "direction", "type": "string" } }, { "name": "sort", "type": "string", "info": "", "required": false, "schema": { "title": "sort", "type": "string" } }, { "name": "since", "type": "string", "info": "The time should be passed in as UTC in the ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.\nExample: \"2012-10-09T23:39:01Z\".", "required": false, "schema": { "title": "since", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getReposOwnerRepoPullsComments" }, "task": true }, { "name": "deleteReposOwnerRepoPullsCommentsCommentId", "summary": "Delete a comment.", "description": "Delete a comment.", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "commentId", "type": "number", "info": "Id of comment.", "required": true, "schema": { "title": "commentId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteReposOwnerRepoPullsCommentsCommentId" }, "task": true }, { "name": "getReposOwnerRepoPullsCommentsCommentId", "summary": "Get a single comment.", "description": "Get a single comment.", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "commentId", "type": "number", "info": "Id of comment.", "required": true, "schema": { "title": "commentId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getReposOwnerRepoPullsCommentsCommentId" }, "task": true }, { "name": "patchReposOwnerRepoPullsCommentsCommentId", "summary": "Edit a comment.", "description": "Edit a comment.", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "commentId", "type": "number", "info": "Id of comment.", "required": true, "schema": { "title": "commentId", "type": "number" } }, { "name": "body", "type": "object", "info": "", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchReposOwnerRepoPullsCommentsCommentId" }, "task": true }, { "name": "getReposOwnerRepoPullsNumber", "summary": "Get a single pull request.", "description": "Get a single pull request.", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "number", "type": "number", "info": "Id of pull.", "required": true, "schema": { "title": "number", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getReposOwnerRepoPullsNumber" }, "task": true }, { "name": "patchReposOwnerRepoPullsNumber", "summary": "Update a pull request.", "description": "Update a pull request.", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "number", "type": "number", "info": "Id of pull.", "required": true, "schema": { "title": "number", "type": "number" } }, { "name": "body", "type": "object", "info": "", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchReposOwnerRepoPullsNumber" }, "task": true }, { "name": "getReposOwnerRepoPullsNumberComments", "summary": "List comments on a pull request.", "description": "List comments on a pull request.", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "number", "type": "number", "info": "Id of pull.", "required": true, "schema": { "title": "number", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getReposOwnerRepoPullsNumberComments" }, "task": true }, { "name": "postReposOwnerRepoPullsNumberComments", "summary": "Create a comment.\n #TODO Alternative input ( http://developer.github.com/v3/pulls/comments/ )\n description: |\n Alternative Input.\n Instead of passing commit_id, path, and position you can reply to an\n existing Pull Request Comment like this:\n\n body\n Required string\n in_reply_to\n Required number - Comment id to reply to.", "description": "Create a comment.\n #TODO Alternative input ( http://developer.github.com/v3/pulls/comments/ )\n description: |\n Alternative Input.\n Instead of passing commit_id, path, and position you can reply to an\n existing Pull Request Comment like this:\n\n body\n Required string\n in_reply_to\n Required number - Comment id to reply to.", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "number", "type": "number", "info": "Id of pull.", "required": true, "schema": { "title": "number", "type": "number" } }, { "name": "body", "type": "object", "info": "", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postReposOwnerRepoPullsNumberComments" }, "task": true }, { "name": "getReposOwnerRepoPullsNumberCommits", "summary": "List commits on a pull request.", "description": "List commits on a pull request.", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "number", "type": "number", "info": "Id of pull.", "required": true, "schema": { "title": "number", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getReposOwnerRepoPullsNumberCommits" }, "task": true }, { "name": "getReposOwnerRepoPullsNumberFiles", "summary": "List pull requests files.", "description": "List pull requests files.", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "number", "type": "number", "info": "Id of pull.", "required": true, "schema": { "title": "number", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getReposOwnerRepoPullsNumberFiles" }, "task": true }, { "name": "getReposOwnerRepoPullsNumberMerge", "summary": "Get if a pull request has been merged.", "description": "Get if a pull request has been merged.", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "number", "type": "number", "info": "Id of pull.", "required": true, "schema": { "title": "number", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getReposOwnerRepoPullsNumberMerge" }, "task": true }, { "name": "putReposOwnerRepoPullsNumberMerge", "summary": "Merge a pull request (Merge Button's)", "description": "Merge a pull request (Merge Button's)", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "number", "type": "number", "info": "Id of pull.", "required": true, "schema": { "title": "number", "type": "number" } }, { "name": "body", "type": "object", "info": "", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putReposOwnerRepoPullsNumberMerge" }, "task": true }, { "name": "getReposOwnerRepoReadme", "summary": "Get the README.\nThis method returns the preferred README for a repository.", "description": "Get the README.\nThis method returns the preferred README for a repository.", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "ref", "type": "string", "info": "The String name of the Commit/Branch/Tag. Defaults to master.", "required": false, "schema": { "title": "ref", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getReposOwnerRepoReadme" }, "task": true }, { "name": "getReposOwnerRepoReleases", "summary": "Users with push access to the repository will receive all releases (i.e., published releases and draft releases). Users with pull access will receive published releases only", "description": "Users with push access to the repository will receive all releases (i.e., published releases and draft releases). Users with pull access will receive published releases only", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getReposOwnerRepoReleases" }, "task": true }, { "name": "postReposOwnerRepoReleases", "summary": "Create a release\nUsers with push access to the repository can create a release.", "description": "Create a release\nUsers with push access to the repository can create a release.", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "body", "type": "object", "info": "", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postReposOwnerRepoReleases" }, "task": true }, { "name": "deleteReposOwnerRepoReleasesAssetsId", "summary": "Delete a release asset", "description": "Delete a release asset", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "id", "type": "string", "info": "", "required": true, "schema": { "title": "id", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteReposOwnerRepoReleasesAssetsId" }, "task": true }, { "name": "getReposOwnerRepoReleasesAssetsId", "summary": "Get a single release asset", "description": "Get a single release asset", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "id", "type": "string", "info": "", "required": true, "schema": { "title": "id", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getReposOwnerRepoReleasesAssetsId" }, "task": true }, { "name": "patchReposOwnerRepoReleasesAssetsId", "summary": "Edit a release asset\nUsers with push access to the repository can edit a release asset.", "description": "Edit a release asset\nUsers with push access to the repository can edit a release asset.", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "id", "type": "string", "info": "", "required": true, "schema": { "title": "id", "type": "string" } }, { "name": "body", "type": "object", "info": "", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchReposOwnerRepoReleasesAssetsId" }, "task": true }, { "name": "deleteReposOwnerRepoReleasesId", "summary": "Users with push access to the repository can delete a release.", "description": "Users with push access to the repository can delete a release.", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "id", "type": "string", "info": "", "required": true, "schema": { "title": "id", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteReposOwnerRepoReleasesId" }, "task": true }, { "name": "getReposOwnerRepoReleasesId", "summary": "Get a single release", "description": "Get a single release", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "id", "type": "string", "info": "", "required": true, "schema": { "title": "id", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getReposOwnerRepoReleasesId" }, "task": true }, { "name": "patchReposOwnerRepoReleasesId", "summary": "Users with push access to the repository can edit a release", "description": "Users with push access to the repository can edit a release", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "id", "type": "string", "info": "", "required": true, "schema": { "title": "id", "type": "string" } }, { "name": "body", "type": "object", "info": "", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchReposOwnerRepoReleasesId" }, "task": true }, { "name": "getReposOwnerRepoReleasesIdAssets", "summary": "List assets for a release", "description": "List assets for a release", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "id", "type": "string", "info": "", "required": true, "schema": { "title": "id", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getReposOwnerRepoReleasesIdAssets" }, "task": true }, { "name": "getReposOwnerRepoStargazers", "summary": "List Stargazers.", "description": "List Stargazers.", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getReposOwnerRepoStargazers" }, "task": true }, { "name": "getReposOwnerRepoStatsCodeFrequency", "summary": "Get the number of additions and deletions per week.\nReturns a weekly aggregate of the number of additions and deletions pushed\nto a repository.", "description": "Get the number of additions and deletions per week.\nReturns a weekly aggregate of the number of additions and deletions pushed\nto a repository.", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getReposOwnerRepoStatsCodeFrequency" }, "task": true }, { "name": "getReposOwnerRepoStatsCommitActivity", "summary": "Get the last year of commit activity data.\nReturns the last year of commit activity grouped by week. The days array\nis a group of commits per day, starting on Sunday.", "description": "Get the last year of commit activity data.\nReturns the last year of commit activity grouped by week. The days array\nis a group of commits per day, starting on Sunday.", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getReposOwnerRepoStatsCommitActivity" }, "task": true }, { "name": "getReposOwnerRepoStatsContributors", "summary": "Get contributors list with additions, deletions, and commit counts.", "description": "Get contributors list with additions, deletions, and commit counts.", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getReposOwnerRepoStatsContributors" }, "task": true }, { "name": "getReposOwnerRepoStatsParticipation", "summary": "Get the weekly commit count for the repo owner and everyone else.", "description": "Get the weekly commit count for the repo owner and everyone else.", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getReposOwnerRepoStatsParticipation" }, "task": true }, { "name": "getReposOwnerRepoStatsPunchCard", "summary": "Get the number of commits per hour in each day.\nEach array contains the day number, hour number, and number of commits\n0-6 Sunday - Saturday\n0-23 Hour of day\nNumber of commits\n\nFor example, [2, 14, 25] indicates that there were 25 total commits, during\nthe 2.00pm hour on Tuesdays. All times are based on the time zone of\nindividual commits.", "description": "Get the number of commits per hour in each day.\nEach array contains the day number, hour number, and number of commits\n0-6 Sunday - Saturday\n0-23 Hour of day\nNumber of commits\n\nFor example, [2, 14, 25] indicates that there were 25 total commits, during\nthe 2.00pm hour on Tuesdays. All times are based on the time zone of\nindividual commits.", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getReposOwnerRepoStatsPunchCard" }, "task": true }, { "name": "getReposOwnerRepoStatusesRef", "summary": "List Statuses for a specific Ref.", "description": "List Statuses for a specific Ref.", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "ref", "type": "string", "info": "Ref to list the statuses from. It can be a SHA, a branch name, or a tag name.", "required": true, "schema": { "title": "ref", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getReposOwnerRepoStatusesRef" }, "task": true }, { "name": "postReposOwnerRepoStatusesRef", "summary": "Create a Status.", "description": "Create a Status.", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "ref", "type": "string", "info": "Ref to list the statuses from. It can be a SHA, a branch name, or a tag name.", "required": true, "schema": { "title": "ref", "type": "string" } }, { "name": "body", "type": "object", "info": "", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postReposOwnerRepoStatusesRef" }, "task": true }, { "name": "getReposOwnerRepoSubscribers", "summary": "List watchers.", "description": "List watchers.", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getReposOwnerRepoSubscribers" }, "task": true }, { "name": "deleteReposOwnerRepoSubscription", "summary": "Delete a Repository Subscription.", "description": "Delete a Repository Subscription.", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteReposOwnerRepoSubscription" }, "task": true }, { "name": "getReposOwnerRepoSubscription", "summary": "Get a Repository Subscription.", "description": "Get a Repository Subscription.", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getReposOwnerRepoSubscription" }, "task": true }, { "name": "putReposOwnerRepoSubscription", "summary": "Set a Repository Subscription", "description": "Set a Repository Subscription", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "body", "type": "object", "info": "", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putReposOwnerRepoSubscription" }, "task": true }, { "name": "getReposOwnerRepoTags", "summary": "Get list of tags.", "description": "Get list of tags.", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getReposOwnerRepoTags" }, "task": true }, { "name": "getReposOwnerRepoTeams", "summary": "Get list of teams", "description": "Get list of teams", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getReposOwnerRepoTeams" }, "task": true }, { "name": "getReposOwnerRepoWatchers", "summary": "List Stargazers. New implementation.", "description": "List Stargazers. New implementation.", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getReposOwnerRepoWatchers" }, "task": true }, { "name": "getReposOwnerRepoArchiveFormatPath", "summary": "Get archive link.\nThis method will return a 302 to a URL to download a tarball or zipball\narchive for a repository. Please make sure your HTTP framework is\nconfigured to follow redirects or you will need to use the Location header\nto make a second GET request.\nNote: For private repositories, these links are temporary and expire quickly.", "description": "Get archive link.\nThis method will return a 302 to a URL to download a tarball or zipball\narchive for a repository. Please make sure your HTTP framework is\nconfigured to follow redirects or you will need to use the Location header\nto make a second GET request.\nNote: For private repositories, these links are temporary and expire quickly.", "input": [ { "name": "owner", "type": "string", "info": "Name of repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "archiveFormat", "type": "string", "info": "", "required": true, "schema": { "title": "archiveFormat", "type": "string" } }, { "name": "pathParam", "type": "string", "info": "Valid Git reference, defaults to 'master'.", "required": true, "schema": { "title": "pathParam", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getReposOwnerRepoArchiveFormatPath" }, "task": true }, { "name": "getRepositories", "summary": "List all public repositories.\nThis provides a dump of every public repository, in the order that they\nwere created.\nNote: Pagination is powered exclusively by the since parameter. is the\nLink header to get the URL for the next page of repositories.", "description": "List all public repositories.\nThis provides a dump of every public repository, in the order that they\nwere created.\nNote: Pagination is powered exclusively by the since parameter. is the\nLink header to get the URL for the next page of repositories.", "input": [ { "name": "since", "type": "string", "info": "The time should be passed in as UTC in the ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.\nExample: \"2012-10-09T23:39:01Z\".", "required": false, "schema": { "title": "since", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getRepositories" }, "task": true }, { "name": "getSearchCode", "summary": "Search code.", "description": "Search code.", "input": [ { "name": "order", "type": "string", "info": "The sort field. if sort param is provided. Can be either asc or desc.", "required": false, "schema": { "title": "order", "type": "string" } }, { "name": "q", "type": "string", "info": "The search terms. This can be any combination of the supported code\nsearch parameters:\n'Search In' Qualifies which fields are searched. With this qualifier\nyou can restri...(description truncated)", "required": true, "schema": { "title": "q", "type": "string" } }, { "name": "sort", "type": "string", "info": "Can only be 'indexed', which indicates how recently a file has been indexed\nby the GitHub search infrastructure. If not provided, results are sorted\nby best match.", "required": false, "schema": { "title": "sort", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getSearchCode" }, "task": true }, { "name": "getSearchCodeWithOptions", "summary": "Search code.", "description": "Search code.", "input": [ { "name": "queryData", "type": "object", "info": "Contains properties: order, q, sort, per_page, and page", "required": true, "schema": { "title": "queryData", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getSearchCode" }, "task": true }, { "name": "getSearchIssues", "summary": "Find issues by state and keyword. (This method returns up to 100 results per page.)", "description": "Find issues by state and keyword. (This method returns up to 100 results per page.)", "input": [ { "name": "order", "type": "string", "info": "The sort field. if sort param is provided. Can be either asc or desc.", "required": false, "schema": { "title": "order", "type": "string" } }, { "name": "q", "type": "string", "info": "The q search term can also contain any combination of the supported issue search qualifiers:", "required": true, "schema": { "title": "q", "type": "string" } }, { "name": "sort", "type": "string", "info": "The sort field. Can be comments, created, or updated. Default: results are sorted by best match.", "required": false, "schema": { "title": "sort", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getSearchIssues" }, "task": true }, { "name": "getSearchIssuesWithOptions", "summary": "Find issues by state and keyword. (This method returns up to 100 results per page.)", "description": "Find issues by state and keyword. (This method returns up to 100 results per page.)", "input": [ { "name": "queryData", "type": "object", "info": "Contains properties: order, q, sort, per_page, and page", "required": true, "schema": { "title": "queryData", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getSearchIssues" }, "task": true }, { "name": "getSearchRepositories", "summary": "Search repositories.", "description": "Search repositories.", "input": [ { "name": "order", "type": "string", "info": "The sort field. if sort param is provided. Can be either asc or desc.", "required": false, "schema": { "title": "order", "type": "string" } }, { "name": "q", "type": "string", "info": "The search terms. This can be any combination of the supported repository\nsearch parameters:\n'Search In' Qualifies which fields are searched. With this qualifier you\ncan ...(description truncated)", "required": true, "schema": { "title": "q", "type": "string" } }, { "name": "sort", "type": "string", "info": "If not provided, results are sorted by best match.", "required": false, "schema": { "title": "sort", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getSearchRepositories" }, "task": true }, { "name": "getSearchUsers", "summary": "Search users.", "description": "Search users.", "input": [ { "name": "order", "type": "string", "info": "The sort field. if sort param is provided. Can be either asc or desc.", "required": false, "schema": { "title": "order", "type": "string" } }, { "name": "q", "type": "string", "info": "The search terms. This can be any combination of the supported user\nsearch parameters:\n'Search In' Qualifies which fields are searched. With this qualifier you\ncan restri...(description truncated)", "required": true, "schema": { "title": "q", "type": "string" } }, { "name": "sort", "type": "string", "info": "If not provided, results are sorted by best match.", "required": false, "schema": { "title": "sort", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getSearchUsers" }, "task": true }, { "name": "deleteTeamsTeamId", "summary": "Delete team.\nIn order to delete a team, the authenticated user must be an owner of the\norg that the team is associated with.", "description": "Delete team.\nIn order to delete a team, the authenticated user must be an owner of the\norg that the team is associated with.", "input": [ { "name": "teamId", "type": "number", "info": "Id of team.", "required": true, "schema": { "title": "teamId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteTeamsTeamId" }, "task": true }, { "name": "getTeamsTeamId", "summary": "Get team.", "description": "Get team.", "input": [ { "name": "teamId", "type": "number", "info": "Id of team.", "required": true, "schema": { "title": "teamId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getTeamsTeamId" }, "task": true }, { "name": "patchTeamsTeamId", "summary": "Edit team.\nIn order to edit a team, the authenticated user must be an owner of the org\nthat the team is associated with.", "description": "Edit team.\nIn order to edit a team, the authenticated user must be an owner of the org\nthat the team is associated with.", "input": [ { "name": "teamId", "type": "number", "info": "Id of team.", "required": true, "schema": { "title": "teamId", "type": "number" } }, { "name": "body", "type": "object", "info": "", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchTeamsTeamId" }, "task": true }, { "name": "getTeamsTeamIdMembers", "summary": "List team members.\nIn order to list members in a team, the authenticated user must be a member\nof the team.", "description": "List team members.\nIn order to list members in a team, the authenticated user must be a member\nof the team.", "input": [ { "name": "teamId", "type": "number", "info": "Id of team.", "required": true, "schema": { "title": "teamId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getTeamsTeamIdMembers" }, "task": true }, { "name": "deleteTeamsTeamIdMembersUsername", "summary": "The \"Remove team member\" API is deprecated and is scheduled for removal in the next major version of the API. We recommend using the Remove team membership API instead. It allows you to remove both active and pending memberships.\n\nRemove team member.\nIn order to remove a user from a team, the authenticated user must have 'admin'\npermissions to the team or be an owner of the org that the team is associated\nwith.\nNOTE This does not delete the user, it just remove them from the team.", "description": "The \"Remove team member\" API is deprecated and is scheduled for removal in the next major version of the API. We recommend using the Remove team membership API instead. It allows you to remove both active and pending memberships.\n\nRemove team member.\nIn order to remove a user from a team, the authenticated user must have 'admin'\npermissions to the team or be an owner of the org that the team is associated\nwith.\nNOTE This does not delete the user, it just remove them from the team.", "input": [ { "name": "teamId", "type": "number", "info": "Id of team.", "required": true, "schema": { "title": "teamId", "type": "number" } }, { "name": "username", "type": "string", "info": "Name of a member.", "required": true, "schema": { "title": "username", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteTeamsTeamIdMembersUsername" }, "task": true }, { "name": "getTeamsTeamIdMembersUsername", "summary": "The \"Get team member\" API is deprecated and is scheduled for removal in the next major version of the API. We recommend using the Get team membership API instead. It allows you to get both active and pending memberships.\n\nGet team member.\nIn order to get if a user is a member of a team, the authenticated user mus\nbe a member of the team.", "description": "The \"Get team member\" API is deprecated and is scheduled for removal in the next major version of the API. We recommend using the Get team membership API instead. It allows you to get both active and pending memberships.\n\nGet team member.\nIn order to get if a user is a member of a team, the authenticated user mus\nbe a member of the team.", "input": [ { "name": "teamId", "type": "number", "info": "Id of team.", "required": true, "schema": { "title": "teamId", "type": "number" } }, { "name": "username", "type": "string", "info": "Name of a member.", "required": true, "schema": { "title": "username", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getTeamsTeamIdMembersUsername" }, "task": true }, { "name": "putTeamsTeamIdMembersUsername", "summary": "The API (described below) is deprecated and is scheduled for removal in the next major version of the API. We recommend using the Add team membership API instead. It allows you to invite new organization members to your teams.\n\nAdd team member.\nIn order to add a user to a team, the authenticated user must have 'admin'\npermissions to the team or be an owner of the org that the team is associated\nwith.", "description": "The API (described below) is deprecated and is scheduled for removal in the next major version of the API. We recommend using the Add team membership API instead. It allows you to invite new organization members to your teams.\n\nAdd team member.\nIn order to add a user to a team, the authenticated user must have 'admin'\npermissions to the team or be an owner of the org that the team is associated\nwith.", "input": [ { "name": "teamId", "type": "number", "info": "Id of team.", "required": true, "schema": { "title": "teamId", "type": "number" } }, { "name": "username", "type": "string", "info": "Name of a member.", "required": true, "schema": { "title": "username", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putTeamsTeamIdMembersUsername" }, "task": true }, { "name": "deleteTeamsTeamIdMembershipsUsername", "summary": "Remove team membership.\nIn order to remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. NOTE: This does not delete the user, it just removes their membership from the team.", "description": "Remove team membership.\nIn order to remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. NOTE: This does not delete the user, it just removes their membership from the team.", "input": [ { "name": "teamId", "type": "number", "info": "Id of team.", "required": true, "schema": { "title": "teamId", "type": "number" } }, { "name": "username", "type": "string", "info": "Name of a member.", "required": true, "schema": { "title": "username", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteTeamsTeamIdMembershipsUsername" }, "task": true }, { "name": "getTeamsTeamIdMembershipsUsername", "summary": "Get team membership.\nIn order to get a user's membership with a team, the authenticated user must be a member of the team or an owner of the team's organization.", "description": "Get team membership.\nIn order to get a user's membership with a team, the authenticated user must be a member of the team or an owner of the team's organization.", "input": [ { "name": "teamId", "type": "number", "info": "Id of team.", "required": true, "schema": { "title": "teamId", "type": "number" } }, { "name": "username", "type": "string", "info": "Name of a member.", "required": true, "schema": { "title": "username", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getTeamsTeamIdMembershipsUsername" }, "task": true }, { "name": "putTeamsTeamIdMembershipsUsername", "summary": "Add team membership.\nIn order to add a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with.\n\nIf the user is already a part of the team's organization (meaning they're on at least one other team in the organization), this endpoint will add the user to the team.\n\nIf the user is completely unaffiliated with the team's organization (meaning they're on none of the organization's team...(description truncated)", "description": "Add team membership.\nIn order to add a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with.\n\nIf the user is already a part of the team's organization (meaning they're on at least one other team in the organization), this endpoint will add the user to the team.\n\nIf the user is completely unaffiliated with the team's organization (meaning they're on none of the organization's team...(description truncated)", "input": [ { "name": "teamId", "type": "number", "info": "Id of team.", "required": true, "schema": { "title": "teamId", "type": "number" } }, { "name": "username", "type": "string", "info": "Name of a member.", "required": true, "schema": { "title": "username", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putTeamsTeamIdMembershipsUsername" }, "task": true }, { "name": "getTeamsTeamIdRepos", "summary": "List team repos", "description": "List team repos", "input": [ { "name": "teamId", "type": "number", "info": "Id of team.", "required": true, "schema": { "title": "teamId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getTeamsTeamIdRepos" }, "task": true }, { "name": "deleteTeamsTeamIdReposOwnerRepo", "summary": "In order to remove a repository from a team, the authenticated user must be an owner of the org that the team is associated with. NOTE: This does not delete the repository, it just removes it from the team.", "description": "In order to remove a repository from a team, the authenticated user must be an owner of the org that the team is associated with. NOTE: This does not delete the repository, it just removes it from the team.", "input": [ { "name": "teamId", "type": "number", "info": "Id of team.", "required": true, "schema": { "title": "teamId", "type": "number" } }, { "name": "owner", "type": "string", "info": "Name of a repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of a repository.", "required": true, "schema": { "title": "repo", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteTeamsTeamIdReposOwnerRepo" }, "task": true }, { "name": "getTeamsTeamIdReposOwnerRepo", "summary": "Check if a team manages a repository", "description": "Check if a team manages a repository", "input": [ { "name": "teamId", "type": "number", "info": "Id of team.", "required": true, "schema": { "title": "teamId", "type": "number" } }, { "name": "owner", "type": "string", "info": "Name of a repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of a repository.", "required": true, "schema": { "title": "repo", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getTeamsTeamIdReposOwnerRepo" }, "task": true }, { "name": "putTeamsTeamIdReposOwnerRepo", "summary": "In order to add a repository to a team, the authenticated user must be an owner of the org that the team is associated with. Also, the repository must be owned by the organization, or a direct fork of a repository owned by the organization.", "description": "In order to add a repository to a team, the authenticated user must be an owner of the org that the team is associated with. Also, the repository must be owned by the organization, or a direct fork of a repository owned by the organization.", "input": [ { "name": "teamId", "type": "number", "info": "Id of team.", "required": true, "schema": { "title": "teamId", "type": "number" } }, { "name": "owner", "type": "string", "info": "Name of a organization.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of a repository.", "required": true, "schema": { "title": "repo", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putTeamsTeamIdReposOwnerRepo" }, "task": true }, { "name": "getUser", "summary": "Get the authenticated user.", "description": "Get the authenticated user.", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/getUser" }, "task": true }, { "name": "patchUser", "summary": "Update the authenticated user.", "description": "Update the authenticated user.", "input": [ { "name": "body", "type": "object", "info": "", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchUser" }, "task": true }, { "name": "deleteUserEmails", "summary": "Delete email address(es).\nYou can include a single email address or an array of addresses.", "description": "Delete email address(es).\nYou can include a single email address or an array of addresses.", "input": [ { "name": "body", "type": "array", "info": "", "required": true, "schema": { "title": "body", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteUserEmails" }, "task": true }, { "name": "getUserEmails", "summary": "List email addresses for a user.\nIn the final version of the API, this method will return an array of hashes\nwith extended information for each email address indicating if the address\nhas been verified and if it's primary email address for GitHub.\nUntil API v3 is finalized, use the application/vnd.github.v3 media type to\nget other response format.", "description": "List email addresses for a user.\nIn the final version of the API, this method will return an array of hashes\nwith extended information for each email address indicating if the address\nhas been verified and if it's primary email address for GitHub.\nUntil API v3 is finalized, use the application/vnd.github.v3 media type to\nget other response format.", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/getUserEmails" }, "task": true }, { "name": "postUserEmails", "summary": "Add email address(es).\nYou can post a single email address or an array of addresses.", "description": "Add email address(es).\nYou can post a single email address or an array of addresses.", "input": [ { "name": "body", "type": "array", "info": "", "required": true, "schema": { "title": "body", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postUserEmails" }, "task": true }, { "name": "getUserFollowers", "summary": "List the authenticated user's followers", "description": "List the authenticated user's followers", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/getUserFollowers" }, "task": true }, { "name": "getUserFollowing", "summary": "List who the authenticated user is following.", "description": "List who the authenticated user is following.", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/getUserFollowing" }, "task": true }, { "name": "deleteUserFollowingUsername", "summary": "Unfollow a user.\nUnfollowing a user requires the user to be logged in and authenticated with\nbasic auth or OAuth with the user:follow scope.", "description": "Unfollow a user.\nUnfollowing a user requires the user to be logged in and authenticated with\nbasic auth or OAuth with the user:follow scope.", "input": [ { "name": "username", "type": "string", "info": "Name of user.", "required": true, "schema": { "title": "username", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteUserFollowingUsername" }, "task": true }, { "name": "getUserFollowingUsername", "summary": "Check if you are following a user.", "description": "Check if you are following a user.", "input": [ { "name": "username", "type": "string", "info": "Name of user.", "required": true, "schema": { "title": "username", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getUserFollowingUsername" }, "task": true }, { "name": "putUserFollowingUsername", "summary": "Follow a user.\nFollowing a user requires the user to be logged in and authenticated with\nbasic auth or OAuth with the user:follow scope.", "description": "Follow a user.\nFollowing a user requires the user to be logged in and authenticated with\nbasic auth or OAuth with the user:follow scope.", "input": [ { "name": "username", "type": "string", "info": "Name of user.", "required": true, "schema": { "title": "username", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putUserFollowingUsername" }, "task": true }, { "name": "getUserIssues", "summary": "List issues.\nList all issues across owned and member repositories for the authenticated\nuser.", "description": "List issues.\nList all issues across owned and member repositories for the authenticated\nuser.", "input": [ { "name": "filter", "type": "string", "info": "Issues assigned to you / created by you / mentioning you / you're\nsubscribed to updates for / All issues the authenticated user can see", "required": true, "schema": { "title": "filter", "type": "string" } }, { "name": "state", "type": "string", "info": "", "required": true, "schema": { "title": "state", "type": "string" } }, { "name": "labels", "type": "string", "info": "String list of comma separated Label names. Example - bug,ui,@high.", "required": true, "schema": { "title": "labels", "type": "string" } }, { "name": "sort", "type": "string", "info": "", "required": true, "schema": { "title": "sort", "type": "string" } }, { "name": "direction", "type": "string", "info": "", "required": true, "schema": { "title": "direction", "type": "string" } }, { "name": "since", "type": "string", "info": "Optional string of a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.\nOnly issues updated at or after this time are returned.", "required": false, "schema": { "title": "since", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getUserIssues" }, "task": true }, { "name": "getUserKeys", "summary": "List your public keys.\nLists the current user's keys. Management of public keys via the API requires\nthat you are authenticated through basic auth, or OAuth with the 'user', 'write:public_key' scopes.", "description": "List your public keys.\nLists the current user's keys. Management of public keys via the API requires\nthat you are authenticated through basic auth, or OAuth with the 'user', 'write:public_key' scopes.", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/getUserKeys" }, "task": true }, { "name": "postUserKeys", "summary": "Create a public key.", "description": "Create a public key.", "input": [ { "name": "body", "type": "object", "info": "", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postUserKeys" }, "task": true }, { "name": "deleteUserKeysKeyId", "summary": "Delete a public key. Removes a public key. Requires that you are authenticated via Basic Auth or via OAuth with at least admin:public_key scope.", "description": "Delete a public key. Removes a public key. Requires that you are authenticated via Basic Auth or via OAuth with at least admin:public_key scope.", "input": [ { "name": "keyId", "type": "number", "info": "ID of key.", "required": true, "schema": { "title": "keyId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteUserKeysKeyId" }, "task": true }, { "name": "getUserKeysKeyId", "summary": "Get a single public key.", "description": "Get a single public key.", "input": [ { "name": "keyId", "type": "number", "info": "ID of key.", "required": true, "schema": { "title": "keyId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getUserKeysKeyId" }, "task": true }, { "name": "getUserOrgs", "summary": "List public and private organizations for the authenticated user.", "description": "List public and private organizations for the authenticated user.", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/getUserOrgs" }, "task": true }, { "name": "getUserRepos", "summary": "List repositories for the authenticated user. Note that this does not include\nrepositories owned by organizations which the user can access. You can lis\nuser organizations and list organization repositories separately.", "description": "List repositories for the authenticated user. Note that this does not include\nrepositories owned by organizations which the user can access. You can lis\nuser organizations and list organization repositories separately.", "input": [ { "name": "type", "type": "string", "info": "", "required": false, "schema": { "title": "type", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getUserRepos" }, "task": true }, { "name": "postUserRepos", "summary": "Create a new repository for the authenticated user. OAuth users must supply\nrepo scope.", "description": "Create a new repository for the authenticated user. OAuth users must supply\nrepo scope.", "input": [ { "name": "body", "type": "object", "info": "", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postUserRepos" }, "task": true }, { "name": "getUserStarred", "summary": "List repositories being starred by the authenticated user.", "description": "List repositories being starred by the authenticated user.", "input": [ { "name": "direction", "type": "string", "info": "Ignored without 'sort' parameter.", "required": false, "schema": { "title": "direction", "type": "string" } }, { "name": "sort", "type": "string", "info": "", "required": false, "schema": { "title": "sort", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getUserStarred" }, "task": true }, { "name": "deleteUserStarredOwnerRepo", "summary": "Unstar a repository", "description": "Unstar a repository", "input": [ { "name": "owner", "type": "string", "info": "Name of a repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of a repository.", "required": true, "schema": { "title": "repo", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteUserStarredOwnerRepo" }, "task": true }, { "name": "getUserStarredOwnerRepo", "summary": "Check if you are starring a repository.", "description": "Check if you are starring a repository.", "input": [ { "name": "owner", "type": "string", "info": "Name of a repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of a repository.", "required": true, "schema": { "title": "repo", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getUserStarredOwnerRepo" }, "task": true }, { "name": "putUserStarredOwnerRepo", "summary": "Star a repository.", "description": "Star a repository.", "input": [ { "name": "owner", "type": "string", "info": "Name of a repository owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of a repository.", "required": true, "schema": { "title": "repo", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putUserStarredOwnerRepo" }, "task": true }, { "name": "getUserSubscriptions", "summary": "List repositories being watched by the authenticated user.", "description": "List repositories being watched by the authenticated user.", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/getUserSubscriptions" }, "task": true }, { "name": "deleteUserSubscriptionsOwnerRepo", "summary": "Stop watching a repository", "description": "Stop watching a repository", "input": [ { "name": "owner", "type": "string", "info": "Name of the owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteUserSubscriptionsOwnerRepo" }, "task": true }, { "name": "getUserSubscriptionsOwnerRepo", "summary": "Check if you are watching a repository.", "description": "Check if you are watching a repository.", "input": [ { "name": "owner", "type": "string", "info": "Name of the owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getUserSubscriptionsOwnerRepo" }, "task": true }, { "name": "putUserSubscriptionsOwnerRepo", "summary": "Watch a repository.", "description": "Watch a repository.", "input": [ { "name": "owner", "type": "string", "info": "Name of the owner.", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "Name of repository.", "required": true, "schema": { "title": "repo", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putUserSubscriptionsOwnerRepo" }, "task": true }, { "name": "getUserTeams", "summary": "List all of the teams across all of the organizations to which the authenticated user belongs. This method requires user or repo scope when authenticating via OAuth.", "description": "List all of the teams across all of the organizations to which the authenticated user belongs. This method requires user or repo scope when authenticating via OAuth.", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/getUserTeams" }, "task": true }, { "name": "getUsers", "summary": "Get all users.\nThis provides a dump of every user, in the order that they signed up for GitHub.\nNote: Pagination is powered exclusively by the since parameter. Use the Link\nheader to get the URL for the next page of users.", "description": "Get all users.\nThis provides a dump of every user, in the order that they signed up for GitHub.\nNote: Pagination is powered exclusively by the since parameter. Use the Link\nheader to get the URL for the next page of users.", "input": [ { "name": "since", "type": "number", "info": "The integer ID of the last user that you've seen.", "required": false, "schema": { "title": "since", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getUsers" }, "task": true }, { "name": "getUsersUsername", "summary": "Get a single user.", "description": "Get a single user.", "input": [ { "name": "username", "type": "string", "info": "Name of user.", "required": true, "schema": { "title": "username", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getUsersUsername" }, "task": true }, { "name": "getUsersUsernameEvents", "summary": "If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events.", "description": "If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events.", "input": [ { "name": "username", "type": "string", "info": "Name of user.", "required": true, "schema": { "title": "username", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getUsersUsernameEvents" }, "task": true }, { "name": "getUsersUsernameEventsOrgsOrg", "summary": "This is the user's organization dashboard. You must be authenticated as the user to view this.", "description": "This is the user's organization dashboard. You must be authenticated as the user to view this.", "input": [ { "name": "username", "type": "string", "info": "Name of user.", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "org", "type": "string", "info": "", "required": true, "schema": { "title": "org", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getUsersUsernameEventsOrgsOrg" }, "task": true }, { "name": "getUsersUsernameFollowers", "summary": "List a user's followers", "description": "List a user's followers", "input": [ { "name": "username", "type": "string", "info": "Name of user.", "required": true, "schema": { "title": "username", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getUsersUsernameFollowers" }, "task": true }, { "name": "getUsersUsernameFollowingTargetUser", "summary": "Check if one user follows another.", "description": "Check if one user follows another.", "input": [ { "name": "username", "type": "string", "info": "Name of user.", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "targetUser", "type": "string", "info": "Name of user.", "required": true, "schema": { "title": "targetUser", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getUsersUsernameFollowingTargetUser" }, "task": true }, { "name": "getUsersUsernameGists", "summary": "List a users gists.", "description": "List a users gists.", "input": [ { "name": "username", "type": "string", "info": "Name of user.", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "since", "type": "string", "info": "The time should be passed in as UTC in the ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.\nExample: \"2012-10-09T23:39:01Z\".", "required": false, "schema": { "title": "since", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getUsersUsernameGists" }, "task": true }, { "name": "getUsersUsernameKeys", "summary": "List public keys for a user.\nLists the verified public keys for a user. This is accessible by anyone.", "description": "List public keys for a user.\nLists the verified public keys for a user. This is accessible by anyone.", "input": [ { "name": "username", "type": "string", "info": "Name of user.", "required": true, "schema": { "title": "username", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getUsersUsernameKeys" }, "task": true }, { "name": "getUsersUsernameOrgs", "summary": "List all public organizations for a user.", "description": "List all public organizations for a user.", "input": [ { "name": "username", "type": "string", "info": "Name of user.", "required": true, "schema": { "title": "username", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getUsersUsernameOrgs" }, "task": true }, { "name": "getUsersUsernameReceivedEvents", "summary": "These are events that you'll only see public events.", "description": "These are events that you'll only see public events.", "input": [ { "name": "username", "type": "string", "info": "Name of user.", "required": true, "schema": { "title": "username", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getUsersUsernameReceivedEvents" }, "task": true }, { "name": "getUsersUsernameReceivedEventsPublic", "summary": "List public events that a user has received", "description": "List public events that a user has received", "input": [ { "name": "username", "type": "string", "info": "Name of user.", "required": true, "schema": { "title": "username", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getUsersUsernameReceivedEventsPublic" }, "task": true }, { "name": "getUsersUsernameRepos", "summary": "List public repositories for the specified user.", "description": "List public repositories for the specified user.", "input": [ { "name": "username", "type": "string", "info": "Name of user.", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "type", "type": "string", "info": "", "required": false, "schema": { "title": "type", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getUsersUsernameRepos" }, "task": true }, { "name": "getUsersUsernameStarred", "summary": "List repositories being starred by a user.", "description": "List repositories being starred by a user.", "input": [ { "name": "username", "type": "string", "info": "Name of user.", "required": true, "schema": { "title": "username", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getUsersUsernameStarred" }, "task": true }, { "name": "getUsersUsernameSubscriptions", "summary": "List repositories being watched by a user.", "description": "List repositories being watched by a user.", "input": [ { "name": "username", "type": "string", "info": "Name of user.", "required": true, "schema": { "title": "username", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getUsersUsernameSubscriptions" }, "task": true }, { "name": "actionsGetActionsCacheUsageForOrg", "summary": "actions/get-actions-cache-usage-for-org", "description": "Gets the total GitHub Actions cache usage for an organization.\nThe data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.\n\nOAuth tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsGetActionsCacheUsageForOrg" }, "task": true }, { "name": "actionsGetActionsCacheUsageByRepoForOrg", "summary": "actions/get-actions-cache-usage-by-repo-for-org", "description": "Lists repositories and their GitHub Actions cache usage for an organization.\nThe data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.\n\nOAuth tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsGetActionsCacheUsageByRepoForOrg" }, "task": true }, { "name": "actionsGetGithubActionsPermissionsOrganization", "summary": "actions/get-github-actions-permissions-organization", "description": "Gets the GitHub Actions permissions policy for repositories and allowed actions and reusable workflows in an organization.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsGetGithubActionsPermissionsOrganization" }, "task": true }, { "name": "actionsSetGithubActionsPermissionsOrganization", "summary": "actions/set-github-actions-permissions-organization", "description": "Sets the GitHub Actions permissions policy for repositories and allowed actions and reusable workflows in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsSetGithubActionsPermissionsOrganization" }, "task": true }, { "name": "actionsListSelectedRepositoriesEnabledGithubActionsOrganization", "summary": "actions/list-selected-repositories-enabled-github-actions-organization", "description": "Lists the selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsListSelectedRepositoriesEnabledGithubActionsOrganization" }, "task": true }, { "name": "actionsSetSelectedRepositoriesEnabledGithubActionsOrganization", "summary": "actions/set-selected-repositories-enabled-github-actions-organization", "description": "Replaces the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsSetSelectedRepositoriesEnabledGithubActionsOrganization" }, "task": true }, { "name": "actionsEnableSelectedRepositoryGithubActionsOrganization", "summary": "actions/enable-selected-repository-github-actions-organization", "description": "Adds a repository to the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "repositoryId", "type": "number", "info": "The unique identifier of the repository.: 123", "required": true, "schema": { "title": "repositoryId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsEnableSelectedRepositoryGithubActionsOrganization" }, "task": true }, { "name": "actionsDisableSelectedRepositoryGithubActionsOrganization", "summary": "actions/disable-selected-repository-github-actions-organization", "description": "Removes a repository from the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "repositoryId", "type": "number", "info": "The unique identifier of the repository.: 123", "required": true, "schema": { "title": "repositoryId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsDisableSelectedRepositoryGithubActionsOrganization" }, "task": true }, { "name": "actionsGetAllowedActionsOrganization", "summary": "actions/get-allowed-actions-organization", "description": "Gets the selected actions and reusable workflows that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsGetAllowedActionsOrganization" }, "task": true }, { "name": "actionsSetAllowedActionsOrganization", "summary": "actions/set-allowed-actions-organization", "description": "Sets the actions and reusable workflows that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsSetAllowedActionsOrganization" }, "task": true }, { "name": "actionsGetGithubActionsDefaultWorkflowPermissionsOrganization", "summary": "actions/get-github-actions-default-workflow-permissions-organization", "description": "Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization,\nas well as whether GitHub Actions can submit approving pull request reviews. For more information, see\n\"[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization).\"\n\nOAuth tokens and pe...(description truncated)", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsGetGithubActionsDefaultWorkflowPermissionsOrganization" }, "task": true }, { "name": "actionsSetGithubActionsDefaultWorkflowPermissionsOrganization", "summary": "actions/set-github-actions-default-workflow-permissions-organization", "description": "Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization, and sets if GitHub Actions\ncan submit approving pull request reviews. For more information, see\n\"[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization).\"\n\nOAuth app tokens and perso...(description truncated)", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsSetGithubActionsDefaultWorkflowPermissionsOrganization" }, "task": true }, { "name": "actionsListSelfHostedRunnersForOrg", "summary": "actions/list-self-hosted-runners-for-org", "description": "Lists all self-hosted runners configured in an organization.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", "input": [ { "name": "name", "type": "string", "info": "The name of a self-hosted runner.: string", "required": false, "schema": { "title": "name", "type": "string" } }, { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsListSelfHostedRunnersForOrg" }, "task": true }, { "name": "actionsListRunnerApplicationsForOrg", "summary": "actions/list-runner-applications-for-org", "description": "Lists binaries for the runner application that you can download and run.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsListRunnerApplicationsForOrg" }, "task": true }, { "name": "actionsGenerateRunnerJitconfigForOrg", "summary": "actions/generate-runner-jitconfig-for-org", "description": "Generates a configuration that can be passed to the runner application at startup.\n\nThe authenticated user must have admin access to the organization.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsGenerateRunnerJitconfigForOrg" }, "task": true }, { "name": "actionsCreateRegistrationTokenForOrg", "summary": "actions/create-registration-token-for-org", "description": "Returns a token that you can pass to the `config` script. The token expires after one hour.\n\nFor example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to configure your self-hosted runner:\n\n```\n./config.sh --url https://github.com/octo-org --token TOKEN\n```\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint....(description truncated)", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsCreateRegistrationTokenForOrg" }, "task": true }, { "name": "actionsCreateRemoveTokenForOrg", "summary": "actions/create-remove-token-for-org", "description": "Returns a token that you can pass to the `config` script to remove a self-hosted runner from an organization. The token expires after one hour.\n\nFor example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization:\n\n```\n./config.sh remove --token TOKEN\n```\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth tokens and personal access tokens (classic) need...(description truncated)", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsCreateRemoveTokenForOrg" }, "task": true }, { "name": "actionsGetSelfHostedRunnerForOrg", "summary": "actions/get-self-hosted-runner-for-org", "description": "Gets a specific self-hosted runner configured in an organization.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "runnerId", "type": "number", "info": "Unique identifier of the self-hosted runner.: 123", "required": true, "schema": { "title": "runnerId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsGetSelfHostedRunnerForOrg" }, "task": true }, { "name": "actionsDeleteSelfHostedRunnerFromOrg", "summary": "actions/delete-self-hosted-runner-from-org", "description": "Forces the removal of a self-hosted runner from an organization. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "runnerId", "type": "number", "info": "Unique identifier of the self-hosted runner.: 123", "required": true, "schema": { "title": "runnerId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsDeleteSelfHostedRunnerFromOrg" }, "task": true }, { "name": "actionsListLabelsForSelfHostedRunnerForOrg", "summary": "actions/list-labels-for-self-hosted-runner-for-org", "description": "Lists all labels for a self-hosted runner configured in an organization.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "runnerId", "type": "number", "info": "Unique identifier of the self-hosted runner.: 123", "required": true, "schema": { "title": "runnerId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsListLabelsForSelfHostedRunnerForOrg" }, "task": true }, { "name": "actionsAddCustomLabelsToSelfHostedRunnerForOrg", "summary": "actions/add-custom-labels-to-self-hosted-runner-for-org", "description": "Adds custom labels to a self-hosted runner configured in an organization.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "runnerId", "type": "number", "info": "Unique identifier of the self-hosted runner.: 123", "required": true, "schema": { "title": "runnerId", "type": "number" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsAddCustomLabelsToSelfHostedRunnerForOrg" }, "task": true }, { "name": "actionsSetCustomLabelsForSelfHostedRunnerForOrg", "summary": "actions/set-custom-labels-for-self-hosted-runner-for-org", "description": "Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in an organization.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "runnerId", "type": "number", "info": "Unique identifier of the self-hosted runner.: 123", "required": true, "schema": { "title": "runnerId", "type": "number" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsSetCustomLabelsForSelfHostedRunnerForOrg" }, "task": true }, { "name": "actionsRemoveAllCustomLabelsFromSelfHostedRunnerForOrg", "summary": "actions/remove-all-custom-labels-from-self-hosted-runner-for-org", "description": "Remove all custom labels from a self-hosted runner configured in an\norganization. Returns the remaining read-only labels from the runner.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "runnerId", "type": "number", "info": "Unique identifier of the self-hosted runner.: 123", "required": true, "schema": { "title": "runnerId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsRemoveAllCustomLabelsFromSelfHostedRunnerForOrg" }, "task": true }, { "name": "actionsRemoveCustomLabelFromSelfHostedRunnerForOrg", "summary": "actions/remove-custom-label-from-self-hosted-runner-for-org", "description": "Remove a custom label from a self-hosted runner configured\nin an organization. Returns the remaining labels from the runner.\n\nThis endpoint returns a `404 Not Found` status if the custom label is not\npresent on the runner.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "runnerId", "type": "number", "info": "Unique identifier of the self-hosted runner.: 123", "required": true, "schema": { "title": "runnerId", "type": "number" } }, { "name": "name", "type": "string", "info": "The name of a self-hosted runner's custom label.: string", "required": true, "schema": { "title": "name", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsRemoveCustomLabelFromSelfHostedRunnerForOrg" }, "task": true }, { "name": "actionsListOrgSecrets", "summary": "actions/list-org-secrets", "description": "Lists all secrets available in an organization without revealing their\nencrypted values.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsListOrgSecrets" }, "task": true }, { "name": "actionsGetOrgPublicKey", "summary": "actions/get-org-public-key", "description": "Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.\n\nThe authenticated user must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsGetOrgPublicKey" }, "task": true }, { "name": "actionsGetOrgSecret", "summary": "actions/get-org-secret", "description": "Gets a single organization secret without revealing its encrypted value.\n\nThe authenticated user must have collaborator access to a repository to create, update, or read secrets\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "secretName", "type": "string", "info": "The name of the secret.: string", "required": true, "schema": { "title": "secretName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsGetOrgSecret" }, "task": true }, { "name": "actionsCreateOrUpdateOrgSecret", "summary": "actions/create-or-update-org-secret", "description": "Creates or updates an organization secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this...(description truncated)", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "secretName", "type": "string", "info": "The name of the secret.: string", "required": true, "schema": { "title": "secretName", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsCreateOrUpdateOrgSecret" }, "task": true }, { "name": "actionsDeleteOrgSecret", "summary": "actions/delete-org-secret", "description": "Deletes a secret in an organization using the secret name.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "secretName", "type": "string", "info": "The name of the secret.: string", "required": true, "schema": { "title": "secretName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsDeleteOrgSecret" }, "task": true }, { "name": "actionsListSelectedReposForOrgSecret", "summary": "actions/list-selected-repos-for-org-secret", "description": "Lists all repositories that have been selected when the `visibility`\nfor repository access to a secret is set to `selected`.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "secretName", "type": "string", "info": "The name of the secret.: string", "required": true, "schema": { "title": "secretName", "type": "string" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsListSelectedReposForOrgSecret" }, "task": true }, { "name": "actionsSetSelectedReposForOrgSecret", "summary": "actions/set-selected-repos-for-org-secret", "description": "Replaces all repositories for an organization secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret).\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the reposit...(description truncated)", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "secretName", "type": "string", "info": "The name of the secret.: string", "required": true, "schema": { "title": "secretName", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsSetSelectedReposForOrgSecret" }, "task": true }, { "name": "actionsAddSelectedRepoToOrgSecret", "summary": "actions/add-selected-repo-to-org-secret", "description": "Adds a repository to an organization secret when the `visibility` for\nrepository access is set to `selected`. For more information about setting the visibility, see [Create or\nupdate an organization secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret).\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If ...(description truncated)", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "secretName", "type": "string", "info": "The name of the secret.: string", "required": true, "schema": { "title": "secretName", "type": "string" } }, { "name": "repositoryId", "type": "number", "info": ": 123", "required": true, "schema": { "title": "repositoryId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsAddSelectedRepoToOrgSecret" }, "task": true }, { "name": "actionsRemoveSelectedRepoFromOrgSecret", "summary": "actions/remove-selected-repo-from-org-secret", "description": "Removes a repository from an organization secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret).\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository ...(description truncated)", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "secretName", "type": "string", "info": "The name of the secret.: string", "required": true, "schema": { "title": "secretName", "type": "string" } }, { "name": "repositoryId", "type": "number", "info": ": 123", "required": true, "schema": { "title": "repositoryId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsRemoveSelectedRepoFromOrgSecret" }, "task": true }, { "name": "actionsListOrgVariables", "summary": "actions/list-org-variables", "description": "Lists all organization variables.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 30). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsListOrgVariables" }, "task": true }, { "name": "actionsCreateOrgVariable", "summary": "actions/create-org-variable", "description": "Creates an organization variable that you can reference in a GitHub Actions workflow.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsCreateOrgVariable" }, "task": true }, { "name": "actionsGetOrgVariable", "summary": "actions/get-org-variable", "description": "Gets a specific variable in an organization.\n\nThe authenticated user must have collaborator access to a repository to create, update, or read variables.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "name", "type": "string", "info": "The name of the variable.: string", "required": true, "schema": { "title": "name", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsGetOrgVariable" }, "task": true }, { "name": "actionsUpdateOrgVariable", "summary": "actions/update-org-variable", "description": "Updates an organization variable that you can reference in a GitHub Actions workflow.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "name", "type": "string", "info": "The name of the variable.: string", "required": true, "schema": { "title": "name", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsUpdateOrgVariable" }, "task": true }, { "name": "actionsDeleteOrgVariable", "summary": "actions/delete-org-variable", "description": "Deletes an organization variable using the variable name.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "name", "type": "string", "info": "The name of the variable.: string", "required": true, "schema": { "title": "name", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsDeleteOrgVariable" }, "task": true }, { "name": "actionsListSelectedReposForOrgVariable", "summary": "actions/list-selected-repos-for-org-variable", "description": "Lists all repositories that can access an organization variable\nthat is available to selected repositories.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "name", "type": "string", "info": "The name of the variable.: string", "required": true, "schema": { "title": "name", "type": "string" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsListSelectedReposForOrgVariable" }, "task": true }, { "name": "actionsSetSelectedReposForOrgVariable", "summary": "actions/set-selected-repos-for-org-variable", "description": "Replaces all repositories for an organization variable that is available\nto selected repositories. Organization variables that are available to selected\nrepositories have their `visibility` field set to `selected`.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "name", "type": "string", "info": "The name of the variable.: string", "required": true, "schema": { "title": "name", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsSetSelectedReposForOrgVariable" }, "task": true }, { "name": "actionsAddSelectedRepoToOrgVariable", "summary": "actions/add-selected-repo-to-org-variable", "description": "Adds a repository to an organization variable that is available to selected repositories.\nOrganization variables that are available to selected repositories have their `visibility` field set to `selected`.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `r...(description truncated)", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "name", "type": "string", "info": "The name of the variable.: string", "required": true, "schema": { "title": "name", "type": "string" } }, { "name": "repositoryId", "type": "number", "info": ": 123", "required": true, "schema": { "title": "repositoryId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsAddSelectedRepoToOrgVariable" }, "task": true }, { "name": "actionsRemoveSelectedRepoFromOrgVariable", "summary": "actions/remove-selected-repo-from-org-variable", "description": "Removes a repository from an organization variable that is\navailable to selected repositories. Organization variables that are available to\nselected repositories have their `visibility` field set to `selected`.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "name", "type": "string", "info": "The name of the variable.: string", "required": true, "schema": { "title": "name", "type": "string" } }, { "name": "repositoryId", "type": "number", "info": ": 123", "required": true, "schema": { "title": "repositoryId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsRemoveSelectedRepoFromOrgVariable" }, "task": true }, { "name": "actionsListArtifactsForRepo", "summary": "actions/list-artifacts-for-repo", "description": "Lists all artifacts for a repository.\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "name", "type": "string", "info": "The name field of an artifact. When specified, only artifacts with this name will be returned.: string", "required": false, "schema": { "title": "name", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsListArtifactsForRepo" }, "task": true }, { "name": "actionsGetArtifact", "summary": "actions/get-artifact", "description": "Gets a specific artifact for a workflow run.\n\nAnyone with read access to the repository can use this endpoint.\n\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "artifactId", "type": "number", "info": "The unique identifier of the artifact.: 123", "required": true, "schema": { "title": "artifactId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsGetArtifact" }, "task": true }, { "name": "actionsDeleteArtifact", "summary": "actions/delete-artifact", "description": "Deletes an artifact for a workflow run.\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "artifactId", "type": "number", "info": "The unique identifier of the artifact.: 123", "required": true, "schema": { "title": "artifactId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsDeleteArtifact" }, "task": true }, { "name": "actionsDownloadArtifact", "summary": "actions/download-artifact", "description": "Gets a redirect URL to download an archive for a repository. This URL expires after 1 minute. Look for `Location:` in\nthe response header to find the URL for the download. The `:archive_format` must be `zip`.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "artifactId", "type": "number", "info": "The unique identifier of the artifact.: 123", "required": true, "schema": { "title": "artifactId", "type": "number" } }, { "name": "archiveFormat", "type": "string", "info": ": string", "required": true, "schema": { "title": "archiveFormat", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsDownloadArtifact" }, "task": true }, { "name": "actionsGetActionsCacheUsage", "summary": "actions/get-actions-cache-usage", "description": "Gets GitHub Actions cache usage for a repository.\nThe data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.\n\nAnyone with read access to the repository can use this endpoint.\n\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsGetActionsCacheUsage" }, "task": true }, { "name": "actionsGetActionsCacheList", "summary": "actions/get-actions-cache-list", "description": "Lists the GitHub Actions caches for a repository.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "ref", "type": "string", "info": "The full Git reference for narrowing down the cache. The `ref` for a branch should be formatted as `refs/heads/ `. To reference a pull request use `refs/pull/ /merge`.: string", "required": false, "schema": { "title": "ref", "type": "string" } }, { "name": "key", "type": "string", "info": "An explicit key or prefix for identifying the cache: string", "required": false, "schema": { "title": "key", "type": "string" } }, { "name": "sort", "type": "string", "info": "The property to sort the results by. `created_at` means when the cache was created. `last_accessed_at` means when the cache was last accessed. `size_in_bytes` is the size...(description truncated): ", "required": false, "schema": { "title": "sort", "type": "string" } }, { "name": "direction", "type": "string", "info": "The direction to sort the results by.: ", "required": false, "schema": { "title": "direction", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsGetActionsCacheList" }, "task": true }, { "name": "actionsDeleteActionsCacheByKey", "summary": "actions/delete-actions-cache-by-key", "description": "Deletes one or more GitHub Actions caches for a repository, using a complete cache key. By default, all caches that match the provided key are deleted, but you can optionally provide a Git ref to restrict deletions to caches that match both the provided key and the Git ref.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "key", "type": "string", "info": "A key for identifying the cache.: string", "required": true, "schema": { "title": "key", "type": "string" } }, { "name": "ref", "type": "string", "info": "The full Git reference for narrowing down the cache. The `ref` for a branch should be formatted as `refs/heads/ `. To reference a pull request use `refs/pull/ /merge`.: string", "required": false, "schema": { "title": "ref", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsDeleteActionsCacheByKey" }, "task": true }, { "name": "actionsDeleteActionsCacheById", "summary": "actions/delete-actions-cache-by-id", "description": "Deletes a GitHub Actions cache for a repository, using a cache ID.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "cacheId", "type": "number", "info": "The unique identifier of the GitHub Actions cache.: 123", "required": true, "schema": { "title": "cacheId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsDeleteActionsCacheById" }, "task": true }, { "name": "actionsGetJobForWorkflowRun", "summary": "actions/get-job-for-workflow-run", "description": "Gets a specific job in a workflow run.\n\nAnyone with read access to the repository can use this endpoint.\n\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "jobId", "type": "number", "info": "The unique identifier of the job.: 123", "required": true, "schema": { "title": "jobId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsGetJobForWorkflowRun" }, "task": true }, { "name": "actionsDownloadJobLogsForWorkflowRun", "summary": "actions/download-job-logs-for-workflow-run", "description": "Gets a redirect URL to download a plain text file of logs for a workflow job. This link expires after 1 minute. Look\nfor `Location:` in the response header to find the URL for the download.\n\nAnyone with read access to the repository can use this endpoint.\n\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "jobId", "type": "number", "info": "The unique identifier of the job.: 123", "required": true, "schema": { "title": "jobId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsDownloadJobLogsForWorkflowRun" }, "task": true }, { "name": "actionsReRunJobForWorkflowRun", "summary": "actions/re-run-job-for-workflow-run", "description": "Re-run a job and its dependent jobs in a workflow run.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "jobId", "type": "number", "info": "The unique identifier of the job.: 123", "required": true, "schema": { "title": "jobId", "type": "number" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsReRunJobForWorkflowRun" }, "task": true }, { "name": "actionsGetCustomOidcSubClaimForRepo", "summary": "actions/get-custom-oidc-sub-claim-for-repo", "description": "Gets the customization template for an OpenID Connect (OIDC) subject claim.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsGetCustomOidcSubClaimForRepo" }, "task": true }, { "name": "actionsSetCustomOidcSubClaimForRepo", "summary": "actions/set-custom-oidc-sub-claim-for-repo", "description": "Sets the customization template and `opt-in` or `opt-out` flag for an OpenID Connect (OIDC) subject claim for a repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsSetCustomOidcSubClaimForRepo" }, "task": true }, { "name": "actionsListRepoOrganizationSecrets", "summary": "actions/list-repo-organization-secrets", "description": "Lists all organization secrets shared with a repository without revealing their encrypted\nvalues.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsListRepoOrganizationSecrets" }, "task": true }, { "name": "actionsListRepoOrganizationVariables", "summary": "actions/list-repo-organization-variables", "description": "Lists all organization variables shared with a repository.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 30). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsListRepoOrganizationVariables" }, "task": true }, { "name": "actionsGetGithubActionsPermissionsRepository", "summary": "actions/get-github-actions-permissions-repository", "description": "Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions and reusable workflows allowed to run in the repository.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsGetGithubActionsPermissionsRepository" }, "task": true }, { "name": "actionsSetGithubActionsPermissionsRepository", "summary": "actions/set-github-actions-permissions-repository", "description": "Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions and reusable workflows in the repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsSetGithubActionsPermissionsRepository" }, "task": true }, { "name": "actionsGetWorkflowAccessToRepository", "summary": "actions/get-workflow-access-to-repository", "description": "Gets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to private repositories.\nFor more information, see \"[Allowing access to components in a private repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository).\"\n\nOAuth app ...(description truncated)", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsGetWorkflowAccessToRepository" }, "task": true }, { "name": "actionsSetWorkflowAccessToRepository", "summary": "actions/set-workflow-access-to-repository", "description": "Sets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to private repositories.\nFor more information, see \"[Allowing access to components in a private repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)\".\n\nOAuth app ...(description truncated)", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsSetWorkflowAccessToRepository" }, "task": true }, { "name": "actionsGetAllowedActionsRepository", "summary": "actions/get-allowed-actions-repository", "description": "Gets the settings for selected actions and reusable workflows that are allowed in a repository. To use this endpoint, the repository policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository).\"\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsGetAllowedActionsRepository" }, "task": true }, { "name": "actionsSetAllowedActionsRepository", "summary": "actions/set-allowed-actions-repository", "description": "Sets the actions and reusable workflows that are allowed in a repository. To use this endpoint, the repository permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsSetAllowedActionsRepository" }, "task": true }, { "name": "actionsGetGithubActionsDefaultWorkflowPermissionsRepository", "summary": "actions/get-github-actions-default-workflow-permissions-repository", "description": "Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository,\nas well as if GitHub Actions can submit approving pull request reviews.\nFor more information, see \"[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-r...(description truncated)", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsGetGithubActionsDefaultWorkflowPermissionsRepository" }, "task": true }, { "name": "actionsSetGithubActionsDefaultWorkflowPermissionsRepository", "summary": "actions/set-github-actions-default-workflow-permissions-repository", "description": "Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository, and sets if GitHub Actions\ncan submit approving pull request reviews.\nFor more information, see \"[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-rep...(description truncated)", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsSetGithubActionsDefaultWorkflowPermissionsRepository" }, "task": true }, { "name": "actionsListSelfHostedRunnersForRepo", "summary": "actions/list-self-hosted-runners-for-repo", "description": "Lists all self-hosted runners configured in a repository.\n\nAuthenticated users must have admin access to the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "input": [ { "name": "name", "type": "string", "info": "The name of a self-hosted runner.: string", "required": false, "schema": { "title": "name", "type": "string" } }, { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsListSelfHostedRunnersForRepo" }, "task": true }, { "name": "actionsListRunnerApplicationsForRepo", "summary": "actions/list-runner-applications-for-repo", "description": "Lists binaries for the runner application that you can download and run.\n\nAuthenticated users must have admin access to the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsListRunnerApplicationsForRepo" }, "task": true }, { "name": "actionsGenerateRunnerJitconfigForRepo", "summary": "actions/generate-runner-jitconfig-for-repo", "description": "Generates a configuration that can be passed to the runner application at startup.\n\nThe authenticated user must have admin access to the repository.\n\nOAuth tokens and personal access tokens (classic) need the`repo` scope to use this endpoint.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsGenerateRunnerJitconfigForRepo" }, "task": true }, { "name": "actionsCreateRegistrationTokenForRepo", "summary": "actions/create-registration-token-for-repo", "description": "Returns a token that you can pass to the `config` script. The token expires after one hour.\n\nFor example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to configure your self-hosted runner:\n\n```\n./config.sh --url https://github.com/octo-org --token TOKEN\n```\n\nAuthenticated users must have admin access to the repository to use this endpoint.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsCreateRegistrationTokenForRepo" }, "task": true }, { "name": "actionsCreateRemoveTokenForRepo", "summary": "actions/create-remove-token-for-repo", "description": "Returns a token that you can pass to the `config` script to remove a self-hosted runner from an repository. The token expires after one hour.\n\nFor example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization:\n\n```\n./config.sh remove --token TOKEN\n```\n\nAuthenticated users must have admin access to the repository to use this endpoint.\n\nOAuth tokens and personal access tokens (classic) need the...(description truncated)", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsCreateRemoveTokenForRepo" }, "task": true }, { "name": "actionsGetSelfHostedRunnerForRepo", "summary": "actions/get-self-hosted-runner-for-repo", "description": "Gets a specific self-hosted runner configured in a repository.\n\nAuthenticated users must have admin access to the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "runnerId", "type": "number", "info": "Unique identifier of the self-hosted runner.: 123", "required": true, "schema": { "title": "runnerId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsGetSelfHostedRunnerForRepo" }, "task": true }, { "name": "actionsDeleteSelfHostedRunnerFromRepo", "summary": "actions/delete-self-hosted-runner-from-repo", "description": "Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\n\nAuthenticated users must have admin access to the repository to use this endpoint.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "runnerId", "type": "number", "info": "Unique identifier of the self-hosted runner.: 123", "required": true, "schema": { "title": "runnerId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsDeleteSelfHostedRunnerFromRepo" }, "task": true }, { "name": "actionsListLabelsForSelfHostedRunnerForRepo", "summary": "actions/list-labels-for-self-hosted-runner-for-repo", "description": "Lists all labels for a self-hosted runner configured in a repository.\n\nAuthenticated users must have admin access to the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "runnerId", "type": "number", "info": "Unique identifier of the self-hosted runner.: 123", "required": true, "schema": { "title": "runnerId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsListLabelsForSelfHostedRunnerForRepo" }, "task": true }, { "name": "actionsAddCustomLabelsToSelfHostedRunnerForRepo", "summary": "actions/add-custom-labels-to-self-hosted-runner-for-repo", "description": "Adds custom labels to a self-hosted runner configured in a repository.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "runnerId", "type": "number", "info": "Unique identifier of the self-hosted runner.: 123", "required": true, "schema": { "title": "runnerId", "type": "number" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsAddCustomLabelsToSelfHostedRunnerForRepo" }, "task": true }, { "name": "actionsSetCustomLabelsForSelfHostedRunnerForRepo", "summary": "actions/set-custom-labels-for-self-hosted-runner-for-repo", "description": "Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in a repository.\n\nAuthenticated users must have admin access to the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "runnerId", "type": "number", "info": "Unique identifier of the self-hosted runner.: 123", "required": true, "schema": { "title": "runnerId", "type": "number" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsSetCustomLabelsForSelfHostedRunnerForRepo" }, "task": true }, { "name": "actionsRemoveAllCustomLabelsFromSelfHostedRunnerForRepo", "summary": "actions/remove-all-custom-labels-from-self-hosted-runner-for-repo", "description": "Remove all custom labels from a self-hosted runner configured in a\nrepository. Returns the remaining read-only labels from the runner.\n\nAuthenticated users must have admin access to the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "runnerId", "type": "number", "info": "Unique identifier of the self-hosted runner.: 123", "required": true, "schema": { "title": "runnerId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsRemoveAllCustomLabelsFromSelfHostedRunnerForRepo" }, "task": true }, { "name": "actionsRemoveCustomLabelFromSelfHostedRunnerForRepo", "summary": "actions/remove-custom-label-from-self-hosted-runner-for-repo", "description": "Remove a custom label from a self-hosted runner configured\nin a repository. Returns the remaining labels from the runner.\n\nThis endpoint returns a `404 Not Found` status if the custom label is not\npresent on the runner.\n\nAuthenticated users must have admin access to the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "runnerId", "type": "number", "info": "Unique identifier of the self-hosted runner.: 123", "required": true, "schema": { "title": "runnerId", "type": "number" } }, { "name": "name", "type": "string", "info": "The name of a self-hosted runner's custom label.: string", "required": true, "schema": { "title": "name", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsRemoveCustomLabelFromSelfHostedRunnerForRepo" }, "task": true }, { "name": "actionsListWorkflowRunsForRepo", "summary": "actions/list-workflow-runs-for-repo", "description": "Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters).\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.\n\nThis API will return up to 1,000 results for each search when using...(description truncated)", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "actor", "type": "string", "info": "Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run.: string", "required": false, "schema": { "title": "actor", "type": "string" } }, { "name": "branch", "type": "string", "info": "Returns workflow runs associated with a branch. Use the name of the branch of the `push`.: string", "required": false, "schema": { "title": "branch", "type": "string" } }, { "name": "event", "type": "string", "info": "Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see \"[Events that trigger workflows](https:...(description truncated): string", "required": false, "schema": { "title": "event", "type": "string" } }, { "name": "status", "type": "string", "info": "Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitH...(description truncated): ", "required": false, "schema": { "title": "status", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "created", "type": "string", "info": "Returns workflow runs created within the given date-time range. For more information on the syntax, see \"[Understanding the search syntax](https://docs.github.com/search-...(description truncated): string", "required": false, "schema": { "title": "created", "type": "string" } }, { "name": "excludePullRequests", "type": "boolean", "info": "If `true` pull requests are omitted from the response (empty array).: boolean", "required": false, "schema": { "title": "excludePullRequests", "type": "boolean" } }, { "name": "checkSuiteId", "type": "number", "info": "Returns workflow runs with the `check_suite_id` that you specify.: 123", "required": false, "schema": { "title": "checkSuiteId", "type": "number" } }, { "name": "headSha", "type": "string", "info": "Only returns workflow runs that are associated with the specified `head_sha`.: string", "required": false, "schema": { "title": "headSha", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsListWorkflowRunsForRepo" }, "task": true }, { "name": "actionsGetWorkflowRun", "summary": "actions/get-workflow-run", "description": "Gets a specific workflow run.\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "runId", "type": "number", "info": "The unique identifier of the workflow run.: 123", "required": true, "schema": { "title": "runId", "type": "number" } }, { "name": "excludePullRequests", "type": "boolean", "info": "If `true` pull requests are omitted from the response (empty array).: boolean", "required": false, "schema": { "title": "excludePullRequests", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsGetWorkflowRun" }, "task": true }, { "name": "actionsDeleteWorkflowRun", "summary": "actions/delete-workflow-run", "description": "Deletes a specific workflow run.\n\nAnyone with write access to the repository can use this endpoint.\n\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "runId", "type": "number", "info": "The unique identifier of the workflow run.: 123", "required": true, "schema": { "title": "runId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsDeleteWorkflowRun" }, "task": true }, { "name": "actionsGetReviewsForRun", "summary": "actions/get-reviews-for-run", "description": "Anyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "runId", "type": "number", "info": "The unique identifier of the workflow run.: 123", "required": true, "schema": { "title": "runId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsGetReviewsForRun" }, "task": true }, { "name": "actionsApproveWorkflowRun", "summary": "actions/approve-workflow-run", "description": "Approves a workflow run for a pull request from a public fork of a first time contributor. For more information, see [\"Approving workflow runs from public forks](https://docs.github.com/actions/managing-workflow-runs/approving-workflow-runs-from-public-forks).\"\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "runId", "type": "number", "info": "The unique identifier of the workflow run.: 123", "required": true, "schema": { "title": "runId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsApproveWorkflowRun" }, "task": true }, { "name": "actionsListWorkflowRunArtifacts", "summary": "actions/list-workflow-run-artifacts", "description": "Lists artifacts for a workflow run.\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "runId", "type": "number", "info": "The unique identifier of the workflow run.: 123", "required": true, "schema": { "title": "runId", "type": "number" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "name", "type": "string", "info": "The name field of an artifact. When specified, only artifacts with this name will be returned.: string", "required": false, "schema": { "title": "name", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsListWorkflowRunArtifacts" }, "task": true }, { "name": "actionsGetWorkflowRunAttempt", "summary": "actions/get-workflow-run-attempt", "description": "Gets a specific workflow run attempt.\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "runId", "type": "number", "info": "The unique identifier of the workflow run.: 123", "required": true, "schema": { "title": "runId", "type": "number" } }, { "name": "attemptNumber", "type": "number", "info": "The attempt number of the workflow run.: 123", "required": true, "schema": { "title": "attemptNumber", "type": "number" } }, { "name": "excludePullRequests", "type": "boolean", "info": "If `true` pull requests are omitted from the response (empty array).: boolean", "required": false, "schema": { "title": "excludePullRequests", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsGetWorkflowRunAttempt" }, "task": true }, { "name": "actionsListJobsForWorkflowRunAttempt", "summary": "actions/list-jobs-for-workflow-run-attempt", "description": "Lists jobs for a specific workflow run attempt. You can use parameters to narrow the list of results. For more information\nabout using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters).\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "runId", "type": "number", "info": "The unique identifier of the workflow run.: 123", "required": true, "schema": { "title": "runId", "type": "number" } }, { "name": "attemptNumber", "type": "number", "info": "The attempt number of the workflow run.: 123", "required": true, "schema": { "title": "attemptNumber", "type": "number" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsListJobsForWorkflowRunAttempt" }, "task": true }, { "name": "actionsDownloadWorkflowRunAttemptLogs", "summary": "actions/download-workflow-run-attempt-logs", "description": "Gets a redirect URL to download an archive of log files for a specific workflow run attempt. This link expires after\n1 minute. Look for `Location:` in the response header to find the URL for the download.\n\nAnyone with read access to the repository can use this endpoint.\n\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "runId", "type": "number", "info": "The unique identifier of the workflow run.: 123", "required": true, "schema": { "title": "runId", "type": "number" } }, { "name": "attemptNumber", "type": "number", "info": "The attempt number of the workflow run.: 123", "required": true, "schema": { "title": "attemptNumber", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsDownloadWorkflowRunAttemptLogs" }, "task": true }, { "name": "actionsCancelWorkflowRun", "summary": "actions/cancel-workflow-run", "description": "Cancels a workflow run using its `id`.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "runId", "type": "number", "info": "The unique identifier of the workflow run.: 123", "required": true, "schema": { "title": "runId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsCancelWorkflowRun" }, "task": true }, { "name": "actionsReviewCustomGatesForRun", "summary": "actions/review-custom-gates-for-run", "description": "Approve or reject custom deployment protection rules provided by a GitHub App for a workflow run. For more information, see \"[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment).\"\n\n> [!NOTE]\n> GitHub Apps can only review their own custom deployment protection rules. To approve or reject pending deployments that are waiting for review from a specific person or team, see [`POST /repos/{owner}/{repo}/actio...(description truncated)", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "runId", "type": "number", "info": "The unique identifier of the workflow run.: 123", "required": true, "schema": { "title": "runId", "type": "number" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsReviewCustomGatesForRun" }, "task": true }, { "name": "actionsForceCancelWorkflowRun", "summary": "actions/force-cancel-workflow-run", "description": "Cancels a workflow run and bypasses conditions that would otherwise cause a workflow execution to continue, such as an `always()` condition on a job.\nYou should only use this endpoint to cancel a workflow run when the workflow run is not responding to [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/cancel`](/rest/actions/workflow-runs#cancel-a-workflow-run).\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "runId", "type": "number", "info": "The unique identifier of the workflow run.: 123", "required": true, "schema": { "title": "runId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsForceCancelWorkflowRun" }, "task": true }, { "name": "actionsListJobsForWorkflowRun", "summary": "actions/list-jobs-for-workflow-run", "description": "Lists jobs for a workflow run. You can use parameters to narrow the list of results. For more information\nabout using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters).\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "runId", "type": "number", "info": "The unique identifier of the workflow run.: 123", "required": true, "schema": { "title": "runId", "type": "number" } }, { "name": "filter", "type": "string", "info": "Filters jobs by their `completed_at` timestamp. `latest` returns jobs from the most recent execution of the workflow run. `all` returns all jobs for a workflow run, inclu...(description truncated): ", "required": false, "schema": { "title": "filter", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsListJobsForWorkflowRun" }, "task": true }, { "name": "actionsDownloadWorkflowRunLogs", "summary": "actions/download-workflow-run-logs", "description": "Gets a redirect URL to download an archive of log files for a workflow run. This link expires after 1 minute. Look for\n`Location:` in the response header to find the URL for the download.\n\nAnyone with read access to the repository can use this endpoint.\n\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "runId", "type": "number", "info": "The unique identifier of the workflow run.: 123", "required": true, "schema": { "title": "runId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsDownloadWorkflowRunLogs" }, "task": true }, { "name": "actionsDeleteWorkflowRunLogs", "summary": "actions/delete-workflow-run-logs", "description": "Deletes all logs for a workflow run.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "runId", "type": "number", "info": "The unique identifier of the workflow run.: 123", "required": true, "schema": { "title": "runId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsDeleteWorkflowRunLogs" }, "task": true }, { "name": "actionsGetPendingDeploymentsForRun", "summary": "actions/get-pending-deployments-for-run", "description": "Get all deployment environments for a workflow run that are waiting for protection rules to pass.\n\nAnyone with read access to the repository can use this endpoint.\n\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "runId", "type": "number", "info": "The unique identifier of the workflow run.: 123", "required": true, "schema": { "title": "runId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsGetPendingDeploymentsForRun" }, "task": true }, { "name": "actionsReviewPendingDeploymentsForRun", "summary": "actions/review-pending-deployments-for-run", "description": "Approve or reject pending deployments that are waiting on approval by a required reviewer.\n\nRequired reviewers with read access to the repository contents and deployments can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "runId", "type": "number", "info": "The unique identifier of the workflow run.: 123", "required": true, "schema": { "title": "runId", "type": "number" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsReviewPendingDeploymentsForRun" }, "task": true }, { "name": "actionsReRunWorkflow", "summary": "actions/re-run-workflow", "description": "Re-runs your workflow run using its `id`.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "runId", "type": "number", "info": "The unique identifier of the workflow run.: 123", "required": true, "schema": { "title": "runId", "type": "number" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsReRunWorkflow" }, "task": true }, { "name": "actionsReRunWorkflowFailedJobs", "summary": "actions/re-run-workflow-failed-jobs", "description": "Re-run all of the failed jobs and their dependent jobs in a workflow run using the `id` of the workflow run.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "runId", "type": "number", "info": "The unique identifier of the workflow run.: 123", "required": true, "schema": { "title": "runId", "type": "number" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsReRunWorkflowFailedJobs" }, "task": true }, { "name": "actionsGetWorkflowRunUsage", "summary": "actions/get-workflow-run-usage", "description": "Gets the number of billable minutes and total run time for a specific workflow run. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"[Managing billing for GitHub Actions](htt...(description truncated)", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "runId", "type": "number", "info": "The unique identifier of the workflow run.: 123", "required": true, "schema": { "title": "runId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsGetWorkflowRunUsage" }, "task": true }, { "name": "actionsListRepoSecrets", "summary": "actions/list-repo-secrets", "description": "Lists all secrets available in a repository without revealing their encrypted\nvalues.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsListRepoSecrets" }, "task": true }, { "name": "actionsGetRepoPublicKey", "summary": "actions/get-repo-public-key", "description": "Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.\n\nAnyone with read access to the repository can use this endpoint.\n\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsGetRepoPublicKey" }, "task": true }, { "name": "actionsGetRepoSecret", "summary": "actions/get-repo-secret", "description": "Gets a single repository secret without revealing its encrypted value.\n\nThe authenticated user must have collaborator access to the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "secretName", "type": "string", "info": "The name of the secret.: string", "required": true, "schema": { "title": "secretName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsGetRepoSecret" }, "task": true }, { "name": "actionsCreateOrUpdateRepoSecret", "summary": "actions/create-or-update-repo-secret", "description": "Creates or updates a repository secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoi...(description truncated)", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "secretName", "type": "string", "info": "The name of the secret.: string", "required": true, "schema": { "title": "secretName", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsCreateOrUpdateRepoSecret" }, "task": true }, { "name": "actionsDeleteRepoSecret", "summary": "actions/delete-repo-secret", "description": "Deletes a secret in a repository using the secret name.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "secretName", "type": "string", "info": "The name of the secret.: string", "required": true, "schema": { "title": "secretName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsDeleteRepoSecret" }, "task": true }, { "name": "actionsListRepoVariables", "summary": "actions/list-repo-variables", "description": "Lists all repository variables.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 30). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsListRepoVariables" }, "task": true }, { "name": "actionsCreateRepoVariable", "summary": "actions/create-repo-variable", "description": "Creates a repository variable that you can reference in a GitHub Actions workflow.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsCreateRepoVariable" }, "task": true }, { "name": "actionsGetRepoVariable", "summary": "actions/get-repo-variable", "description": "Gets a specific variable in a repository.\n\nThe authenticated user must have collaborator access to the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "name", "type": "string", "info": "The name of the variable.: string", "required": true, "schema": { "title": "name", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsGetRepoVariable" }, "task": true }, { "name": "actionsUpdateRepoVariable", "summary": "actions/update-repo-variable", "description": "Updates a repository variable that you can reference in a GitHub Actions workflow.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "name", "type": "string", "info": "The name of the variable.: string", "required": true, "schema": { "title": "name", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsUpdateRepoVariable" }, "task": true }, { "name": "actionsDeleteRepoVariable", "summary": "actions/delete-repo-variable", "description": "Deletes a repository variable using the variable name.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "name", "type": "string", "info": "The name of the variable.: string", "required": true, "schema": { "title": "name", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsDeleteRepoVariable" }, "task": true }, { "name": "actionsListRepoWorkflows", "summary": "actions/list-repo-workflows", "description": "Lists the workflows in a repository.\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsListRepoWorkflows" }, "task": true }, { "name": "actionsGetWorkflow", "summary": "actions/get-workflow", "description": "Gets a specific workflow. You can replace `workflow_id` with the workflow\nfile name. For example, you could use `main.yaml`.\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "workflowId", "type": "string", "info": "The ID of the workflow. You can also pass the workflow file name as a string.: ", "required": true, "schema": { "title": "workflowId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsGetWorkflow" }, "task": true }, { "name": "actionsDisableWorkflow", "summary": "actions/disable-workflow", "description": "Disables a workflow and sets the `state` of the workflow to `disabled_manually`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "workflowId", "type": "string", "info": "The ID of the workflow. You can also pass the workflow file name as a string.: ", "required": true, "schema": { "title": "workflowId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsDisableWorkflow" }, "task": true }, { "name": "actionsCreateWorkflowDispatch", "summary": "actions/create-workflow-dispatch", "description": "You can use this endpoint to manually trigger a GitHub Actions workflow run. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`.\n\nYou must configure your GitHub Actions workflow to run when the [`workflow_dispatch` webhook](/developers/webhooks-and-events/webhook-events-and-payloads#workflow_dispatch) event occurs. The `inputs` are configured in the workflow file. For more information about how to configure the `workflow_dispatch` event in the workf...(description truncated)", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "workflowId", "type": "string", "info": "The ID of the workflow. You can also pass the workflow file name as a string.: ", "required": true, "schema": { "title": "workflowId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsCreateWorkflowDispatch" }, "task": true }, { "name": "actionsEnableWorkflow", "summary": "actions/enable-workflow", "description": "Enables a workflow and sets the `state` of the workflow to `active`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "workflowId", "type": "string", "info": "The ID of the workflow. You can also pass the workflow file name as a string.: ", "required": true, "schema": { "title": "workflowId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsEnableWorkflow" }, "task": true }, { "name": "actionsListWorkflowRuns", "summary": "actions/list-workflow-runs", "description": "List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters).\n\nAnyone with read access to the repository can use this endpoint\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint ...(description truncated)", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "workflowId", "type": "string", "info": "The ID of the workflow. You can also pass the workflow file name as a string.: ", "required": true, "schema": { "title": "workflowId", "type": "string" } }, { "name": "actor", "type": "string", "info": "Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run.: string", "required": false, "schema": { "title": "actor", "type": "string" } }, { "name": "branch", "type": "string", "info": "Returns workflow runs associated with a branch. Use the name of the branch of the `push`.: string", "required": false, "schema": { "title": "branch", "type": "string" } }, { "name": "event", "type": "string", "info": "Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see \"[Events that trigger workflows](https:...(description truncated): string", "required": false, "schema": { "title": "event", "type": "string" } }, { "name": "status", "type": "string", "info": "Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitH...(description truncated): ", "required": false, "schema": { "title": "status", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "created", "type": "string", "info": "Returns workflow runs created within the given date-time range. For more information on the syntax, see \"[Understanding the search syntax](https://docs.github.com/search-...(description truncated): string", "required": false, "schema": { "title": "created", "type": "string" } }, { "name": "excludePullRequests", "type": "boolean", "info": "If `true` pull requests are omitted from the response (empty array).: boolean", "required": false, "schema": { "title": "excludePullRequests", "type": "boolean" } }, { "name": "checkSuiteId", "type": "number", "info": "Returns workflow runs with the `check_suite_id` that you specify.: 123", "required": false, "schema": { "title": "checkSuiteId", "type": "number" } }, { "name": "headSha", "type": "string", "info": "Only returns workflow runs that are associated with the specified `head_sha`.: string", "required": false, "schema": { "title": "headSha", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsListWorkflowRuns" }, "task": true }, { "name": "actionsGetWorkflowUsage", "summary": "actions/get-workflow-usage", "description": "Gets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"[Managing billing for GitHu...(description truncated)", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "workflowId", "type": "string", "info": "The ID of the workflow. You can also pass the workflow file name as a string.: ", "required": true, "schema": { "title": "workflowId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsGetWorkflowUsage" }, "task": true }, { "name": "actionsListEnvironmentSecrets", "summary": "actions/list-environment-secrets", "description": "Lists all secrets available in an environment without revealing their\nencrypted values.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "environmentName", "type": "string", "info": "The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.: string", "required": true, "schema": { "title": "environmentName", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsListEnvironmentSecrets" }, "task": true }, { "name": "actionsGetEnvironmentPublicKey", "summary": "actions/get-environment-public-key", "description": "Get the public key for an environment, which you need to encrypt environment\nsecrets. You need to encrypt a secret before you can create or update secrets.\n\nAnyone with read access to the repository can use this endpoint.\n\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "environmentName", "type": "string", "info": "The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.: string", "required": true, "schema": { "title": "environmentName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsGetEnvironmentPublicKey" }, "task": true }, { "name": "actionsGetEnvironmentSecret", "summary": "actions/get-environment-secret", "description": "Gets a single environment secret without revealing its encrypted value.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "environmentName", "type": "string", "info": "The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.: string", "required": true, "schema": { "title": "environmentName", "type": "string" } }, { "name": "secretName", "type": "string", "info": "The name of the secret.: string", "required": true, "schema": { "title": "secretName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsGetEnvironmentSecret" }, "task": true }, { "name": "actionsCreateOrUpdateEnvironmentSecret", "summary": "actions/create-or-update-environment-secret", "description": "Creates or updates an environment secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endp...(description truncated)", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "environmentName", "type": "string", "info": "The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.: string", "required": true, "schema": { "title": "environmentName", "type": "string" } }, { "name": "secretName", "type": "string", "info": "The name of the secret.: string", "required": true, "schema": { "title": "secretName", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsCreateOrUpdateEnvironmentSecret" }, "task": true }, { "name": "actionsDeleteEnvironmentSecret", "summary": "actions/delete-environment-secret", "description": "Deletes a secret in an environment using the secret name.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "environmentName", "type": "string", "info": "The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.: string", "required": true, "schema": { "title": "environmentName", "type": "string" } }, { "name": "secretName", "type": "string", "info": "The name of the secret.: string", "required": true, "schema": { "title": "secretName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsDeleteEnvironmentSecret" }, "task": true }, { "name": "actionsListEnvironmentVariables", "summary": "actions/list-environment-variables", "description": "Lists all environment variables.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "environmentName", "type": "string", "info": "The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.: string", "required": true, "schema": { "title": "environmentName", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 30). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsListEnvironmentVariables" }, "task": true }, { "name": "actionsCreateEnvironmentVariable", "summary": "actions/create-environment-variable", "description": "Create an environment variable that you can reference in a GitHub Actions workflow.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "environmentName", "type": "string", "info": "The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.: string", "required": true, "schema": { "title": "environmentName", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsCreateEnvironmentVariable" }, "task": true }, { "name": "actionsGetEnvironmentVariable", "summary": "actions/get-environment-variable", "description": "Gets a specific variable in an environment.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "environmentName", "type": "string", "info": "The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.: string", "required": true, "schema": { "title": "environmentName", "type": "string" } }, { "name": "name", "type": "string", "info": "The name of the variable.: string", "required": true, "schema": { "title": "name", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsGetEnvironmentVariable" }, "task": true }, { "name": "actionsUpdateEnvironmentVariable", "summary": "actions/update-environment-variable", "description": "Updates an environment variable that you can reference in a GitHub Actions workflow.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "name", "type": "string", "info": "The name of the variable.: string", "required": true, "schema": { "title": "name", "type": "string" } }, { "name": "environmentName", "type": "string", "info": "The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.: string", "required": true, "schema": { "title": "environmentName", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsUpdateEnvironmentVariable" }, "task": true }, { "name": "actionsDeleteEnvironmentVariable", "summary": "actions/delete-environment-variable", "description": "Deletes an environment variable using the variable name.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "name", "type": "string", "info": "The name of the variable.: string", "required": true, "schema": { "title": "name", "type": "string" } }, { "name": "environmentName", "type": "string", "info": "The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.: string", "required": true, "schema": { "title": "environmentName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/actionsDeleteEnvironmentVariable" }, "task": true }, { "name": "getEventsQuery", "summary": "activity/list-public-events", "description": "> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "input": [ { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getEventsQuery" }, "task": true }, { "name": "getNetworksOwnerRepoEventsQuery", "summary": "activity/list-public-events-for-repo-network", "description": "> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getNetworksOwnerRepoEventsQuery" }, "task": true }, { "name": "getNotificationsQuery", "summary": "activity/list-notifications-for-authenticated-user", "description": "List all notifications for the current user, sorted by most recently updated.", "input": [ { "name": "all", "type": "boolean", "info": "If `true`, show notifications marked as read.: boolean", "required": false, "schema": { "title": "all", "type": "boolean" } }, { "name": "participating", "type": "boolean", "info": "If `true`, only shows notifications in which the user is directly participating or mentioned.: boolean", "required": false, "schema": { "title": "participating", "type": "boolean" } }, { "name": "since", "type": "string", "info": "Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.: string", "required": false, "schema": { "title": "since", "type": "string" } }, { "name": "before", "type": "string", "info": "Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.: string", "required": false, "schema": { "title": "before", "type": "string" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 50). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getNotificationsQuery" }, "task": true }, { "name": "activityGetThread", "summary": "activity/get-thread", "description": "Gets information about a notification thread.", "input": [ { "name": "id", "type": "number", "info": "The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /no...(description truncated): 123", "required": true, "schema": { "title": "id", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/activityGetThread" }, "task": true }, { "name": "activityMarkThreadAsRead", "summary": "activity/mark-thread-as-read", "description": "Marks a thread as \"read.\" Marking a thread as \"read\" is equivalent to clicking a notification in your notification inbox on GitHub: https://github.com/notifications.", "input": [ { "name": "id", "type": "number", "info": "The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /no...(description truncated): 123", "required": true, "schema": { "title": "id", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/activityMarkThreadAsRead" }, "task": true }, { "name": "activityMarkThreadAsDone", "summary": "activity/mark-thread-as-done", "description": "Marks a thread as \"done.\" Marking a thread as \"done\" is equivalent to marking a notification in your notification inbox on GitHub as done: https://github.com/notifications.", "input": [ { "name": "id", "type": "number", "info": "The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /no...(description truncated): 123", "required": true, "schema": { "title": "id", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/activityMarkThreadAsDone" }, "task": true }, { "name": "activityGetThreadSubscriptionForAuthenticatedUser", "summary": "activity/get-thread-subscription-for-authenticated-user", "description": "This checks to see if the current user is subscribed to a thread. You can also [get a repository subscription](https://docs.github.com/rest/activity/watching#get-a-repository-subscription).\n\nNote that subscriptions are only generated if a user is participating in a conversation--for example, they've replied to the thread, were **@mentioned**, or manually subscribe to a thread.", "input": [ { "name": "id", "type": "number", "info": "The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /no...(description truncated): 123", "required": true, "schema": { "title": "id", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/activityGetThreadSubscriptionForAuthenticatedUser" }, "task": true }, { "name": "activitySetThreadSubscription", "summary": "activity/set-thread-subscription", "description": "If you are watching a repository, you receive notifications for all threads by default. Use this endpoint to ignore future notifications for threads until you comment on the thread or get an **@mention**.\n\nYou can also use this endpoint to subscribe to threads that you are currently not receiving notifications for or to subscribed to threads that you have previously ignored.\n\nUnsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the [Delete a t...(description truncated)", "input": [ { "name": "id", "type": "number", "info": "The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /no...(description truncated): 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/activitySetThreadSubscription" }, "task": true }, { "name": "activityDeleteThreadSubscription", "summary": "activity/delete-thread-subscription", "description": "Mutes all future notifications for a conversation until you comment on the thread or get an **@mention**. If you are watching the repository of the thread, you will still receive notifications. To ignore future notifications for a repository you are watching, use the [Set a thread subscription](https://docs.github.com/rest/activity/notifications#set-a-thread-subscription) endpoint and set `ignore` to `true`.", "input": [ { "name": "id", "type": "number", "info": "The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /no...(description truncated): 123", "required": true, "schema": { "title": "id", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/activityDeleteThreadSubscription" }, "task": true }, { "name": "activityListPublicEventsForUser", "summary": "activity/list-public-events-for-user", "description": "> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "input": [ { "name": "username", "type": "string", "info": "The handle for the GitHub user account.: string", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/activityListPublicEventsForUser" }, "task": true }, { "name": "getOrgsOrgEventsQuery", "summary": "activity/list-public-org-events", "description": "> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getOrgsOrgEventsQuery" }, "task": true }, { "name": "getOrgsOrgIssuesQuery", "summary": "issues/list-for-org", "description": "List issues in an organization assigned to the authenticated user.\n\n> [!NOTE]\n> GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull request id, use the \"[List pull requests](https://docs...(description truncated)", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "filter", "type": "string", "info": "Indicates which sorts of issues to return. `assigned` means issues assigned to you. `created` means issues created by you. `mentioned` means issues mentioning you. `subsc...(description truncated): ", "required": false, "schema": { "title": "filter", "type": "string" } }, { "name": "state", "type": "string", "info": "Indicates the state of the issues to return.: ", "required": false, "schema": { "title": "state", "type": "string" } }, { "name": "labels", "type": "string", "info": "A list of comma separated label names. Example: `bug,ui,@high`: string", "required": false, "schema": { "title": "labels", "type": "string" } }, { "name": "sort", "type": "string", "info": "What to sort results by.: ", "required": false, "schema": { "title": "sort", "type": "string" } }, { "name": "direction", "type": "string", "info": "The direction to sort the results by.: ", "required": false, "schema": { "title": "direction", "type": "string" } }, { "name": "since", "type": "string", "info": "Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.: string", "required": false, "schema": { "title": "since", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getOrgsOrgIssuesQuery" }, "task": true }, { "name": "orgsList", "summary": "orgs/list", "description": "Lists all organizations, in the order that they were created.\n\n> [!NOTE]\n> Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations.", "input": [ { "name": "since", "type": "number", "info": "An organization ID. Only return organizations with an ID greater than this ID.: 123", "required": false, "schema": { "title": "since", "type": "number" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/orgsList" }, "task": true }, { "name": "orgsDelete", "summary": "orgs/delete", "description": "Deletes an organization and all its repositories.\n\nThe organization login will be unavailable for 90 days after deletion.\n\nPlease review the Terms of Service regarding account deletion before using this endpoint:\n\nhttps://docs.github.com/site-policy/github-terms/github-terms-of-service", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/orgsDelete" }, "task": true }, { "name": "orgsListAttestations", "summary": "orgs/list-attestations", "description": "List a collection of artifact attestations with a given subject digest that are associated with repositories owned by an organization.\n\nThe collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required.\n\n**Pl...(description truncated)", "input": [ { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "before", "type": "string", "info": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches fo...(description truncated): string", "required": false, "schema": { "title": "before", "type": "string" } }, { "name": "after", "type": "string", "info": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches fo...(description truncated): string", "required": false, "schema": { "title": "after", "type": "string" } }, { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "subjectDigest", "type": "string", "info": "The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`.: string", "required": true, "schema": { "title": "subjectDigest", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/orgsListAttestations" }, "task": true }, { "name": "orgsListBlockedUsers", "summary": "orgs/list-blocked-users", "description": "List the users blocked by an organization.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/orgsListBlockedUsers" }, "task": true }, { "name": "orgsCheckBlockedUser", "summary": "orgs/check-blocked-user", "description": "Returns a 204 if the given user is blocked by the given organization. Returns a 404 if the organization is not blocking the user, or if the user account has been identified as spam by GitHub.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "username", "type": "string", "info": "The handle for the GitHub user account.: string", "required": true, "schema": { "title": "username", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/orgsCheckBlockedUser" }, "task": true }, { "name": "orgsBlockUser", "summary": "orgs/block-user", "description": "Blocks the given user on behalf of the specified organization and returns a 204. If the organization cannot block the given user a 422 is returned.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "username", "type": "string", "info": "The handle for the GitHub user account.: string", "required": true, "schema": { "title": "username", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/orgsBlockUser" }, "task": true }, { "name": "orgsUnblockUser", "summary": "orgs/unblock-user", "description": "Unblocks the given user on behalf of the specified organization.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "username", "type": "string", "info": "The handle for the GitHub user account.: string", "required": true, "schema": { "title": "username", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/orgsUnblockUser" }, "task": true }, { "name": "orgsListFailedInvitations", "summary": "orgs/list-failed-invitations", "description": "The return hash contains `failed_at` and `failed_reason` fields which represent the time at which the invitation failed and the reason for the failure.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/orgsListFailedInvitations" }, "task": true }, { "name": "orgsListWebhooks", "summary": "orgs/list-webhooks", "description": "You must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/orgsListWebhooks" }, "task": true }, { "name": "orgsCreateWebhook", "summary": "orgs/create-webhook", "description": "Create a hook that posts payloads in JSON format.\n\nYou must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or\nedit webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/orgsCreateWebhook" }, "task": true }, { "name": "orgsGetWebhook", "summary": "orgs/get-webhook", "description": "Returns a webhook configured in an organization. To get only the webhook\n`config` properties, see \"[Get a webhook configuration for an organization](/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization).\n\nYou must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by O...(description truncated)", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "hookId", "type": "number", "info": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.: 123", "required": true, "schema": { "title": "hookId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/orgsGetWebhook" }, "task": true }, { "name": "orgsUpdateWebhook", "summary": "orgs/update-webhook", "description": "Updates a webhook configured in an organization. When you update a webhook,\nthe `secret` will be overwritten. If you previously had a `secret` set, you must\nprovide the same `secret` or set a new `secret` or the secret will be removed. If\nyou are only updating individual webhook `config` properties, use \"[Update a webhook\nconfiguration for an organization](/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization)\".\n\nYou must be an organization owner to use this endpoint.\n\nOAuth app...(description truncated)", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "hookId", "type": "number", "info": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.: 123", "required": true, "schema": { "title": "hookId", "type": "number" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/orgsUpdateWebhook" }, "task": true }, { "name": "orgsDeleteWebhook", "summary": "orgs/delete-webhook", "description": "You must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "hookId", "type": "number", "info": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.: 123", "required": true, "schema": { "title": "hookId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/orgsDeleteWebhook" }, "task": true }, { "name": "orgsGetWebhookConfigForOrg", "summary": "orgs/get-webhook-config-for-org", "description": "Returns the webhook configuration for an organization. To get more information about the webhook, including the `active` state and `events`, use \"[Get an organization webhook ](/rest/orgs/webhooks#get-an-organization-webhook).\"\n\nYou must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were cre...(description truncated)", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "hookId", "type": "number", "info": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.: 123", "required": true, "schema": { "title": "hookId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/orgsGetWebhookConfigForOrg" }, "task": true }, { "name": "orgsUpdateWebhookConfigForOrg", "summary": "orgs/update-webhook-config-for-org", "description": "Updates the webhook configuration for an organization. To update more information about the webhook, including the `active` state and `events`, use \"[Update an organization webhook ](/rest/orgs/webhooks#update-an-organization-webhook).\"\n\nYou must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that...(description truncated)", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "hookId", "type": "number", "info": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.: 123", "required": true, "schema": { "title": "hookId", "type": "number" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/orgsUpdateWebhookConfigForOrg" }, "task": true }, { "name": "orgsListWebhookDeliveries", "summary": "orgs/list-webhook-deliveries", "description": "Returns a list of webhook deliveries for a webhook configured in an organization.\n\nYou must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "hookId", "type": "number", "info": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.: 123", "required": true, "schema": { "title": "hookId", "type": "number" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "cursor", "type": "string", "info": "Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors.: string", "required": false, "schema": { "title": "cursor", "type": "string" } }, { "name": "redelivery", "type": "boolean", "info": ": boolean", "required": false, "schema": { "title": "redelivery", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/orgsListWebhookDeliveries" }, "task": true }, { "name": "orgsGetWebhookDelivery", "summary": "orgs/get-webhook-delivery", "description": "Returns a delivery for a webhook configured in an organization.\n\nYou must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "hookId", "type": "number", "info": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.: 123", "required": true, "schema": { "title": "hookId", "type": "number" } }, { "name": "deliveryId", "type": "number", "info": ": 123", "required": true, "schema": { "title": "deliveryId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/orgsGetWebhookDelivery" }, "task": true }, { "name": "orgsRedeliverWebhookDelivery", "summary": "orgs/redeliver-webhook-delivery", "description": "Redeliver a delivery for a webhook configured in an organization.\n\nYou must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "hookId", "type": "number", "info": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.: 123", "required": true, "schema": { "title": "hookId", "type": "number" } }, { "name": "deliveryId", "type": "number", "info": ": 123", "required": true, "schema": { "title": "deliveryId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/orgsRedeliverWebhookDelivery" }, "task": true }, { "name": "orgsPingWebhook", "summary": "orgs/ping-webhook", "description": "This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event)\nto be sent to the hook.\n\nYou must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "hookId", "type": "number", "info": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.: 123", "required": true, "schema": { "title": "hookId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/orgsPingWebhook" }, "task": true }, { "name": "orgsListAppInstallations", "summary": "orgs/list-app-installations", "description": "Lists all GitHub Apps in an organization. The installation count includes\nall GitHub Apps installed on repositories in the organization.\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:read` scope to use this endpoint.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/orgsListAppInstallations" }, "task": true }, { "name": "orgsListPendingInvitations", "summary": "orgs/list-pending-invitations", "description": "The return hash contains a `role` field which refers to the Organization\nInvitation role and will be one of the following values: `direct_member`, `admin`,\n`billing_manager`, or `hiring_manager`. If the invitee is not a GitHub\nmember, the `login` field in the return hash will be `null`.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "role", "type": "string", "info": "Filter invitations by their member role.: ", "required": false, "schema": { "title": "role", "type": "string" } }, { "name": "invitationSource", "type": "string", "info": "Filter invitations by their invitation source.: ", "required": false, "schema": { "title": "invitationSource", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/orgsListPendingInvitations" }, "task": true }, { "name": "orgsCreateInvitation", "summary": "orgs/create-invitation", "description": "Invite people to an organization by using their GitHub user ID or their email address. In order to create invitations in an organization, the authenticated user must be an organization owner.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com...(description truncated)", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/orgsCreateInvitation" }, "task": true }, { "name": "orgsCancelInvitation", "summary": "orgs/cancel-invitation", "description": "Cancel an organization invitation. In order to cancel an organization invitation, the authenticated user must be an organization owner.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications).", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "invitationId", "type": "number", "info": "The unique identifier of the invitation.: 123", "required": true, "schema": { "title": "invitationId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/orgsCancelInvitation" }, "task": true }, { "name": "orgsListInvitationTeams", "summary": "orgs/list-invitation-teams", "description": "List all teams associated with an invitation. In order to see invitations in an organization, the authenticated user must be an organization owner.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "invitationId", "type": "number", "info": "The unique identifier of the invitation.: 123", "required": true, "schema": { "title": "invitationId", "type": "number" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/orgsListInvitationTeams" }, "task": true }, { "name": "getOrgsOrgMembersQuery", "summary": "orgs/list-members", "description": "List all users who are members of an organization. If the authenticated user is also a member of this organization then both concealed and public members will be returned.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "filter", "type": "string", "info": "Filter members returned in the list. `2fa_disabled` means that only members without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) en...(description truncated): ", "required": false, "schema": { "title": "filter", "type": "string" } }, { "name": "role", "type": "string", "info": "Filter members returned by their role.: ", "required": false, "schema": { "title": "role", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getOrgsOrgMembersQuery" }, "task": true }, { "name": "orgsGetMembershipForUser", "summary": "orgs/get-membership-for-user", "description": "In order to get a user's membership with an organization, the authenticated user must be an organization member. The `state` parameter in the response can be used to identify the user's membership status.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "username", "type": "string", "info": "The handle for the GitHub user account.: string", "required": true, "schema": { "title": "username", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/orgsGetMembershipForUser" }, "task": true }, { "name": "orgsSetMembershipForUser", "summary": "orgs/set-membership-for-user", "description": "Only authenticated organization owners can add a member to the organization or update the member's role.\n\n* If the authenticated user is _adding_ a member to the organization, the invited user will receive an email inviting them to the organization. The user's [membership status](https://docs.github.com/rest/orgs/members#get-organization-membership-for-a-user) will be `pending` until they accept the invitation.\n \n* Authenticated users can _update_ a user's membership by passing the `role`...(description truncated)", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "username", "type": "string", "info": "The handle for the GitHub user account.: string", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/orgsSetMembershipForUser" }, "task": true }, { "name": "orgsRemoveMembershipForUser", "summary": "orgs/remove-membership-for-user", "description": "In order to remove a user's membership with an organization, the authenticated user must be an organization owner.\n\nIf the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. The specified user will receive an email notification in both cases.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "username", "type": "string", "info": "The handle for the GitHub user account.: string", "required": true, "schema": { "title": "username", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/orgsRemoveMembershipForUser" }, "task": true }, { "name": "orgsListOrgRoles", "summary": "orgs/list-org-roles", "description": "Lists the organization roles available in this organization. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nTo use this endpoint, the authenticated user must be one of:\n\n- An administrator for the organization.\n- A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization.\n\nOAuth app t...(description truncated)", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/orgsListOrgRoles" }, "task": true }, { "name": "orgsRevokeAllOrgRolesTeam", "summary": "orgs/revoke-all-org-roles-team", "description": "Removes all assigned organization roles from a team. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "teamSlug", "type": "string", "info": "The slug of the team name.: string", "required": true, "schema": { "title": "teamSlug", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/orgsRevokeAllOrgRolesTeam" }, "task": true }, { "name": "orgsAssignTeamToOrgRole", "summary": "orgs/assign-team-to-org-role", "description": "Assigns an organization role to a team in an organization. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "teamSlug", "type": "string", "info": "The slug of the team name.: string", "required": true, "schema": { "title": "teamSlug", "type": "string" } }, { "name": "roleId", "type": "number", "info": "The unique identifier of the role.: 123", "required": true, "schema": { "title": "roleId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/orgsAssignTeamToOrgRole" }, "task": true }, { "name": "orgsRevokeOrgRoleTeam", "summary": "orgs/revoke-org-role-team", "description": "Removes an organization role from a team. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "teamSlug", "type": "string", "info": "The slug of the team name.: string", "required": true, "schema": { "title": "teamSlug", "type": "string" } }, { "name": "roleId", "type": "number", "info": "The unique identifier of the role.: 123", "required": true, "schema": { "title": "roleId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/orgsRevokeOrgRoleTeam" }, "task": true }, { "name": "orgsRevokeAllOrgRolesUser", "summary": "orgs/revoke-all-org-roles-user", "description": "Revokes all assigned organization roles from a user. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "username", "type": "string", "info": "The handle for the GitHub user account.: string", "required": true, "schema": { "title": "username", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/orgsRevokeAllOrgRolesUser" }, "task": true }, { "name": "orgsAssignUserToOrgRole", "summary": "orgs/assign-user-to-org-role", "description": "Assigns an organization role to a member of an organization. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "username", "type": "string", "info": "The handle for the GitHub user account.: string", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "roleId", "type": "number", "info": "The unique identifier of the role.: 123", "required": true, "schema": { "title": "roleId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/orgsAssignUserToOrgRole" }, "task": true }, { "name": "orgsRevokeOrgRoleUser", "summary": "orgs/revoke-org-role-user", "description": "Remove an organization role from a user. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "username", "type": "string", "info": "The handle for the GitHub user account.: string", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "roleId", "type": "number", "info": "The unique identifier of the role.: 123", "required": true, "schema": { "title": "roleId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/orgsRevokeOrgRoleUser" }, "task": true }, { "name": "orgsGetOrgRole", "summary": "orgs/get-org-role", "description": "Gets an organization role that is available to this organization. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nTo use this endpoint, the authenticated user must be one of:\n\n- An administrator for the organization.\n- A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization.\n\nOAuth ...(description truncated)", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "roleId", "type": "number", "info": "The unique identifier of the role.: 123", "required": true, "schema": { "title": "roleId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/orgsGetOrgRole" }, "task": true }, { "name": "orgsListOrgRoleTeams", "summary": "orgs/list-org-role-teams", "description": "Lists the teams that are assigned to an organization role. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nTo use this endpoint, you must be an administrator for the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "roleId", "type": "number", "info": "The unique identifier of the role.: 123", "required": true, "schema": { "title": "roleId", "type": "number" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/orgsListOrgRoleTeams" }, "task": true }, { "name": "orgsListOrgRoleUsers", "summary": "orgs/list-org-role-users", "description": "Lists organization members that are assigned to an organization role. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nTo use this endpoint, you must be an administrator for the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "roleId", "type": "number", "info": "The unique identifier of the role.: 123", "required": true, "schema": { "title": "roleId", "type": "number" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/orgsListOrgRoleUsers" }, "task": true }, { "name": "orgsListOutsideCollaborators", "summary": "orgs/list-outside-collaborators", "description": "List all users who are outside collaborators of an organization.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "filter", "type": "string", "info": "Filter the list of outside collaborators. `2fa_disabled` means that only outside collaborators without [two-factor authentication](https://github.com/blog/1614-two-factor...(description truncated): ", "required": false, "schema": { "title": "filter", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/orgsListOutsideCollaborators" }, "task": true }, { "name": "orgsConvertMemberToOutsideCollaborator", "summary": "orgs/convert-member-to-outside-collaborator", "description": "When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see \"[Converting an organization member to an outside collaborator](https://docs.github.com/articles/converting-an-organization-member-to-an-outside-collaborator/)\". Converting an organization member to an outside collaborator may be restricted by enterprise admin...(description truncated)", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "username", "type": "string", "info": "The handle for the GitHub user account.: string", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/orgsConvertMemberToOutsideCollaborator" }, "task": true }, { "name": "orgsRemoveOutsideCollaborator", "summary": "orgs/remove-outside-collaborator", "description": "Removing a user from this list will remove them from all the organization's repositories.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "username", "type": "string", "info": "The handle for the GitHub user account.: string", "required": true, "schema": { "title": "username", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/orgsRemoveOutsideCollaborator" }, "task": true }, { "name": "orgsListPatGrantRequests", "summary": "orgs/list-pat-grant-requests", "description": "Lists requests from organization members to access organization resources with a fine-grained personal access token.\n\nOnly GitHub Apps can use this endpoint.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "sort", "type": "string", "info": "The property by which to sort the results.: ", "required": false, "schema": { "title": "sort", "type": "string" } }, { "name": "direction", "type": "string", "info": "The direction to sort the results by.: ", "required": false, "schema": { "title": "direction", "type": "string" } }, { "name": "owner", "type": "array", "info": "A list of owner usernames to use to filter the results.: array", "required": false, "schema": { "title": "owner", "type": "array" } }, { "name": "repository", "type": "string", "info": "The name of the repository to use to filter the results.: string", "required": false, "schema": { "title": "repository", "type": "string" } }, { "name": "permission", "type": "string", "info": "The permission to use to filter the results.: string", "required": false, "schema": { "title": "permission", "type": "string" } }, { "name": "lastUsedBefore", "type": "string", "info": "Only show fine-grained personal access tokens used before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH...(description truncated): string", "required": false, "schema": { "title": "lastUsedBefore", "type": "string" } }, { "name": "lastUsedAfter", "type": "string", "info": "Only show fine-grained personal access tokens used after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:...(description truncated): string", "required": false, "schema": { "title": "lastUsedAfter", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/orgsListPatGrantRequests" }, "task": true }, { "name": "orgsReviewPatGrantRequestsInBulk", "summary": "orgs/review-pat-grant-requests-in-bulk", "description": "Approves or denies multiple pending requests to access organization resources via a fine-grained personal access token.\n\nOnly GitHub Apps can use this endpoint.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/orgsReviewPatGrantRequestsInBulk" }, "task": true }, { "name": "orgsReviewPatGrantRequest", "summary": "orgs/review-pat-grant-request", "description": "Approves or denies a pending request to access organization resources via a fine-grained personal access token.\n\nOnly GitHub Apps can use this endpoint.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "patRequestId", "type": "number", "info": "Unique identifier of the request for access via fine-grained personal access token.: 123", "required": true, "schema": { "title": "patRequestId", "type": "number" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/orgsReviewPatGrantRequest" }, "task": true }, { "name": "orgsListPatGrantRequestRepositories", "summary": "orgs/list-pat-grant-request-repositories", "description": "Lists the repositories a fine-grained personal access token request is requesting access to.\n\nOnly GitHub Apps can use this endpoint.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "patRequestId", "type": "number", "info": "Unique identifier of the request for access via fine-grained personal access token.: 123", "required": true, "schema": { "title": "patRequestId", "type": "number" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/orgsListPatGrantRequestRepositories" }, "task": true }, { "name": "orgsListPatGrants", "summary": "orgs/list-pat-grants", "description": "Lists approved fine-grained personal access tokens owned by organization members that can access organization resources.\n\nOnly GitHub Apps can use this endpoint.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "sort", "type": "string", "info": "The property by which to sort the results.: ", "required": false, "schema": { "title": "sort", "type": "string" } }, { "name": "direction", "type": "string", "info": "The direction to sort the results by.: ", "required": false, "schema": { "title": "direction", "type": "string" } }, { "name": "owner", "type": "array", "info": "A list of owner usernames to use to filter the results.: array", "required": false, "schema": { "title": "owner", "type": "array" } }, { "name": "repository", "type": "string", "info": "The name of the repository to use to filter the results.: string", "required": false, "schema": { "title": "repository", "type": "string" } }, { "name": "permission", "type": "string", "info": "The permission to use to filter the results.: string", "required": false, "schema": { "title": "permission", "type": "string" } }, { "name": "lastUsedBefore", "type": "string", "info": "Only show fine-grained personal access tokens used before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH...(description truncated): string", "required": false, "schema": { "title": "lastUsedBefore", "type": "string" } }, { "name": "lastUsedAfter", "type": "string", "info": "Only show fine-grained personal access tokens used after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:...(description truncated): string", "required": false, "schema": { "title": "lastUsedAfter", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/orgsListPatGrants" }, "task": true }, { "name": "orgsUpdatePatAccesses", "summary": "orgs/update-pat-accesses", "description": "Updates the access organization members have to organization resources via fine-grained personal access tokens. Limited to revoking a token's existing access.\n\nOnly GitHub Apps can use this endpoint.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/orgsUpdatePatAccesses" }, "task": true }, { "name": "orgsUpdatePatAccess", "summary": "orgs/update-pat-access", "description": "Updates the access an organization member has to organization resources via a fine-grained personal access token. Limited to revoking the token's existing access. Limited to revoking a token's existing access.\n\nOnly GitHub Apps can use this endpoint.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "patId", "type": "number", "info": "The unique identifier of the fine-grained personal access token.: 123", "required": true, "schema": { "title": "patId", "type": "number" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/orgsUpdatePatAccess" }, "task": true }, { "name": "orgsListPatGrantRepositories", "summary": "orgs/list-pat-grant-repositories", "description": "Lists the repositories a fine-grained personal access token has access to.\n\nOnly GitHub Apps can use this endpoint.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "patId", "type": "number", "info": "Unique identifier of the fine-grained personal access token.: 123", "required": true, "schema": { "title": "patId", "type": "number" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/orgsListPatGrantRepositories" }, "task": true }, { "name": "orgsGetAllCustomProperties", "summary": "orgs/get-all-custom-properties", "description": "Gets all custom properties defined for an organization.\nOrganization members can read these properties.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/orgsGetAllCustomProperties" }, "task": true }, { "name": "orgsCreateOrUpdateCustomProperties", "summary": "orgs/create-or-update-custom-properties", "description": "Creates new or updates existing custom properties defined for an organization in a batch.\n\nTo use this endpoint, the authenticated user must be one of:\n - An administrator for the organization.\n - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/orgsCreateOrUpdateCustomProperties" }, "task": true }, { "name": "orgsGetCustomProperty", "summary": "orgs/get-custom-property", "description": "Gets a custom property that is defined for an organization.\nOrganization members can read these properties.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "customPropertyName", "type": "string", "info": "The custom property name. The name is case sensitive.: string", "required": true, "schema": { "title": "customPropertyName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/orgsGetCustomProperty" }, "task": true }, { "name": "orgsCreateOrUpdateCustomProperty", "summary": "orgs/create-or-update-custom-property", "description": "Creates a new or updates an existing custom property that is defined for an organization.\n\nTo use this endpoint, the authenticated user must be one of:\n- An administrator for the organization.\n- A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "customPropertyName", "type": "string", "info": "The custom property name. The name is case sensitive.: string", "required": true, "schema": { "title": "customPropertyName", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/orgsCreateOrUpdateCustomProperty" }, "task": true }, { "name": "orgsRemoveCustomProperty", "summary": "orgs/remove-custom-property", "description": "Removes a custom property that is defined for an organization.\n\nTo use this endpoint, the authenticated user must be one of:\n - An administrator for the organization.\n - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "customPropertyName", "type": "string", "info": "The custom property name. The name is case sensitive.: string", "required": true, "schema": { "title": "customPropertyName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/orgsRemoveCustomProperty" }, "task": true }, { "name": "orgsListCustomPropertiesValuesForRepos", "summary": "orgs/list-custom-properties-values-for-repos", "description": "Lists organization repositories with all of their custom property values.\nOrganization members can read these properties.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "repositoryQuery", "type": "string", "info": "Finds repositories in the organization with a query containing one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of ...(description truncated): string", "required": false, "schema": { "title": "repositoryQuery", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/orgsListCustomPropertiesValuesForRepos" }, "task": true }, { "name": "orgsCreateOrUpdateCustomPropertiesValuesForRepos", "summary": "orgs/create-or-update-custom-properties-values-for-repos", "description": "Create new or update existing custom property values for repositories in a batch that belong to an organization.\nEach target repository will have its custom property values updated to match the values provided in the request.\n\nA maximum of 30 repositories can be updated in a single request.\n\nUsing a value of `null` for a custom property will remove or 'unset' the property value from the repository.\n\nTo use this endpoint, the authenticated user must be one of:\n - An administrator for the organiz...(description truncated)", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/orgsCreateOrUpdateCustomPropertiesValuesForRepos" }, "task": true }, { "name": "getOrgsOrgPublicMembersQuery", "summary": "orgs/list-public-members", "description": "Members of an organization can choose to have their membership publicized or not.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getOrgsOrgPublicMembersQuery" }, "task": true }, { "name": "orgsListSecurityManagerTeams", "summary": "orgs/list-security-manager-teams", "description": "Lists teams that are security managers for an organization. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/orgsListSecurityManagerTeams" }, "task": true }, { "name": "orgsAddSecurityManagerTeam", "summary": "orgs/add-security-manager-team", "description": "Adds a team as a security manager for an organization. For more information, see \"[Managing security for an organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) for an organization.\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "teamSlug", "type": "string", "info": "The slug of the team name.: string", "required": true, "schema": { "title": "teamSlug", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/orgsAddSecurityManagerTeam" }, "task": true }, { "name": "orgsRemoveSecurityManagerTeam", "summary": "orgs/remove-security-manager-team", "description": "Removes the security manager role from a team for an organization. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) team from an organization.\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this...(description truncated)", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "teamSlug", "type": "string", "info": "The slug of the team name.: string", "required": true, "schema": { "title": "teamSlug", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/orgsRemoveSecurityManagerTeam" }, "task": true }, { "name": "orgsListMembershipsForAuthenticatedUser", "summary": "orgs/list-memberships-for-authenticated-user", "description": "Lists all of the authenticated user's organization memberships.", "input": [ { "name": "state", "type": "string", "info": "Indicates the state of the memberships to return. If not specified, the API returns both active and pending memberships.: ", "required": false, "schema": { "title": "state", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/orgsListMembershipsForAuthenticatedUser" }, "task": true }, { "name": "orgsGetMembershipForAuthenticatedUser", "summary": "orgs/get-membership-for-authenticated-user", "description": "If the authenticated user is an active or pending member of the organization, this endpoint will return the user's membership. If the authenticated user is not affiliated with the organization, a `404` is returned. This endpoint will return a `403` if the request is made by a GitHub App that is blocked by the organization.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/orgsGetMembershipForAuthenticatedUser" }, "task": true }, { "name": "orgsUpdateMembershipForAuthenticatedUser", "summary": "orgs/update-membership-for-authenticated-user", "description": "Converts the authenticated user to an active member of the organization, if that user has a pending invitation from the organization.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/orgsUpdateMembershipForAuthenticatedUser" }, "task": true }, { "name": "getOrgsOrgReposQuery", "summary": "repos/list-for-org", "description": "Lists repositories for the specified organization.\n\n> [!NOTE]\n> In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "type", "type": "string", "info": "Specifies the types of repositories you want returned.: ", "required": false, "schema": { "title": "type", "type": "string" } }, { "name": "sort", "type": "string", "info": "The property to sort the results by.: ", "required": false, "schema": { "title": "sort", "type": "string" } }, { "name": "direction", "type": "string", "info": "The order to sort by. Default: `asc` when using `full_name`, otherwise `desc`.: ", "required": false, "schema": { "title": "direction", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getOrgsOrgReposQuery" }, "task": true }, { "name": "getOrgsOrgTeamsQuery", "summary": "teams/list", "description": "Lists all teams in an organization that are visible to the authenticated user.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getOrgsOrgTeamsQuery" }, "task": true }, { "name": "getReposOwnerRepoEventsQuery", "summary": "activity/list-repo-events", "description": "> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getReposOwnerRepoEventsQuery" }, "task": true }, { "name": "getReposOwnerRepoNotificationsQuery", "summary": "activity/list-repo-notifications-for-authenticated-user", "description": "Lists all notifications for the current user in the specified repository.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "all", "type": "boolean", "info": "If `true`, show notifications marked as read.: boolean", "required": false, "schema": { "title": "all", "type": "boolean" } }, { "name": "participating", "type": "boolean", "info": "If `true`, only shows notifications in which the user is directly participating or mentioned.: boolean", "required": false, "schema": { "title": "participating", "type": "boolean" } }, { "name": "since", "type": "string", "info": "Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.: string", "required": false, "schema": { "title": "since", "type": "string" } }, { "name": "before", "type": "string", "info": "Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.: string", "required": false, "schema": { "title": "before", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getReposOwnerRepoNotificationsQuery" }, "task": true }, { "name": "getReposOwnerRepoStargazersQuery", "summary": "activity/list-stargazers-for-repo", "description": "Lists the people that have starred the repository.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getReposOwnerRepoStargazersQuery" }, "task": true }, { "name": "getReposOwnerRepoSubscribersQuery", "summary": "activity/list-watchers-for-repo", "description": "Lists the people watching the specified repository.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getReposOwnerRepoSubscribersQuery" }, "task": true }, { "name": "getReposOwnerRepoAssigneesQuery", "summary": "issues/list-assignees", "description": "Lists the [available assignees](https://docs.github.com/articles/assigning-issues-and-pull-requests-to-other-github-users/) for issues in a repository.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getReposOwnerRepoAssigneesQuery" }, "task": true }, { "name": "getReposOwnerRepoIssuesQuery", "summary": "issues/list-for-repo", "description": "List issues in a repository. Only open issues will be listed.\n\n> [!NOTE]\n> GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull request id, use the \"[List pull requests](https://docs.gith...(description truncated)", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "milestone", "type": "string", "info": "If an `integer` is passed, it should refer to a milestone by its `number` field. If the string `*` is passed, issues with any milestone are accepted. If the string `none`...(description truncated): string", "required": false, "schema": { "title": "milestone", "type": "string" } }, { "name": "state", "type": "string", "info": "Indicates the state of the issues to return.: ", "required": false, "schema": { "title": "state", "type": "string" } }, { "name": "assignee", "type": "string", "info": "Can be the name of a user. Pass in `none` for issues with no assigned user, and `*` for issues assigned to any user.: string", "required": false, "schema": { "title": "assignee", "type": "string" } }, { "name": "creator", "type": "string", "info": "The user that created the issue.: string", "required": false, "schema": { "title": "creator", "type": "string" } }, { "name": "mentioned", "type": "string", "info": "A user that's mentioned in the issue.: string", "required": false, "schema": { "title": "mentioned", "type": "string" } }, { "name": "labels", "type": "string", "info": "A list of comma separated label names. Example: `bug,ui,@high`: string", "required": false, "schema": { "title": "labels", "type": "string" } }, { "name": "sort", "type": "string", "info": "What to sort results by.: ", "required": false, "schema": { "title": "sort", "type": "string" } }, { "name": "direction", "type": "string", "info": "The direction to sort the results by.: ", "required": false, "schema": { "title": "direction", "type": "string" } }, { "name": "since", "type": "string", "info": "Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.: string", "required": false, "schema": { "title": "since", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getReposOwnerRepoIssuesQuery" }, "task": true }, { "name": "getReposOwnerRepoIssuesCommentsQuery", "summary": "issues/list-comments-for-repo", "description": "You can use the REST API to list comments on issues and pull requests for a repository. Every pull request is an issue, but not every issue is a pull request.\n\nBy default, issue comments are ordered by ascending ID.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will i...(description truncated)", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "sort", "type": "string", "info": "The property to sort the results by.: ", "required": false, "schema": { "title": "sort", "type": "string" } }, { "name": "direction", "type": "string", "info": "Either `asc` or `desc`. Ignored without the `sort` parameter.: ", "required": false, "schema": { "title": "direction", "type": "string" } }, { "name": "since", "type": "string", "info": "Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.: string", "required": false, "schema": { "title": "since", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getReposOwnerRepoIssuesCommentsQuery" }, "task": true }, { "name": "getReposOwnerRepoIssuesEventsQuery", "summary": "issues/list-events-for-repo", "description": "Lists events for a repository.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getReposOwnerRepoIssuesEventsQuery" }, "task": true }, { "name": "getReposOwnerRepoIssuesNumberCommentsQuery", "summary": "issues/list-comments", "description": "You can use the REST API to list comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.\n\nIssue comments are ordered by ascending ID.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the de...(description truncated)", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "issueNumber", "type": "number", "info": "The number that identifies the issue.: 123", "required": true, "schema": { "title": "issueNumber", "type": "number" } }, { "name": "since", "type": "string", "info": "Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.: string", "required": false, "schema": { "title": "since", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getReposOwnerRepoIssuesNumberCommentsQuery" }, "task": true }, { "name": "getReposOwnerRepoIssuesNumberEventsQuery", "summary": "issues/list-events", "description": "Lists all events for an issue.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "issueNumber", "type": "number", "info": "The number that identifies the issue.: 123", "required": true, "schema": { "title": "issueNumber", "type": "number" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getReposOwnerRepoIssuesNumberEventsQuery" }, "task": true }, { "name": "getReposOwnerRepoIssuesNumberLabelsQuery", "summary": "issues/list-labels-on-issue", "description": "Lists all labels for an issue.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "issueNumber", "type": "number", "info": "The number that identifies the issue.: 123", "required": true, "schema": { "title": "issueNumber", "type": "number" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getReposOwnerRepoIssuesNumberLabelsQuery" }, "task": true }, { "name": "getReposOwnerRepoLabelsQuery", "summary": "issues/list-labels-for-repo", "description": "Lists all labels for a repository.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getReposOwnerRepoLabelsQuery" }, "task": true }, { "name": "getReposOwnerRepoMilestonesQuery", "summary": "issues/list-milestones", "description": "Lists milestones for a repository.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "state", "type": "string", "info": "The state of the milestone. Either `open`, `closed`, or `all`.: ", "required": false, "schema": { "title": "state", "type": "string" } }, { "name": "sort", "type": "string", "info": "What to sort results by. Either `due_on` or `completeness`.: ", "required": false, "schema": { "title": "sort", "type": "string" } }, { "name": "direction", "type": "string", "info": "The direction of the sort. Either `asc` or `desc`.: ", "required": false, "schema": { "title": "direction", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getReposOwnerRepoMilestonesQuery" }, "task": true }, { "name": "getReposOwnerRepoMilestonesNumberLabelsQuery", "summary": "issues/list-labels-for-milestone", "description": "Lists labels for issues in a milestone.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "milestoneNumber", "type": "number", "info": "The number that identifies the milestone.: 123", "required": true, "schema": { "title": "milestoneNumber", "type": "number" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getReposOwnerRepoMilestonesNumberLabelsQuery" }, "task": true }, { "name": "getReposOwnerRepoPullsQuery", "summary": "pulls/list", "description": "Lists pull requests in a specified repository.\n\nDraft pull requests are available in public repositories with GitHub\nFree and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing\nplans, and in public and private repositories with GitHub Team and GitHub Enterprise\nCloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)\nin the GitHub Help documentation.\n\nThis endpoint supports the following custom med...(description truncated)", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "state", "type": "string", "info": "Either `open`, `closed`, or `all` to filter by state.: ", "required": false, "schema": { "title": "state", "type": "string" } }, { "name": "head", "type": "string", "info": "Filter pulls by head user or head organization and branch name in the format of `user:ref-name` or `organization:ref-name`. For example: `github:new-script-format` or `oc...(description truncated): string", "required": false, "schema": { "title": "head", "type": "string" } }, { "name": "base", "type": "string", "info": "Filter pulls by base branch name. Example: `gh-pages`.: string", "required": false, "schema": { "title": "base", "type": "string" } }, { "name": "sort", "type": "string", "info": "What to sort results by. `popularity` will sort by the number of comments. `long-running` will sort by date created and will limit the results to pull requests that have ...(description truncated): ", "required": false, "schema": { "title": "sort", "type": "string" } }, { "name": "direction", "type": "string", "info": "The direction of the sort. Default: `desc` when sort is `created` or sort is not specified, otherwise `asc`.: ", "required": false, "schema": { "title": "direction", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getReposOwnerRepoPullsQuery" }, "task": true }, { "name": "getReposOwnerRepoPullsCommentsQuery", "summary": "pulls/list-review-comments-for-repo", "description": "Lists review comments for all pull requests in a repository. By default,\nreview comments are in ascending order by ID.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **...(description truncated)", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "sort", "type": "string", "info": ": Must be one of [created, updated, created_at]", "required": false, "schema": { "title": "sort", "type": "string" } }, { "name": "direction", "type": "string", "info": "The direction to sort results. Ignored without `sort` parameter.: ", "required": false, "schema": { "title": "direction", "type": "string" } }, { "name": "since", "type": "string", "info": "Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.: string", "required": false, "schema": { "title": "since", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getReposOwnerRepoPullsCommentsQuery" }, "task": true }, { "name": "getReposOwnerRepoPullsNumberCommentsQuery", "summary": "pulls/list-review-comments", "description": "Lists all review comments for a specified pull request. By default, review comments\nare in ascending order by ID.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`appl...(description truncated)", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "pullNumber", "type": "number", "info": "The number that identifies the pull request.: 123", "required": true, "schema": { "title": "pullNumber", "type": "number" } }, { "name": "sort", "type": "string", "info": "The property to sort the results by.: ", "required": false, "schema": { "title": "sort", "type": "string" } }, { "name": "direction", "type": "string", "info": "The direction to sort results. Ignored without `sort` parameter.: ", "required": false, "schema": { "title": "direction", "type": "string" } }, { "name": "since", "type": "string", "info": "Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.: string", "required": false, "schema": { "title": "since", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getReposOwnerRepoPullsNumberCommentsQuery" }, "task": true }, { "name": "getReposOwnerRepoPullsNumberCommitsQuery", "summary": "pulls/list-commits", "description": "Lists a maximum of 250 commits for a pull request. To receive a complete\ncommit list for pull requests with more than 250 commits, use the [List commits](https://docs.github.com/rest/commits/commits#list-commits)\nendpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response...(description truncated)", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "pullNumber", "type": "number", "info": "The number that identifies the pull request.: 123", "required": true, "schema": { "title": "pullNumber", "type": "number" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getReposOwnerRepoPullsNumberCommitsQuery" }, "task": true }, { "name": "getReposOwnerRepoPullsNumberFilesQuery", "summary": "pulls/list-files", "description": "Lists the files in a specified pull request.\n\n> [!NOTE]\n> Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass ...(description truncated)", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "pullNumber", "type": "number", "info": "The number that identifies the pull request.: 123", "required": true, "schema": { "title": "pullNumber", "type": "number" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getReposOwnerRepoPullsNumberFilesQuery" }, "task": true }, { "name": "reposGetOrgRulesets", "summary": "repos/get-org-rulesets", "description": "Get all the repository rulesets for an organization.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposGetOrgRulesets" }, "task": true }, { "name": "reposCreateOrgRuleset", "summary": "repos/create-org-ruleset", "description": "Create a repository ruleset for an organization.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposCreateOrgRuleset" }, "task": true }, { "name": "reposGetOrgRuleSuites", "summary": "repos/get-org-rule-suites", "description": "Lists suites of rule evaluations at the organization level.\nFor more information, see \"[Managing rulesets for repositories in your organization](https://docs.github.com/organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization#viewing-insights-for-rulesets).\"", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "ref", "type": "string", "info": "The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit to tags. Omit the prefix to se...(description truncated): string", "required": false, "schema": { "title": "ref", "type": "string" } }, { "name": "repositoryName", "type": "number", "info": "The name of the repository to filter on. When specified, only rule evaluations from this repository will be returned.: 123", "required": false, "schema": { "title": "repositoryName", "type": "number" } }, { "name": "timePeriod", "type": "string", "info": "The time period to filter by.\n\nFor example, `day` will filter for rule suites that occurred in the past 24 hours, and `week` will filter for insights that occurred in the...(description truncated): ", "required": false, "schema": { "title": "timePeriod", "type": "string" } }, { "name": "actorName", "type": "string", "info": "The handle for the GitHub user account to filter on. When specified, only rule evaluations triggered by this actor will be returned.: string", "required": false, "schema": { "title": "actorName", "type": "string" } }, { "name": "ruleSuiteResult", "type": "string", "info": "The rule results to filter on. When specified, only suites with this result will be returned.: ", "required": false, "schema": { "title": "ruleSuiteResult", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposGetOrgRuleSuites" }, "task": true }, { "name": "reposGetOrgRuleSuite", "summary": "repos/get-org-rule-suite", "description": "Gets information about a suite of rule evaluations from within an organization.\nFor more information, see \"[Managing rulesets for repositories in your organization](https://docs.github.com/organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization#viewing-insights-for-rulesets).\"", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "ruleSuiteId", "type": "number", "info": "The unique identifier of the rule suite result.\nTo get this ID, you can use [GET /repos/{owner}/{repo}/rulesets/rule-suites](https://docs.github.com/rest/repos/rule-suite...(description truncated): 123", "required": true, "schema": { "title": "ruleSuiteId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposGetOrgRuleSuite" }, "task": true }, { "name": "reposGetOrgRuleset", "summary": "repos/get-org-ruleset", "description": "Get a repository ruleset for an organization.\n\n**Note:** To prevent leaking sensitive information, the `bypass_actors` property is only returned if the user\nmaking the API request has write access to the ruleset.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "rulesetId", "type": "number", "info": "The ID of the ruleset.: 123", "required": true, "schema": { "title": "rulesetId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposGetOrgRuleset" }, "task": true }, { "name": "reposUpdateOrgRuleset", "summary": "repos/update-org-ruleset", "description": "Update a ruleset for an organization.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "rulesetId", "type": "number", "info": "The ID of the ruleset.: 123", "required": true, "schema": { "title": "rulesetId", "type": "number" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposUpdateOrgRuleset" }, "task": true }, { "name": "reposDeleteOrgRuleset", "summary": "repos/delete-org-ruleset", "description": "Delete a ruleset for an organization.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "rulesetId", "type": "number", "info": "The ID of the ruleset.: 123", "required": true, "schema": { "title": "rulesetId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposDeleteOrgRuleset" }, "task": true }, { "name": "reposListActivities", "summary": "repos/list-activities", "description": "Lists a detailed history of changes to a repository, such as pushes, merges, force pushes, and branch changes, and associates these changes with commits and users.\n\nFor more information about viewing repository activity,\nsee \"[Viewing activity and data for your repository](https://docs.github.com/repositories/viewing-activity-and-data-for-your-repository).\"", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "direction", "type": "string", "info": "The direction to sort the results by.: ", "required": false, "schema": { "title": "direction", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "before", "type": "string", "info": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches fo...(description truncated): string", "required": false, "schema": { "title": "before", "type": "string" } }, { "name": "after", "type": "string", "info": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches fo...(description truncated): string", "required": false, "schema": { "title": "after", "type": "string" } }, { "name": "ref", "type": "string", "info": "The Git reference for the activities you want to list.\n\nThe `ref` for a branch can be formatted either as `refs/heads/BRANCH_NAME` or `BRANCH_NAME`, where `BRANCH_NAME` i...(description truncated): string", "required": false, "schema": { "title": "ref", "type": "string" } }, { "name": "actor", "type": "string", "info": "The GitHub username to use to filter by the actor who performed the activity.: string", "required": false, "schema": { "title": "actor", "type": "string" } }, { "name": "timePeriod", "type": "string", "info": "The time period to filter by.\n\nFor example, `day` will filter for activity that occurred in the past 24 hours, and `week` will filter for activity that occurred in the pa...(description truncated): ", "required": false, "schema": { "title": "timePeriod", "type": "string" } }, { "name": "activityType", "type": "string", "info": "The activity type to filter by.\n\nFor example, you can choose to filter by \"force_push\", to see all force pushes to the repository.: ", "required": false, "schema": { "title": "activityType", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposListActivities" }, "task": true }, { "name": "reposCreateAttestation", "summary": "repos/create-attestation", "description": "Store an artifact attestation and associate it with a repository.\n\nThe authenticated user must have write permission to the repository and, if using a fine-grained access token, the `attestations:write` permission is required.\n\nArtifact attestations are meant to be created using the [attest action](https://github.com/actions/attest). For more information, see our guide on [using artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifac...(description truncated)", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposCreateAttestation" }, "task": true }, { "name": "reposListAttestations", "summary": "repos/list-attestations", "description": "List a collection of artifact attestations with a given subject digest that are associated with a repository.\n\nThe authenticated user making the request must have read access to the repository. In addition, when using a fine-grained access token the `attestations:read` permission is required.\n\n**Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be val...(description truncated)", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "before", "type": "string", "info": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches fo...(description truncated): string", "required": false, "schema": { "title": "before", "type": "string" } }, { "name": "after", "type": "string", "info": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches fo...(description truncated): string", "required": false, "schema": { "title": "after", "type": "string" } }, { "name": "subjectDigest", "type": "string", "info": "The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`.: string", "required": true, "schema": { "title": "subjectDigest", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposListAttestations" }, "task": true }, { "name": "reposListAutolinks", "summary": "repos/list-autolinks", "description": "Gets all autolinks that are configured for a repository.\n\nInformation about autolinks are only available to repository administrators.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposListAutolinks" }, "task": true }, { "name": "reposCreateAutolink", "summary": "repos/create-autolink", "description": "Users with admin access to the repository can create an autolink.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposCreateAutolink" }, "task": true }, { "name": "reposGetAutolink", "summary": "repos/get-autolink", "description": "This returns a single autolink reference by ID that was configured for the given repository.\n\nInformation about autolinks are only available to repository administrators.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "autolinkId", "type": "number", "info": "The unique identifier of the autolink.: 123", "required": true, "schema": { "title": "autolinkId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposGetAutolink" }, "task": true }, { "name": "reposDeleteAutolink", "summary": "repos/delete-autolink", "description": "This deletes a single autolink reference by ID that was configured for the given repository.\n\nInformation about autolinks are only available to repository administrators.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "autolinkId", "type": "number", "info": "The unique identifier of the autolink.: 123", "required": true, "schema": { "title": "autolinkId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposDeleteAutolink" }, "task": true }, { "name": "reposCheckAutomatedSecurityFixes", "summary": "repos/check-automated-security-fixes", "description": "Shows whether automated security fixes are enabled, disabled or paused for a repository. The authenticated user must have admin read access to the repository. For more information, see \"[Configuring automated security fixes](https://docs.github.com/articles/configuring-automated-security-fixes)\".", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposCheckAutomatedSecurityFixes" }, "task": true }, { "name": "reposEnableAutomatedSecurityFixes", "summary": "repos/enable-automated-security-fixes", "description": "Enables automated security fixes for a repository. The authenticated user must have admin access to the repository. For more information, see \"[Configuring automated security fixes](https://docs.github.com/articles/configuring-automated-security-fixes)\".", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposEnableAutomatedSecurityFixes" }, "task": true }, { "name": "reposDisableAutomatedSecurityFixes", "summary": "repos/disable-automated-security-fixes", "description": "Disables automated security fixes for a repository. The authenticated user must have admin access to the repository. For more information, see \"[Configuring automated security fixes](https://docs.github.com/articles/configuring-automated-security-fixes)\".", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposDisableAutomatedSecurityFixes" }, "task": true }, { "name": "getReposOwnerRepoBranchesQuery", "summary": "repos/list-branches", "description": "repos/list-branches", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "protectedParam", "type": "boolean", "info": "Setting to `true` returns only branches protected by branch protections or rulesets. When set to `false`, only unprotected branches are returned. Omitting this parameter ...(description truncated): boolean", "required": false, "schema": { "title": "protectedParam", "type": "boolean" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getReposOwnerRepoBranchesQuery" }, "task": true }, { "name": "reposGetBranchProtection", "summary": "repos/get-branch-protection", "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "branch", "type": "string", "info": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).: string", "required": true, "schema": { "title": "branch", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposGetBranchProtection" }, "task": true }, { "name": "reposUpdateBranchProtection", "summary": "repos/update-branch-protection", "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nProtecting a branch requires admin or owner permissions to the repository.\n\n> [!NOTE]\n> Passing new arrays of ...(description truncated)", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "branch", "type": "string", "info": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).: string", "required": true, "schema": { "title": "branch", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposUpdateBranchProtection" }, "task": true }, { "name": "reposDeleteBranchProtection", "summary": "repos/delete-branch-protection", "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "branch", "type": "string", "info": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).: string", "required": true, "schema": { "title": "branch", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposDeleteBranchProtection" }, "task": true }, { "name": "reposGetAdminBranchProtection", "summary": "repos/get-admin-branch-protection", "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "branch", "type": "string", "info": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).: string", "required": true, "schema": { "title": "branch", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposGetAdminBranchProtection" }, "task": true }, { "name": "reposSetAdminBranchProtection", "summary": "repos/set-admin-branch-protection", "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nAdding admin enforcement requires admin or owner permissions to the repository and branch protection to be ena...(description truncated)", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "branch", "type": "string", "info": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).: string", "required": true, "schema": { "title": "branch", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposSetAdminBranchProtection" }, "task": true }, { "name": "reposDeleteAdminBranchProtection", "summary": "repos/delete-admin-branch-protection", "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoving admin enforcement requires admin or owner permissions to the repository and branch protection to be e...(description truncated)", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "branch", "type": "string", "info": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).: string", "required": true, "schema": { "title": "branch", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposDeleteAdminBranchProtection" }, "task": true }, { "name": "reposGetPullRequestReviewProtection", "summary": "repos/get-pull-request-review-protection", "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "branch", "type": "string", "info": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).: string", "required": true, "schema": { "title": "branch", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposGetPullRequestReviewProtection" }, "task": true }, { "name": "reposUpdatePullRequestReviewProtection", "summary": "repos/update-pull-request-review-protection", "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nUpdating pull request review enforcement requires admin or owner permissions to the repository and branch prot...(description truncated)", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "branch", "type": "string", "info": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).: string", "required": true, "schema": { "title": "branch", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposUpdatePullRequestReviewProtection" }, "task": true }, { "name": "reposDeletePullRequestReviewProtection", "summary": "repos/delete-pull-request-review-protection", "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "branch", "type": "string", "info": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).: string", "required": true, "schema": { "title": "branch", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposDeletePullRequestReviewProtection" }, "task": true }, { "name": "reposGetCommitSignatureProtection", "summary": "repos/get-commit-signature-protection", "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to check wheth...(description truncated)", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "branch", "type": "string", "info": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).: string", "required": true, "schema": { "title": "branch", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposGetCommitSignatureProtection" }, "task": true }, { "name": "reposCreateCommitSignatureProtection", "summary": "repos/create-commit-signature-protection", "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to require sig...(description truncated)", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "branch", "type": "string", "info": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).: string", "required": true, "schema": { "title": "branch", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposCreateCommitSignatureProtection" }, "task": true }, { "name": "reposDeleteCommitSignatureProtection", "summary": "repos/delete-commit-signature-protection", "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to disable req...(description truncated)", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "branch", "type": "string", "info": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).: string", "required": true, "schema": { "title": "branch", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposDeleteCommitSignatureProtection" }, "task": true }, { "name": "reposGetStatusChecksProtection", "summary": "repos/get-status-checks-protection", "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "branch", "type": "string", "info": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).: string", "required": true, "schema": { "title": "branch", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposGetStatusChecksProtection" }, "task": true }, { "name": "reposUpdateStatusCheckProtection", "summary": "repos/update-status-check-protection", "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nUpdating required status checks requires admin or owner permissions to the repository and branch protection to...(description truncated)", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "branch", "type": "string", "info": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).: string", "required": true, "schema": { "title": "branch", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposUpdateStatusCheckProtection" }, "task": true }, { "name": "reposRemoveStatusCheckProtection", "summary": "repos/remove-status-check-protection", "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "branch", "type": "string", "info": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).: string", "required": true, "schema": { "title": "branch", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposRemoveStatusCheckProtection" }, "task": true }, { "name": "reposGetAllStatusCheckContexts", "summary": "repos/get-all-status-check-contexts", "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "branch", "type": "string", "info": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).: string", "required": true, "schema": { "title": "branch", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposGetAllStatusCheckContexts" }, "task": true }, { "name": "reposAddStatusCheckContexts", "summary": "repos/add-status-check-contexts", "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "branch", "type": "string", "info": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).: string", "required": true, "schema": { "title": "branch", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposAddStatusCheckContexts" }, "task": true }, { "name": "reposSetStatusCheckContexts", "summary": "repos/set-status-check-contexts", "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "branch", "type": "string", "info": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).: string", "required": true, "schema": { "title": "branch", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposSetStatusCheckContexts" }, "task": true }, { "name": "reposRemoveStatusCheckContexts", "summary": "repos/remove-status-check-contexts", "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "branch", "type": "string", "info": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).: string", "required": true, "schema": { "title": "branch", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposRemoveStatusCheckContexts" }, "task": true }, { "name": "reposGetAccessRestrictions", "summary": "repos/get-access-restrictions", "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists who has access to this protected branch.\n\n> [!NOTE]\n> Users, apps, and teams `restrictions` are only ava...(description truncated)", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "branch", "type": "string", "info": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).: string", "required": true, "schema": { "title": "branch", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposGetAccessRestrictions" }, "task": true }, { "name": "reposDeleteAccessRestrictions", "summary": "repos/delete-access-restrictions", "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nDisables the ability to restrict who can push to this branch.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "branch", "type": "string", "info": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).: string", "required": true, "schema": { "title": "branch", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposDeleteAccessRestrictions" }, "task": true }, { "name": "reposGetAppsWithAccessToProtectedBranch", "summary": "repos/get-apps-with-access-to-protected-branch", "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists the GitHub Apps that have push access to this branch. Only GitHub Apps that are installed on the reposit...(description truncated)", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "branch", "type": "string", "info": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).: string", "required": true, "schema": { "title": "branch", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposGetAppsWithAccessToProtectedBranch" }, "task": true }, { "name": "reposAddAppAccessRestrictions", "summary": "repos/add-app-access-restrictions", "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nGrants the specified apps push access for this branch. Only GitHub Apps that are installed on the repository a...(description truncated)", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "branch", "type": "string", "info": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).: string", "required": true, "schema": { "title": "branch", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposAddAppAccessRestrictions" }, "task": true }, { "name": "reposSetAppAccessRestrictions", "summary": "repos/set-app-access-restrictions", "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReplaces the list of apps that have push access to this branch. This removes all apps that previously had push...(description truncated)", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "branch", "type": "string", "info": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).: string", "required": true, "schema": { "title": "branch", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposSetAppAccessRestrictions" }, "task": true }, { "name": "reposRemoveAppAccessRestrictions", "summary": "repos/remove-app-access-restrictions", "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoves the ability of an app to push to this branch. Only GitHub Apps that are installed on the repository an...(description truncated)", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "branch", "type": "string", "info": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).: string", "required": true, "schema": { "title": "branch", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposRemoveAppAccessRestrictions" }, "task": true }, { "name": "reposGetTeamsWithAccessToProtectedBranch", "summary": "repos/get-teams-with-access-to-protected-branch", "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists the teams who have push access to this branch. The list includes child teams.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "branch", "type": "string", "info": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).: string", "required": true, "schema": { "title": "branch", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposGetTeamsWithAccessToProtectedBranch" }, "task": true }, { "name": "reposAddTeamAccessRestrictions", "summary": "repos/add-team-access-restrictions", "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nGrants the specified teams push access for this branch. You can also give push access to child teams.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "branch", "type": "string", "info": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).: string", "required": true, "schema": { "title": "branch", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposAddTeamAccessRestrictions" }, "task": true }, { "name": "reposSetTeamAccessRestrictions", "summary": "repos/set-team-access-restrictions", "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReplaces the list of teams that have push access to this branch. This removes all teams that previously had pu...(description truncated)", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "branch", "type": "string", "info": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).: string", "required": true, "schema": { "title": "branch", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposSetTeamAccessRestrictions" }, "task": true }, { "name": "reposRemoveTeamAccessRestrictions", "summary": "repos/remove-team-access-restrictions", "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoves the ability of a team to push to this branch. You can also remove push access for child teams.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "branch", "type": "string", "info": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).: string", "required": true, "schema": { "title": "branch", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposRemoveTeamAccessRestrictions" }, "task": true }, { "name": "reposGetUsersWithAccessToProtectedBranch", "summary": "repos/get-users-with-access-to-protected-branch", "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists the people who have push access to this branch.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "branch", "type": "string", "info": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).: string", "required": true, "schema": { "title": "branch", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposGetUsersWithAccessToProtectedBranch" }, "task": true }, { "name": "reposAddUserAccessRestrictions", "summary": "repos/add-user-access-restrictions", "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nGrants the specified people push access for this branch.\n\n| Type | Description ...(description truncated)", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "branch", "type": "string", "info": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).: string", "required": true, "schema": { "title": "branch", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposAddUserAccessRestrictions" }, "task": true }, { "name": "reposSetUserAccessRestrictions", "summary": "repos/set-user-access-restrictions", "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReplaces the list of people that have push access to this branch. This removes all people that previously had ...(description truncated)", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "branch", "type": "string", "info": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).: string", "required": true, "schema": { "title": "branch", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposSetUserAccessRestrictions" }, "task": true }, { "name": "reposRemoveUserAccessRestrictions", "summary": "repos/remove-user-access-restrictions", "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoves the ability of a user to push to this branch.\n\n| Type | Description ...(description truncated)", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "branch", "type": "string", "info": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).: string", "required": true, "schema": { "title": "branch", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposRemoveUserAccessRestrictions" }, "task": true }, { "name": "reposRenameBranch", "summary": "repos/rename-branch", "description": "Renames a branch in a repository.\n\n> [!NOTE]\n> Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see \"[Renaming a branch](https://docs.github.com/github/administering-a-repository/renaming-a-branch)\".\n\nThe authenticated user must have push access to the branch. If the branch is the default branch, the authenticate...(description truncated)", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "branch", "type": "string", "info": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).: string", "required": true, "schema": { "title": "branch", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposRenameBranch" }, "task": true }, { "name": "reposCodeownersErrors", "summary": "repos/codeowners-errors", "description": "List any syntax errors that are detected in the CODEOWNERS\nfile.\n\nFor more information about the correct CODEOWNERS syntax,\nsee \"[About code owners](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners).\"", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "ref", "type": "string", "info": "A branch, tag or commit name used to determine which version of the CODEOWNERS file to use. Default: the repository's default branch (e.g. `main`): string", "required": false, "schema": { "title": "ref", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposCodeownersErrors" }, "task": true }, { "name": "getReposOwnerRepoCollaboratorsQuery", "summary": "repos/list-collaborators", "description": "For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.\nOrganization members with write, maintain, or admin privileges on the organization-owned repository can use this endpoint.\n\nTeam members will include the members of child teams.\n\nThe authenticat...(description truncated)", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "affiliation", "type": "string", "info": "Filter collaborators returned by their affiliation. `outside` means all outside collaborators of an organization-owned repository. `direct` means all collaborators with p...(description truncated): ", "required": false, "schema": { "title": "affiliation", "type": "string" } }, { "name": "permission", "type": "string", "info": "Filter collaborators by the permissions they have on the repository. If not specified, all collaborators will be returned.: ", "required": false, "schema": { "title": "permission", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getReposOwnerRepoCollaboratorsQuery" }, "task": true }, { "name": "reposCheckCollaborator", "summary": "repos/check-collaborator", "description": "For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.\n\nTeam members will include the members of child teams.\n\nThe authenticated user must have push access to the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic...(description truncated)", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "username", "type": "string", "info": "The handle for the GitHub user account.: string", "required": true, "schema": { "title": "username", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposCheckCollaborator" }, "task": true }, { "name": "reposAddCollaborator", "summary": "repos/add-collaborator", "description": "This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the...(description truncated)", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "username", "type": "string", "info": "The handle for the GitHub user account.: string", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposAddCollaborator" }, "task": true }, { "name": "reposRemoveCollaborator", "summary": "repos/remove-collaborator", "description": "Removes a collaborator from a repository.\n\nTo use this endpoint, the authenticated user must either be an administrator of the repository or target themselves for removal.\n\nThis endpoint also:\n- Cancels any outstanding invitations\n- Unasigns the user from any issues\n- Removes access to organization projects if the user is not an organization member and is not a collaborator on any other organization repositories.\n- Unstars the repository\n- Updates access permissions to packages\n\nRemoving a user ...(description truncated)", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "username", "type": "string", "info": "The handle for the GitHub user account.: string", "required": true, "schema": { "title": "username", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposRemoveCollaborator" }, "task": true }, { "name": "reposGetCollaboratorPermissionLevel", "summary": "repos/get-collaborator-permission-level", "description": "Checks the repository permission of a collaborator. The possible repository\npermissions are `admin`, `write`, `read`, and `none`.\n\n*Note*: The `permission` attribute provides the legacy base roles of `admin`, `write`, `read`, and `none`, where the\n`maintain` role is mapped to `write` and the `triage` role is mapped to `read`. To determine the role assigned to the\ncollaborator, see the `role_name` attribute, which will provide the full role name, including custom roles. The\n`permissions` hash can...(description truncated)", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "username", "type": "string", "info": "The handle for the GitHub user account.: string", "required": true, "schema": { "title": "username", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposGetCollaboratorPermissionLevel" }, "task": true }, { "name": "getReposOwnerRepoCommentsQuery", "summary": "repos/list-commit-comments-for-repo", "description": "Lists the commit comments for a specified repository. Comments are ordered by ascending ID.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-com...(description truncated)", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getReposOwnerRepoCommentsQuery" }, "task": true }, { "name": "getReposOwnerRepoCommitsQuery", "summary": "repos/list-commits", "description": "**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table belo...(description truncated)", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "sha", "type": "string", "info": "SHA or branch to start listing commits from. Default: the repository’s default branch (usually `main`).: string", "required": false, "schema": { "title": "sha", "type": "string" } }, { "name": "pathParam", "type": "string", "info": "Only commits containing this file path will be returned.: string", "required": false, "schema": { "title": "pathParam", "type": "string" } }, { "name": "author", "type": "string", "info": "GitHub username or email address to use to filter by commit author.: string", "required": false, "schema": { "title": "author", "type": "string" } }, { "name": "committer", "type": "string", "info": "GitHub username or email address to use to filter by commit committer.: string", "required": false, "schema": { "title": "committer", "type": "string" } }, { "name": "since", "type": "string", "info": "Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. D...(description truncated): string", "required": false, "schema": { "title": "since", "type": "string" } }, { "name": "until", "type": "string", "info": "Only commits before this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Due to limitatio...(description truncated): string", "required": false, "schema": { "title": "until", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getReposOwnerRepoCommitsQuery" }, "task": true }, { "name": "reposListBranchesForHeadCommit", "summary": "repos/list-branches-for-head-commit", "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReturns all branches where the given commit SHA is the HEAD, or latest commit for the branch.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "commitSha", "type": "string", "info": "The SHA of the commit.: string", "required": true, "schema": { "title": "commitSha", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposListBranchesForHeadCommit" }, "task": true }, { "name": "getReposOwnerRepoCommitsShaCodeCommentsQuery", "summary": "repos/list-comments-for-commit", "description": "Lists the comments for a specified commit.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only repr...(description truncated)", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "shaCode", "type": "string", "info": "The SHA of the commit.: string", "required": true, "schema": { "title": "shaCode", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getReposOwnerRepoCommitsShaCodeCommentsQuery" }, "task": true }, { "name": "reposListPullRequestsAssociatedWithCommit", "summary": "repos/list-pull-requests-associated-with-commit", "description": "Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, will only return open pull requests associated with the commit.\n\nTo list the open or merged pull requests associated with a branch, you can set the `commit_sha` parameter to the branch name.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "shaCode", "type": "string", "info": "The SHA of the commit.: string", "required": true, "schema": { "title": "shaCode", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposListPullRequestsAssociatedWithCommit" }, "task": true }, { "name": "reposGetCommit", "summary": "repos/get-commit", "description": "Returns the contents of a single commit reference. You must have `read` access for the repository to use this endpoint.\n\n> [!NOTE]\n> If there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing.\n\nThis endpoint supports the following custom media types. For more in...(description truncated)", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "ref", "type": "string", "info": "The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see \"[Git References](https://git-scm.c...(description truncated): string", "required": true, "schema": { "title": "ref", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposGetCommit" }, "task": true }, { "name": "getReposOwnerRepoCommitsRefStatusQuery", "summary": "repos/get-combined-status-for-ref", "description": "Users with pull access in a repository can access a combined view of commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name.\n\n\nAdditionally, a combined `state` is returned. The `state` is one of:\n\n* **failure** if any of the contexts report as `error` or `failure`\n* **pending** if there are no statuses or a context is `pending`\n* **success** if the latest status for all contexts is `success`", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "ref", "type": "string", "info": "The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see \"[Git References](https://git-scm.c...(description truncated): string", "required": true, "schema": { "title": "ref", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getReposOwnerRepoCommitsRefStatusQuery" }, "task": true }, { "name": "reposListCommitStatusesForRef", "summary": "repos/list-commit-statuses-for-ref", "description": "Users with pull access in a repository can view commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name. Statuses are returned in reverse chronological order. The first status in the list will be the latest one.\n\nThis resource is also available via a legacy route: `GET /repos/:owner/:repo/statuses/:ref`.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "ref", "type": "string", "info": "The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see \"[Git References](https://git-scm.c...(description truncated): string", "required": true, "schema": { "title": "ref", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposListCommitStatusesForRef" }, "task": true }, { "name": "reposGetCommunityProfileMetrics", "summary": "repos/get-community-profile-metrics", "description": "Returns all community profile metrics for a repository. The repository cannot be a fork.\n\nThe returned metrics include an overall health score, the repository description, the presence of documentation, the\ndetected code of conduct, the detected license, and the presence of ISSUE\\_TEMPLATE, PULL\\_REQUEST\\_TEMPLATE,\nREADME, and CONTRIBUTING files.\n\nThe `health_percentage` score is defined as a percentage of how many of\nthe recommended community health files are present. For more information, see\n...(description truncated)", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposGetCommunityProfileMetrics" }, "task": true }, { "name": "getReposOwnerRepoCompareBaseIdHeadIdQuery", "summary": "repos/compare-commits", "description": "Compares two commits against one another. You can compare refs (branches or tags) and commit SHAs in the same repository, or you can compare refs and commit SHAs that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see \"[Understanding connections between repositories](https://docs.github.com/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-reposi...(description truncated)", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "baseId", "type": "string", "info": "", "required": true, "schema": { "title": "baseId", "type": "string" } }, { "name": "headId", "type": "string", "info": "", "required": true, "schema": { "title": "headId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getReposOwnerRepoCompareBaseIdHeadIdQuery" }, "task": true }, { "name": "reposGetContent", "summary": "repos/get-content", "description": "Gets the contents of a file or directory in a repository. Specify the file path or directory with the `path` parameter. If you omit the `path` parameter, you will receive the contents of the repository's root directory.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw file contents for files an...(description truncated)", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "pathParam", "type": "string", "info": "path parameter: string", "required": true, "schema": { "title": "pathParam", "type": "string" } }, { "name": "ref", "type": "string", "info": "The name of the commit/branch/tag. Default: the repository’s default branch.: string", "required": false, "schema": { "title": "ref", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposGetContent" }, "task": true }, { "name": "reposCreateOrUpdateFileContents", "summary": "repos/create-or-update-file-contents", "description": "Creates a new file or replaces an existing file in a repository.\n\n> [!NOTE]\n> If you use this endpoint and the \"[Delete a file](https://docs.github.com/rest/repos/contents/#delete-a-file)\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The `workflow` scope is also required in order to modify files in the `.gith...(description truncated)", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "pathParam", "type": "string", "info": "path parameter: string", "required": true, "schema": { "title": "pathParam", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposCreateOrUpdateFileContents" }, "task": true }, { "name": "reposDeleteFile", "summary": "repos/delete-file", "description": "Deletes a file in a repository.\n\nYou can provide an additional `committer` parameter, which is an object containing information about the committer. Or, you can provide an `author` parameter, which is an object containing information about the author.\n\nThe `author` section is optional and is filled in with the `committer` information if omitted. If the `committer` information is omitted, the authenticated user's information is used.\n\nYou must provide values for both `name` and `email`, whether y...(description truncated)", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "pathParam", "type": "string", "info": "path parameter: string", "required": true, "schema": { "title": "pathParam", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposDeleteFile" }, "task": true }, { "name": "getReposOwnerRepoContributorsQuery", "summary": "repos/list-contributors", "description": "Lists contributors to the specified repository and sorts them by the number of commits per contributor in descending order. This endpoint may return information that is a few hours old because the GitHub REST API caches contributor data to improve performance.\n\nGitHub identifies contributors by author email address. This endpoint groups contribution counts by GitHub user, which includes all associated email addresses. To improve performance, only the first 500 author email addresses in the repos...(description truncated)", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "anon", "type": "string", "info": "Set to `1` or `true` to include anonymous contributors in results.: string", "required": false, "schema": { "title": "anon", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getReposOwnerRepoContributorsQuery" }, "task": true }, { "name": "getReposOwnerRepoDeploymentsQuery", "summary": "repos/list-deployments", "description": "Simple filtering of deployments is available via query parameters:", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "sha", "type": "string", "info": "The SHA recorded at creation time.: string", "required": false, "schema": { "title": "sha", "type": "string" } }, { "name": "ref", "type": "string", "info": "The name of the ref. This can be a branch, tag, or SHA.: string", "required": false, "schema": { "title": "ref", "type": "string" } }, { "name": "task", "type": "string", "info": "The name of the task for the deployment (e.g., `deploy` or `deploy:migrations`).: string", "required": false, "schema": { "title": "task", "type": "string" } }, { "name": "environment", "type": "string", "info": "The name of the environment that was deployed to (e.g., `staging` or `production`).: string", "required": false, "schema": { "title": "environment", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getReposOwnerRepoDeploymentsQuery" }, "task": true }, { "name": "reposGetDeployment", "summary": "repos/get-deployment", "description": "repos/get-deployment", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "deploymentId", "type": "number", "info": "deployment_id parameter: 123", "required": true, "schema": { "title": "deploymentId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposGetDeployment" }, "task": true }, { "name": "reposDeleteDeployment", "summary": "repos/delete-deployment", "description": "If the repository only has one deployment, you can delete the deployment regardless of its status. If the repository has more than one deployment, you can only delete inactive deployments. This ensures that repositories with multiple deployments will always have an active deployment.\n\nTo set a deployment as inactive, you must:\n\n* Create a new deployment that is active so that the system has a record of the current state, then delete the previously active deployment.\n* Mark the active deploym...(description truncated)", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "deploymentId", "type": "number", "info": "deployment_id parameter: 123", "required": true, "schema": { "title": "deploymentId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposDeleteDeployment" }, "task": true }, { "name": "getReposOwnerRepoDeploymentsIdStatusesQuery", "summary": "repos/list-deployment-statuses", "description": "Users with pull access can view deployment statuses for a deployment:", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "deploymentId", "type": "number", "info": "deployment_id parameter: 123", "required": true, "schema": { "title": "deploymentId", "type": "number" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getReposOwnerRepoDeploymentsIdStatusesQuery" }, "task": true }, { "name": "reposGetDeploymentStatus", "summary": "repos/get-deployment-status", "description": "Users with pull access can view a deployment status for a deployment:", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "deploymentId", "type": "number", "info": "deployment_id parameter: 123", "required": true, "schema": { "title": "deploymentId", "type": "number" } }, { "name": "statusId", "type": "number", "info": ": 123", "required": true, "schema": { "title": "statusId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposGetDeploymentStatus" }, "task": true }, { "name": "reposCreateDispatchEvent", "summary": "repos/create-dispatch-event", "description": "You can use this endpoint to trigger a webhook event called `repository_dispatch` when you want activity that happens outside of GitHub to trigger a GitHub Actions workflow or GitHub App webhook. You must configure your GitHub Actions workflow or GitHub App to run when the `repository_dispatch` event occurs. For an example `repository_dispatch` webhook payload, see \"[RepositoryDispatchEvent](https://docs.github.com/webhooks/event-payloads/#repository_dispatch).\"\n\nThe `client_payload` parameter i...(description truncated)", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposCreateDispatchEvent" }, "task": true }, { "name": "reposGetAllEnvironments", "summary": "repos/get-all-environments", "description": "Lists the environments for a repository.\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposGetAllEnvironments" }, "task": true }, { "name": "reposGetEnvironment", "summary": "repos/get-environment", "description": "> [!NOTE]\n> To get information about name patterns that branches must match in order to deploy to this environment, see \"[Get a deployment branch policy](/rest/deployments/branch-policies#get-a-deployment-branch-policy).\"\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "environmentName", "type": "string", "info": "The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.: string", "required": true, "schema": { "title": "environmentName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposGetEnvironment" }, "task": true }, { "name": "reposCreateOrUpdateEnvironment", "summary": "repos/create-or-update-environment", "description": "Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see \"[Environments](/actions/reference/environments#environment-protection-rules).\"\n\n> [!NOTE]\n> To create or update name patterns that branches must match in order to deploy to this environment, see \"[Deployment branch policies](/rest/deployments/branch-policies).\"\n\n> [!NOTE]\n> To create or update secrets for an environment, see \"[GitHub Actions secrets](/r...(description truncated)", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "environmentName", "type": "string", "info": "The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.: string", "required": true, "schema": { "title": "environmentName", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposCreateOrUpdateEnvironment" }, "task": true }, { "name": "reposDeleteAnEnvironment", "summary": "repos/delete-an-environment", "description": "OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "environmentName", "type": "string", "info": "The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.: string", "required": true, "schema": { "title": "environmentName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposDeleteAnEnvironment" }, "task": true }, { "name": "reposListDeploymentBranchPolicies", "summary": "repos/list-deployment-branch-policies", "description": "Lists the deployment branch policies for an environment.\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "environmentName", "type": "string", "info": "The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.: string", "required": true, "schema": { "title": "environmentName", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposListDeploymentBranchPolicies" }, "task": true }, { "name": "reposCreateDeploymentBranchPolicy", "summary": "repos/create-deployment-branch-policy", "description": "Creates a deployment branch or tag policy for an environment.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "environmentName", "type": "string", "info": "The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.: string", "required": true, "schema": { "title": "environmentName", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposCreateDeploymentBranchPolicy" }, "task": true }, { "name": "reposGetDeploymentBranchPolicy", "summary": "repos/get-deployment-branch-policy", "description": "Gets a deployment branch or tag policy for an environment.\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "environmentName", "type": "string", "info": "The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.: string", "required": true, "schema": { "title": "environmentName", "type": "string" } }, { "name": "branchPolicyId", "type": "number", "info": "The unique identifier of the branch policy.: 123", "required": true, "schema": { "title": "branchPolicyId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposGetDeploymentBranchPolicy" }, "task": true }, { "name": "reposUpdateDeploymentBranchPolicy", "summary": "repos/update-deployment-branch-policy", "description": "Updates a deployment branch or tag policy for an environment.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "environmentName", "type": "string", "info": "The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.: string", "required": true, "schema": { "title": "environmentName", "type": "string" } }, { "name": "branchPolicyId", "type": "number", "info": "The unique identifier of the branch policy.: 123", "required": true, "schema": { "title": "branchPolicyId", "type": "number" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposUpdateDeploymentBranchPolicy" }, "task": true }, { "name": "reposDeleteDeploymentBranchPolicy", "summary": "repos/delete-deployment-branch-policy", "description": "Deletes a deployment branch or tag policy for an environment.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "environmentName", "type": "string", "info": "The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.: string", "required": true, "schema": { "title": "environmentName", "type": "string" } }, { "name": "branchPolicyId", "type": "number", "info": "The unique identifier of the branch policy.: 123", "required": true, "schema": { "title": "branchPolicyId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposDeleteDeploymentBranchPolicy" }, "task": true }, { "name": "reposGetAllDeploymentProtectionRules", "summary": "repos/get-all-deployment-protection-rules", "description": "Gets all custom deployment protection rules that are enabled for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see \"[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment).\"\n\nFor more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs...(description truncated)", "input": [ { "name": "environmentName", "type": "string", "info": "The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.: string", "required": true, "schema": { "title": "environmentName", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposGetAllDeploymentProtectionRules" }, "task": true }, { "name": "reposCreateDeploymentProtectionRule", "summary": "repos/create-deployment-protection-rule", "description": "Enable a custom deployment protection rule for an environment.\n\nThe authenticated user must have admin or owner permissions to the repository to use this endpoint.\n\nFor more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/rest/apps/apps#get-an-app).\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "input": [ { "name": "environmentName", "type": "string", "info": "The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.: string", "required": true, "schema": { "title": "environmentName", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposCreateDeploymentProtectionRule" }, "task": true }, { "name": "reposListCustomDeploymentRuleIntegrations", "summary": "repos/list-custom-deployment-rule-integrations", "description": "Gets all custom deployment protection rule integrations that are available for an environment.\n\nThe authenticated user must have admin or owner permissions to the repository to use this endpoint.\n\nFor more information about environments, see \"[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment).\"\n\nFor more information about the app that is providing this custom deployment rule, see \"[GET an app](https:/...(description truncated)", "input": [ { "name": "environmentName", "type": "string", "info": "The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.: string", "required": true, "schema": { "title": "environmentName", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposListCustomDeploymentRuleIntegrations" }, "task": true }, { "name": "reposGetCustomDeploymentProtectionRule", "summary": "repos/get-custom-deployment-protection-rule", "description": "Gets an enabled custom deployment protection rule for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see \"[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment).\"\n\nFor more information about the app that is providing this custom deployment rule, see [`GET /apps/{app_slug}`](https://docs.github.com/rest/apps/apps#get-an-app).\n\nOAuth...(description truncated)", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "environmentName", "type": "string", "info": "The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.: string", "required": true, "schema": { "title": "environmentName", "type": "string" } }, { "name": "protectionRuleId", "type": "number", "info": "The unique identifier of the protection rule.: 123", "required": true, "schema": { "title": "protectionRuleId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposGetCustomDeploymentProtectionRule" }, "task": true }, { "name": "reposDisableDeploymentProtectionRule", "summary": "repos/disable-deployment-protection-rule", "description": "Disables a custom deployment protection rule for an environment.\n\nThe authenticated user must have admin or owner permissions to the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "input": [ { "name": "environmentName", "type": "string", "info": "The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.: string", "required": true, "schema": { "title": "environmentName", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "protectionRuleId", "type": "number", "info": "The unique identifier of the protection rule.: 123", "required": true, "schema": { "title": "protectionRuleId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposDisableDeploymentProtectionRule" }, "task": true }, { "name": "getReposOwnerRepoForksQuery", "summary": "repos/list-forks", "description": "repos/list-forks", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "sort", "type": "string", "info": "The sort order. `stargazers` will sort by star count.: ", "required": false, "schema": { "title": "sort", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getReposOwnerRepoForksQuery" }, "task": true }, { "name": "getReposOwnerRepoHooksQuery", "summary": "repos/list-webhooks", "description": "Lists webhooks for a repository. `last response` may return null if there have not been any deliveries within 30 days.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getReposOwnerRepoHooksQuery" }, "task": true }, { "name": "reposGetWebhookConfigForRepo", "summary": "repos/get-webhook-config-for-repo", "description": "Returns the webhook configuration for a repository. To get more information about the webhook, including the `active` state and `events`, use \"[Get a repository webhook](/rest/webhooks/repos#get-a-repository-webhook).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:repo_hook` or `repo` scope to use this endpoint.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "hookId", "type": "number", "info": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.: 123", "required": true, "schema": { "title": "hookId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposGetWebhookConfigForRepo" }, "task": true }, { "name": "reposUpdateWebhookConfigForRepo", "summary": "repos/update-webhook-config-for-repo", "description": "Updates the webhook configuration for a repository. To update more information about the webhook, including the `active` state and `events`, use \"[Update a repository webhook](/rest/webhooks/repos#update-a-repository-webhook).\"\n\nOAuth app tokens and personal access tokens (classic) need the `write:repo_hook` or `repo` scope to use this endpoint.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "hookId", "type": "number", "info": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.: 123", "required": true, "schema": { "title": "hookId", "type": "number" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposUpdateWebhookConfigForRepo" }, "task": true }, { "name": "reposListWebhookDeliveries", "summary": "repos/list-webhook-deliveries", "description": "Returns a list of webhook deliveries for a webhook configured in a repository.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "hookId", "type": "number", "info": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.: 123", "required": true, "schema": { "title": "hookId", "type": "number" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "cursor", "type": "string", "info": "Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors.: string", "required": false, "schema": { "title": "cursor", "type": "string" } }, { "name": "redelivery", "type": "boolean", "info": ": boolean", "required": false, "schema": { "title": "redelivery", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposListWebhookDeliveries" }, "task": true }, { "name": "reposGetWebhookDelivery", "summary": "repos/get-webhook-delivery", "description": "Returns a delivery for a webhook configured in a repository.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "hookId", "type": "number", "info": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.: 123", "required": true, "schema": { "title": "hookId", "type": "number" } }, { "name": "deliveryId", "type": "number", "info": ": 123", "required": true, "schema": { "title": "deliveryId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposGetWebhookDelivery" }, "task": true }, { "name": "reposRedeliverWebhookDelivery", "summary": "repos/redeliver-webhook-delivery", "description": "Redeliver a webhook delivery for a webhook configured in a repository.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "hookId", "type": "number", "info": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.: 123", "required": true, "schema": { "title": "hookId", "type": "number" } }, { "name": "deliveryId", "type": "number", "info": ": 123", "required": true, "schema": { "title": "deliveryId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposRedeliverWebhookDelivery" }, "task": true }, { "name": "reposPingWebhook", "summary": "repos/ping-webhook", "description": "This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) to be sent to the hook.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "hookId", "type": "number", "info": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.: 123", "required": true, "schema": { "title": "hookId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposPingWebhook" }, "task": true }, { "name": "reposListInvitations", "summary": "repos/list-invitations", "description": "When authenticating as a user with admin rights to a repository, this endpoint will list all currently open repository invitations.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposListInvitations" }, "task": true }, { "name": "reposUpdateInvitation", "summary": "repos/update-invitation", "description": "repos/update-invitation", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "invitationId", "type": "number", "info": "The unique identifier of the invitation.: 123", "required": true, "schema": { "title": "invitationId", "type": "number" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposUpdateInvitation" }, "task": true }, { "name": "reposDeleteInvitation", "summary": "repos/delete-invitation", "description": "repos/delete-invitation", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "invitationId", "type": "number", "info": "The unique identifier of the invitation.: 123", "required": true, "schema": { "title": "invitationId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposDeleteInvitation" }, "task": true }, { "name": "getReposOwnerRepoKeysQuery", "summary": "repos/list-deploy-keys", "description": "repos/list-deploy-keys", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getReposOwnerRepoKeysQuery" }, "task": true }, { "name": "reposMergeUpstream", "summary": "repos/merge-upstream", "description": "Sync a branch of a forked repository to keep it up-to-date with the upstream repository.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposMergeUpstream" }, "task": true }, { "name": "reposGetPages", "summary": "repos/get-pages", "description": "Gets information about a GitHub Pages site.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposGetPages" }, "task": true }, { "name": "reposCreatePagesSite", "summary": "repos/create-pages-site", "description": "Configures a GitHub Pages site. For more information, see \"[About GitHub Pages](/github/working-with-github-pages/about-github-pages).\"\n\nThe authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposCreatePagesSite" }, "task": true }, { "name": "reposUpdateInformationAboutPagesSite", "summary": "repos/update-information-about-pages-site", "description": "Updates information for a GitHub Pages site. For more information, see \"[About GitHub Pages](/github/working-with-github-pages/about-github-pages).\n\nThe authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposUpdateInformationAboutPagesSite" }, "task": true }, { "name": "reposDeletePagesSite", "summary": "repos/delete-pages-site", "description": "Deletes a GitHub Pages site. For more information, see \"[About GitHub Pages](/github/working-with-github-pages/about-github-pages).\n\nThe authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposDeletePagesSite" }, "task": true }, { "name": "reposListPagesBuilds", "summary": "repos/list-pages-builds", "description": "Lists builts of a GitHub Pages site.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposListPagesBuilds" }, "task": true }, { "name": "reposRequestPagesBuild", "summary": "repos/request-pages-build", "description": "You can request that your site be built from the latest revision on the default branch. This has the same effect as pushing a commit to your default branch, but does not require an additional commit. Manually triggering page builds can be helpful when diagnosing build warnings and failures.\n\nBuild requests are limited to one concurrent build per repository and one concurrent build per requester. If you request a build while another is still in progress, the second request will be queued until th...(description truncated)", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposRequestPagesBuild" }, "task": true }, { "name": "reposGetLatestPagesBuild", "summary": "repos/get-latest-pages-build", "description": "Gets information about the single most recent build of a GitHub Pages site.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposGetLatestPagesBuild" }, "task": true }, { "name": "reposGetPagesBuild", "summary": "repos/get-pages-build", "description": "Gets information about a GitHub Pages build.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "buildId", "type": "number", "info": ": 123", "required": true, "schema": { "title": "buildId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposGetPagesBuild" }, "task": true }, { "name": "reposCreatePagesDeployment", "summary": "repos/create-pages-deployment", "description": "Create a GitHub Pages deployment for a repository.\n\nThe authenticated user must have write permission to the repository.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposCreatePagesDeployment" }, "task": true }, { "name": "reposGetPagesDeployment", "summary": "repos/get-pages-deployment", "description": "Gets the current status of a GitHub Pages deployment.\n\nThe authenticated user must have read permission for the GitHub Pages site.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "pagesDeploymentId", "type": "string", "info": "The ID of the Pages deployment. You can also give the commit SHA of the deployment.: ", "required": true, "schema": { "title": "pagesDeploymentId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposGetPagesDeployment" }, "task": true }, { "name": "reposCancelPagesDeployment", "summary": "repos/cancel-pages-deployment", "description": "Cancels a GitHub Pages deployment.\n\nThe authenticated user must have write permissions for the GitHub Pages site.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "pagesDeploymentId", "type": "string", "info": "The ID of the Pages deployment. You can also give the commit SHA of the deployment.: ", "required": true, "schema": { "title": "pagesDeploymentId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposCancelPagesDeployment" }, "task": true }, { "name": "reposGetPagesHealthCheck", "summary": "repos/get-pages-health-check", "description": "Gets a health check of the DNS settings for the `CNAME` record configured for a repository's GitHub Pages.\n\nThe first request to this endpoint returns a `202 Accepted` status and starts an asynchronous background task to get the results for the domain. After the background task completes, subsequent requests to this endpoint return a `200 OK` status with the health check results in the response.\n\nThe authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pa...(description truncated)", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposGetPagesHealthCheck" }, "task": true }, { "name": "reposCheckPrivateVulnerabilityReporting", "summary": "repos/check-private-vulnerability-reporting", "description": "Returns a boolean indicating whether or not private vulnerability reporting is enabled for the repository. For more information, see \"[Evaluating the security settings of a repository](https://docs.github.com/code-security/security-advisories/working-with-repository-security-advisories/evaluating-the-security-settings-of-a-repository)\".", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposCheckPrivateVulnerabilityReporting" }, "task": true }, { "name": "reposEnablePrivateVulnerabilityReporting", "summary": "repos/enable-private-vulnerability-reporting", "description": "Enables private vulnerability reporting for a repository. The authenticated user must have admin access to the repository. For more information, see \"[Privately reporting a security vulnerability](https://docs.github.com/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability).\"", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposEnablePrivateVulnerabilityReporting" }, "task": true }, { "name": "reposDisablePrivateVulnerabilityReporting", "summary": "repos/disable-private-vulnerability-reporting", "description": "Disables private vulnerability reporting for a repository. The authenticated user must have admin access to the repository. For more information, see \"[Privately reporting a security vulnerability](https://docs.github.com/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)\".", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposDisablePrivateVulnerabilityReporting" }, "task": true }, { "name": "reposGetCustomPropertiesValues", "summary": "repos/get-custom-properties-values", "description": "Gets all custom property values that are set for a repository.\nUsers with read access to the repository can use this endpoint.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposGetCustomPropertiesValues" }, "task": true }, { "name": "reposCreateOrUpdateCustomPropertiesValues", "summary": "repos/create-or-update-custom-properties-values", "description": "Create new or update existing custom property values for a repository.\nUsing a value of `null` for a custom property will remove or 'unset' the property value from the repository.\n\nRepository admins and other users with the repository-level \"edit custom property values\" fine-grained permission can use this endpoint.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposCreateOrUpdateCustomPropertiesValues" }, "task": true }, { "name": "reposGetReadmeInDirectory", "summary": "repos/get-readme-in-directory", "description": "Gets the README from a repository directory.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw file contents. This is the default if you do not specify a media type.\n- **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-so...(description truncated)", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "dir", "type": "string", "info": "The alternate path to look for a README file: string", "required": true, "schema": { "title": "dir", "type": "string" } }, { "name": "ref", "type": "string", "info": "The name of the commit/branch/tag. Default: the repository’s default branch.: string", "required": false, "schema": { "title": "ref", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposGetReadmeInDirectory" }, "task": true }, { "name": "getReposOwnerRepoReleasesQuery", "summary": "repos/list-releases", "description": "This returns a list of releases, which does not include regular Git tags that have not been associated with a release. To get a list of Git tags, use the [Repository Tags API](https://docs.github.com/rest/repos/repos#list-repository-tags).\n\nInformation about published releases are available to everyone. Only users with push access will receive listings for draft releases.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getReposOwnerRepoReleasesQuery" }, "task": true }, { "name": "reposGenerateReleaseNotes", "summary": "repos/generate-release-notes", "description": "Generate a name and body describing a [release](https://docs.github.com/rest/releases/releases#get-a-release). The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposGenerateReleaseNotes" }, "task": true }, { "name": "reposGetLatestRelease", "summary": "repos/get-latest-release", "description": "View the latest published full release for the repository.\n\nThe latest release is the most recent non-prerelease, non-draft release, sorted by the `created_at` attribute. The `created_at` attribute is the date of the commit used for the release, and not the date when the release was drafted or published.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposGetLatestRelease" }, "task": true }, { "name": "reposGetReleaseByTag", "summary": "repos/get-release-by-tag", "description": "Get a published release with the specified tag.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "tag", "type": "string", "info": "tag parameter: string", "required": true, "schema": { "title": "tag", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposGetReleaseByTag" }, "task": true }, { "name": "reposListReleaseAssetsQuery", "summary": "repos/list-release-assets", "description": "repos/list-release-assets", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "releaseId", "type": "number", "info": "The unique identifier of the release.: 123", "required": true, "schema": { "title": "releaseId", "type": "number" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposListReleaseAssetsQuery" }, "task": true }, { "name": "reposUploadReleaseAsset", "summary": "repos/upload-release-asset", "description": "This endpoint makes use of a [Hypermedia relation](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia) to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the `upload_url` returned in\nthe response of the [Create a release endpoint](https://docs.github.com/rest/releases/releases#create-a-release) to upload a release asset.\n\nYou need to use an HTTP client which supports [SNI](http://en.wikipedia...(description truncated)", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "releaseId", "type": "number", "info": "The unique identifier of the release.: 123", "required": true, "schema": { "title": "releaseId", "type": "number" } }, { "name": "name", "type": "string", "info": ": string", "required": true, "schema": { "title": "name", "type": "string" } }, { "name": "label", "type": "string", "info": ": string", "required": false, "schema": { "title": "label", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposUploadReleaseAsset" }, "task": true }, { "name": "reposGetBranchRules", "summary": "repos/get-branch-rules", "description": "Returns all active rules that apply to the specified branch. The branch does not need to exist; rules that would apply\nto a branch with that name will be returned. All active rules that apply will be returned, regardless of the level\nat which they are configured (e.g. repository or organization). Rules in rulesets with \"evaluate\" or \"disabled\"\nenforcement statuses are not returned.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "branch", "type": "string", "info": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).: string", "required": true, "schema": { "title": "branch", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposGetBranchRules" }, "task": true }, { "name": "reposGetRepoRulesets", "summary": "repos/get-repo-rulesets", "description": "Get all the rulesets for a repository.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "includesParents", "type": "boolean", "info": "Include rulesets configured at higher levels that apply to this repository: boolean", "required": false, "schema": { "title": "includesParents", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposGetRepoRulesets" }, "task": true }, { "name": "reposCreateRepoRuleset", "summary": "repos/create-repo-ruleset", "description": "Create a ruleset for a repository.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposCreateRepoRuleset" }, "task": true }, { "name": "reposGetRepoRuleSuites", "summary": "repos/get-repo-rule-suites", "description": "Lists suites of rule evaluations at the repository level.\nFor more information, see \"[Managing rulesets for a repository](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#viewing-insights-for-rulesets).\"", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "ref", "type": "string", "info": "The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit to tags. Omit the prefix to se...(description truncated): string", "required": false, "schema": { "title": "ref", "type": "string" } }, { "name": "timePeriod", "type": "string", "info": "The time period to filter by.\n\nFor example, `day` will filter for rule suites that occurred in the past 24 hours, and `week` will filter for insights that occurred in the...(description truncated): ", "required": false, "schema": { "title": "timePeriod", "type": "string" } }, { "name": "actorName", "type": "string", "info": "The handle for the GitHub user account to filter on. When specified, only rule evaluations triggered by this actor will be returned.: string", "required": false, "schema": { "title": "actorName", "type": "string" } }, { "name": "ruleSuiteResult", "type": "string", "info": "The rule results to filter on. When specified, only suites with this result will be returned.: ", "required": false, "schema": { "title": "ruleSuiteResult", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposGetRepoRuleSuites" }, "task": true }, { "name": "reposGetRepoRuleSuite", "summary": "repos/get-repo-rule-suite", "description": "Gets information about a suite of rule evaluations from within a repository.\nFor more information, see \"[Managing rulesets for a repository](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#viewing-insights-for-rulesets).\"", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "ruleSuiteId", "type": "number", "info": "The unique identifier of the rule suite result.\nTo get this ID, you can use [GET /repos/{owner}/{repo}/rulesets/rule-suites](https://docs.github.com/rest/repos/rule-suite...(description truncated): 123", "required": true, "schema": { "title": "ruleSuiteId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposGetRepoRuleSuite" }, "task": true }, { "name": "reposGetRepoRuleset", "summary": "repos/get-repo-ruleset", "description": "Get a ruleset for a repository.\n\n**Note:** To prevent leaking sensitive information, the `bypass_actors` property is only returned if the user\nmaking the API request has write access to the ruleset.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "rulesetId", "type": "number", "info": "The ID of the ruleset.: 123", "required": true, "schema": { "title": "rulesetId", "type": "number" } }, { "name": "includesParents", "type": "boolean", "info": "Include rulesets configured at higher levels that apply to this repository: boolean", "required": false, "schema": { "title": "includesParents", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposGetRepoRuleset" }, "task": true }, { "name": "reposUpdateRepoRuleset", "summary": "repos/update-repo-ruleset", "description": "Update a ruleset for a repository.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "rulesetId", "type": "number", "info": "The ID of the ruleset.: 123", "required": true, "schema": { "title": "rulesetId", "type": "number" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposUpdateRepoRuleset" }, "task": true }, { "name": "reposDeleteRepoRuleset", "summary": "repos/delete-repo-ruleset", "description": "Delete a ruleset for a repository.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "rulesetId", "type": "number", "info": "The ID of the ruleset.: 123", "required": true, "schema": { "title": "rulesetId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposDeleteRepoRuleset" }, "task": true }, { "name": "reposCreateCommitStatus", "summary": "repos/create-commit-status", "description": "Users with push access in a repository can create commit statuses for a given SHA.\n\nNote: there is a limit of 1000 statuses per `sha` and `context` within a repository. Attempts to create more than 1000 statuses will result in a validation error.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "sha", "type": "string", "info": ": string", "required": true, "schema": { "title": "sha", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposCreateCommitStatus" }, "task": true }, { "name": "getReposOwnerRepoTagsQuery", "summary": "repos/list-tags", "description": "repos/list-tags", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getReposOwnerRepoTagsQuery" }, "task": true }, { "name": "reposListTagProtection", "summary": "repos/list-tag-protection", "description": "> [!WARNING]\n> **Deprecation notice:** This operation is deprecated and will be removed after August 30, 2024. Use the \"[Repository Rulesets](https://docs.github.com/rest/repos/rules#get-all-repository-rulesets)\" endpoint instead.\n\nThis returns the tag protection states of a repository.\n\nThis information is only available to repository administrators.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposListTagProtection" }, "task": true }, { "name": "reposCreateTagProtection", "summary": "repos/create-tag-protection", "description": "> [!WARNING]\n> **Deprecation notice:** This operation is deprecated and will be removed after August 30, 2024. Use the \"[Repository Rulesets](https://docs.github.com/rest/repos/rules#create-a-repository-ruleset)\" endpoint instead.\n\nThis creates a tag protection state for a repository.\nThis endpoint is only available to repository administrators.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposCreateTagProtection" }, "task": true }, { "name": "reposDeleteTagProtection", "summary": "repos/delete-tag-protection", "description": "> [!WARNING]\n> **Deprecation notice:** This operation is deprecated and will be removed after August 30, 2024. Use the \"[Repository Rulesets](https://docs.github.com/rest/repos/rules#delete-a-repository-ruleset)\" endpoint instead.\n\nThis deletes a tag protection state for a repository.\nThis endpoint is only available to repository administrators.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "tagProtectionId", "type": "number", "info": "The unique identifier of the tag protection.: 123", "required": true, "schema": { "title": "tagProtectionId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposDeleteTagProtection" }, "task": true }, { "name": "reposDownloadTarballArchive", "summary": "repos/download-tarball-archive", "description": "Gets a redirect URL to download a tar archive for a repository. If you omit `:ref`, the repository’s default branch (usually\n`main`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe `Location` header to make a second `GET` request.\n\n> [!NOTE]\n> For private repositories, these links are temporary and expire after five minutes.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "ref", "type": "string", "info": ": string", "required": true, "schema": { "title": "ref", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposDownloadTarballArchive" }, "task": true }, { "name": "getReposOwnerRepoTeamsQuery", "summary": "repos/list-teams", "description": "Lists the teams that have access to the specified repository and that are also visible to the authenticated user.\n\nFor a public repository, a team is listed only if that team added the public repository explicitly.\n\nOAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to use this endpoint with a public repository, and `repo` scope to use this endpoint with a private repository.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getReposOwnerRepoTeamsQuery" }, "task": true }, { "name": "reposGetAllTopics", "summary": "repos/get-all-topics", "description": "repos/get-all-topics", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposGetAllTopics" }, "task": true }, { "name": "reposReplaceAllTopics", "summary": "repos/replace-all-topics", "description": "repos/replace-all-topics", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposReplaceAllTopics" }, "task": true }, { "name": "reposGetClones", "summary": "repos/get-clones", "description": "Get the total number of clones and breakdown per day or week for the last 14 days. Timestamps are aligned to UTC midnight of the beginning of the day or week. Week begins on Monday.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "per", "type": "string", "info": "The time frame to display results for.: ", "required": false, "schema": { "title": "per", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposGetClones" }, "task": true }, { "name": "reposGetTopPaths", "summary": "repos/get-top-paths", "description": "Get the top 10 popular contents over the last 14 days.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposGetTopPaths" }, "task": true }, { "name": "reposGetTopReferrers", "summary": "repos/get-top-referrers", "description": "Get the top 10 referrers over the last 14 days.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposGetTopReferrers" }, "task": true }, { "name": "reposGetViews", "summary": "repos/get-views", "description": "Get the total number of views and breakdown per day or week for the last 14 days. Timestamps are aligned to UTC midnight of the beginning of the day or week. Week begins on Monday.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "per", "type": "string", "info": "The time frame to display results for.: ", "required": false, "schema": { "title": "per", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposGetViews" }, "task": true }, { "name": "reposTransfer", "summary": "repos/transfer", "description": "A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original `owner`, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see [about repository transfers](https://docs.github.com/articles/about-repository-transfers/).", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposTransfer" }, "task": true }, { "name": "reposCheckVulnerabilityAlerts", "summary": "repos/check-vulnerability-alerts", "description": "Shows whether dependency alerts are enabled or disabled for a repository. The authenticated user must have admin read access to the repository. For more information, see \"[About security alerts for vulnerable dependencies](https://docs.github.com/articles/about-security-alerts-for-vulnerable-dependencies)\".", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposCheckVulnerabilityAlerts" }, "task": true }, { "name": "reposEnableVulnerabilityAlerts", "summary": "repos/enable-vulnerability-alerts", "description": "Enables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see \"[About security alerts for vulnerable dependencies](https://docs.github.com/articles/about-security-alerts-for-vulnerable-dependencies)\".", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposEnableVulnerabilityAlerts" }, "task": true }, { "name": "reposDisableVulnerabilityAlerts", "summary": "repos/disable-vulnerability-alerts", "description": "Disables dependency alerts and the dependency graph for a repository.\nThe authenticated user must have admin access to the repository. For more information,\nsee \"[About security alerts for vulnerable dependencies](https://docs.github.com/articles/about-security-alerts-for-vulnerable-dependencies)\".", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposDisableVulnerabilityAlerts" }, "task": true }, { "name": "reposDownloadZipballArchive", "summary": "repos/download-zipball-archive", "description": "Gets a redirect URL to download a zip archive for a repository. If you omit `:ref`, the repository’s default branch (usually\n`main`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe `Location` header to make a second `GET` request.\n\n> [!NOTE]\n> For private repositories, these links are temporary and expire after five minutes. If the repository is empty, you will receive a 404 when you follow the redirect.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "ref", "type": "string", "info": ": string", "required": true, "schema": { "title": "ref", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposDownloadZipballArchive" }, "task": true }, { "name": "reposCreateUsingTemplate", "summary": "repos/create-using-template", "description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. If the repository is not public, the authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/rest/repos/repos#get-a-repository) endpoint and check that the ...(description truncated)", "input": [ { "name": "templateOwner", "type": "string", "info": "The account owner of the template repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "templateOwner", "type": "string" } }, { "name": "templateRepo", "type": "string", "info": "The name of the template repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "templateRepo", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposCreateUsingTemplate" }, "task": true }, { "name": "reposListInvitationsForAuthenticatedUser", "summary": "repos/list-invitations-for-authenticated-user", "description": "When authenticating as a user, this endpoint will list all currently open repository invitations for that user.", "input": [ { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposListInvitationsForAuthenticatedUser" }, "task": true }, { "name": "reposAcceptInvitationForAuthenticatedUser", "summary": "repos/accept-invitation-for-authenticated-user", "description": "repos/accept-invitation-for-authenticated-user", "input": [ { "name": "invitationId", "type": "number", "info": "The unique identifier of the invitation.: 123", "required": true, "schema": { "title": "invitationId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposAcceptInvitationForAuthenticatedUser" }, "task": true }, { "name": "reposDeclineInvitationForAuthenticatedUser", "summary": "repos/decline-invitation-for-authenticated-user", "description": "repos/decline-invitation-for-authenticated-user", "input": [ { "name": "invitationId", "type": "number", "info": "The unique identifier of the invitation.: 123", "required": true, "schema": { "title": "invitationId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reposDeclineInvitationForAuthenticatedUser" }, "task": true }, { "name": "getUserStarredQuery", "summary": "activity/list-repos-starred-by-authenticated-user", "description": "Lists repositories the authenticated user has starred.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created.", "input": [ { "name": "sort", "type": "string", "info": "The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed to.: ", "required": false, "schema": { "title": "sort", "type": "string" } }, { "name": "direction", "type": "string", "info": "The direction to sort the results by.: ", "required": false, "schema": { "title": "direction", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getUserStarredQuery" }, "task": true }, { "name": "getUserSubscriptionsQuery", "summary": "activity/list-watched-repos-for-authenticated-user", "description": "Lists repositories the authenticated user is watching.", "input": [ { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getUserSubscriptionsQuery" }, "task": true }, { "name": "getUserIssuesQuery", "summary": "issues/list-for-authenticated-user", "description": "List issues across owned and member repositories assigned to the authenticated user.\n\n> [!NOTE]\n> GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull request id, use the \"[List pull requ...(description truncated)", "input": [ { "name": "filter", "type": "string", "info": "Indicates which sorts of issues to return. `assigned` means issues assigned to you. `created` means issues created by you. `mentioned` means issues mentioning you. `subsc...(description truncated): ", "required": false, "schema": { "title": "filter", "type": "string" } }, { "name": "state", "type": "string", "info": "Indicates the state of the issues to return.: ", "required": false, "schema": { "title": "state", "type": "string" } }, { "name": "labels", "type": "string", "info": "A list of comma separated label names. Example: `bug,ui,@high`: string", "required": false, "schema": { "title": "labels", "type": "string" } }, { "name": "sort", "type": "string", "info": "What to sort results by.: ", "required": false, "schema": { "title": "sort", "type": "string" } }, { "name": "direction", "type": "string", "info": "The direction to sort the results by.: ", "required": false, "schema": { "title": "direction", "type": "string" } }, { "name": "since", "type": "string", "info": "Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.: string", "required": false, "schema": { "title": "since", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getUserIssuesQuery" }, "task": true }, { "name": "getUserOrgsQuery", "summary": "orgs/list-for-authenticated-user", "description": "List organizations for the authenticated user.\n\nFor OAuth app tokens and personal access tokens (classic), this endpoint only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope for OAuth app tokens and personal access tokens (classic). Requests with insufficient scope will receive a...(description truncated)", "input": [ { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getUserOrgsQuery" }, "task": true }, { "name": "getUserReposQuery", "summary": "repos/list-for-authenticated-user", "description": "Lists repositories that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access.\n\nThe authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.", "input": [ { "name": "visibility", "type": "string", "info": "Limit results to repositories with the specified visibility.: ", "required": false, "schema": { "title": "visibility", "type": "string" } }, { "name": "affiliation", "type": "string", "info": "Comma-separated list of values. Can include: \n * `owner`: Repositories that are owned by the authenticated user. \n * `collaborator`: Repositories that the user has been...(description truncated): string", "required": false, "schema": { "title": "affiliation", "type": "string" } }, { "name": "type", "type": "string", "info": "Limit results to repositories of the specified type. Will cause a `422` error if used in the same request as **visibility** or **affiliation**.: ", "required": false, "schema": { "title": "type", "type": "string" } }, { "name": "sort", "type": "string", "info": "The property to sort the results by.: ", "required": false, "schema": { "title": "sort", "type": "string" } }, { "name": "direction", "type": "string", "info": "The order to sort by. Default: `asc` when using `full_name`, otherwise `desc`.: ", "required": false, "schema": { "title": "direction", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "since", "type": "string", "info": "Only show repositories updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.: string", "required": false, "schema": { "title": "since", "type": "string" } }, { "name": "before", "type": "string", "info": "Only show repositories updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.: string", "required": false, "schema": { "title": "before", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getUserReposQuery" }, "task": true }, { "name": "getUserTeamsQuery", "summary": "teams/list-for-authenticated-user", "description": "List all of the teams across all of the organizations to which the authenticated\nuser belongs.\n\nOAuth app tokens and personal access tokens (classic) need the `user`, `repo`, or `read:org` scope to use this endpoint.\n\nWhen using a fine-grained personal access token, the resource owner of the token must be a single organization, and the response will only include the teams from that organization.", "input": [ { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getUserTeamsQuery" }, "task": true }, { "name": "getUserEmailsQuery", "summary": "users/list-emails-for-authenticated-user", "description": "Lists all of your email addresses, and specifies which one is visible\nto the public.\n\nOAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint.", "input": [ { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getUserEmailsQuery" }, "task": true }, { "name": "getUserFollowersQuery", "summary": "users/list-followers-for-authenticated-user", "description": "Lists the people following the authenticated user.", "input": [ { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getUserFollowersQuery" }, "task": true }, { "name": "getUserFollowingQuery", "summary": "users/list-followed-by-authenticated-user", "description": "Lists the people who the authenticated user follows.", "input": [ { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getUserFollowingQuery" }, "task": true }, { "name": "getUserKeysQuery", "summary": "users/list-public-ssh-keys-for-authenticated-user", "description": "Lists the public SSH keys for the authenticated user's GitHub account.\n\nOAuth app tokens and personal access tokens (classic) need the `read:public_key` scope to use this endpoint.", "input": [ { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getUserKeysQuery" }, "task": true }, { "name": "getUsersUsernameEventsQuery", "summary": "activity/list-events-for-authenticated-user", "description": "If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events.\n\n> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "input": [ { "name": "username", "type": "string", "info": "The handle for the GitHub user account.: string", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getUsersUsernameEventsQuery" }, "task": true }, { "name": "getUsersUsernameEventsOrgsOrgQuery", "summary": "activity/list-org-events-for-authenticated-user", "description": "This is the user's organization dashboard. You must be authenticated as the user to view this.\n\n> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "input": [ { "name": "username", "type": "string", "info": "The handle for the GitHub user account.: string", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getUsersUsernameEventsOrgsOrgQuery" }, "task": true }, { "name": "getUsersUsernameReceivedEventsQuery", "summary": "activity/list-received-events-for-user", "description": "These are events that you've received by watching repositories and following users. If you are authenticated as the\ngiven user, you will see private events. Otherwise, you'll only see public events.\n\n> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "input": [ { "name": "username", "type": "string", "info": "The handle for the GitHub user account.: string", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getUsersUsernameReceivedEventsQuery" }, "task": true }, { "name": "getUsersUsernameReceivedEventsPublicQuery", "summary": "activity/list-received-public-events-for-user", "description": "> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "input": [ { "name": "username", "type": "string", "info": "The handle for the GitHub user account.: string", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getUsersUsernameReceivedEventsPublicQuery" }, "task": true }, { "name": "getUsersUsernameStarredQuery", "summary": "activity/list-repos-starred-by-user", "description": "Lists repositories a user has starred.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created.", "input": [ { "name": "username", "type": "string", "info": "The handle for the GitHub user account.: string", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "sort", "type": "string", "info": "The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed to.: ", "required": false, "schema": { "title": "sort", "type": "string" } }, { "name": "direction", "type": "string", "info": "The direction to sort the results by.: ", "required": false, "schema": { "title": "direction", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getUsersUsernameStarredQuery" }, "task": true }, { "name": "getUsersUsernameSubscriptionsQuery", "summary": "activity/list-repos-watched-by-user", "description": "Lists repositories a user is watching.", "input": [ { "name": "username", "type": "string", "info": "The handle for the GitHub user account.: string", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getUsersUsernameSubscriptionsQuery" }, "task": true }, { "name": "getUsersUsernameGistsQuery", "summary": "gists/list-for-user", "description": "Lists public gists for the specified user:", "input": [ { "name": "username", "type": "string", "info": "The handle for the GitHub user account.: string", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "since", "type": "string", "info": "Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.: string", "required": false, "schema": { "title": "since", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getUsersUsernameGistsQuery" }, "task": true }, { "name": "getUsersUsernameOrgsQuery", "summary": "orgs/list-for-user", "description": "List [public organization memberships](https://docs.github.com/articles/publicizing-or-concealing-organization-membership) for the specified user.\n\nThis method only lists _public_ memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the [List organizations for the authenticated user](https://docs.github.com/rest/orgs/orgs#list-organizations-for-the-authenticated-user) API instead.", "input": [ { "name": "username", "type": "string", "info": "The handle for the GitHub user account.: string", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getUsersUsernameOrgsQuery" }, "task": true }, { "name": "getUsersUsernameReposQuery", "summary": "repos/list-for-user", "description": "Lists public repositories for the specified user.", "input": [ { "name": "username", "type": "string", "info": "The handle for the GitHub user account.: string", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "type", "type": "string", "info": "Limit results to repositories of the specified type.: ", "required": false, "schema": { "title": "type", "type": "string" } }, { "name": "sort", "type": "string", "info": "The property to sort the results by.: ", "required": false, "schema": { "title": "sort", "type": "string" } }, { "name": "direction", "type": "string", "info": "The order to sort by. Default: `asc` when using `full_name`, otherwise `desc`.: ", "required": false, "schema": { "title": "direction", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getUsersUsernameReposQuery" }, "task": true }, { "name": "usersListBlockedByAuthenticatedUser", "summary": "users/list-blocked-by-authenticated-user", "description": "List the users you've blocked on your personal account.", "input": [ { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/usersListBlockedByAuthenticatedUser" }, "task": true }, { "name": "usersCheckBlocked", "summary": "users/check-blocked", "description": "Returns a 204 if the given user is blocked by the authenticated user. Returns a 404 if the given user is not blocked by the authenticated user, or if the given user account has been identified as spam by GitHub.", "input": [ { "name": "username", "type": "string", "info": "The handle for the GitHub user account.: string", "required": true, "schema": { "title": "username", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/usersCheckBlocked" }, "task": true }, { "name": "usersBlock", "summary": "users/block", "description": "Blocks the given user and returns a 204. If the authenticated user cannot block the given user a 422 is returned.", "input": [ { "name": "username", "type": "string", "info": "The handle for the GitHub user account.: string", "required": true, "schema": { "title": "username", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/usersBlock" }, "task": true }, { "name": "usersUnblock", "summary": "users/unblock", "description": "Unblocks the given user and returns a 204.", "input": [ { "name": "username", "type": "string", "info": "The handle for the GitHub user account.: string", "required": true, "schema": { "title": "username", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/usersUnblock" }, "task": true }, { "name": "usersSetPrimaryEmailVisibilityForAuthenticatedUser", "summary": "users/set-primary-email-visibility-for-authenticated-user", "description": "Sets the visibility for your primary email addresses.", "input": [ { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/usersSetPrimaryEmailVisibilityForAuthenticatedUser" }, "task": true }, { "name": "usersListGpgKeysForAuthenticatedUser", "summary": "users/list-gpg-keys-for-authenticated-user", "description": "Lists the current user's GPG keys.\n\nOAuth app tokens and personal access tokens (classic) need the `read:gpg_key` scope to use this endpoint.", "input": [ { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/usersListGpgKeysForAuthenticatedUser" }, "task": true }, { "name": "usersCreateGpgKeyForAuthenticatedUser", "summary": "users/create-gpg-key-for-authenticated-user", "description": "Adds a GPG key to the authenticated user's GitHub account.\n\nOAuth app tokens and personal access tokens (classic) need the `write:gpg_key` scope to use this endpoint.", "input": [ { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/usersCreateGpgKeyForAuthenticatedUser" }, "task": true }, { "name": "usersGetGpgKeyForAuthenticatedUser", "summary": "users/get-gpg-key-for-authenticated-user", "description": "View extended details for a single GPG key.\n\nOAuth app tokens and personal access tokens (classic) need the `read:gpg_key` scope to use this endpoint.", "input": [ { "name": "gpgKeyId", "type": "number", "info": "The unique identifier of the GPG key.: 123", "required": true, "schema": { "title": "gpgKeyId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/usersGetGpgKeyForAuthenticatedUser" }, "task": true }, { "name": "usersDeleteGpgKeyForAuthenticatedUser", "summary": "users/delete-gpg-key-for-authenticated-user", "description": "Removes a GPG key from the authenticated user's GitHub account.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:gpg_key` scope to use this endpoint.", "input": [ { "name": "gpgKeyId", "type": "number", "info": "The unique identifier of the GPG key.: 123", "required": true, "schema": { "title": "gpgKeyId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/usersDeleteGpgKeyForAuthenticatedUser" }, "task": true }, { "name": "usersListPublicEmailsForAuthenticatedUser", "summary": "users/list-public-emails-for-authenticated-user", "description": "Lists your publicly visible email address, which you can set with the\n[Set primary email visibility for the authenticated user](https://docs.github.com/rest/users/emails#set-primary-email-visibility-for-the-authenticated-user)\nendpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint.", "input": [ { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/usersListPublicEmailsForAuthenticatedUser" }, "task": true }, { "name": "usersListSocialAccountsForAuthenticatedUser", "summary": "users/list-social-accounts-for-authenticated-user", "description": "Lists all of your social accounts.", "input": [ { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/usersListSocialAccountsForAuthenticatedUser" }, "task": true }, { "name": "usersAddSocialAccountForAuthenticatedUser", "summary": "users/add-social-account-for-authenticated-user", "description": "Add one or more social accounts to the authenticated user's profile.\n\nOAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.", "input": [ { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/usersAddSocialAccountForAuthenticatedUser" }, "task": true }, { "name": "usersDeleteSocialAccountForAuthenticatedUser", "summary": "users/delete-social-account-for-authenticated-user", "description": "Deletes one or more social accounts from the authenticated user's profile.\n\nOAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/usersDeleteSocialAccountForAuthenticatedUser" }, "task": true }, { "name": "usersListSshSigningKeysForAuthenticatedUser", "summary": "users/list-ssh-signing-keys-for-authenticated-user", "description": "Lists the SSH signing keys for the authenticated user's GitHub account.\n\nOAuth app tokens and personal access tokens (classic) need the `read:ssh_signing_key` scope to use this endpoint.", "input": [ { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/usersListSshSigningKeysForAuthenticatedUser" }, "task": true }, { "name": "usersCreateSshSigningKeyForAuthenticatedUser", "summary": "users/create-ssh-signing-key-for-authenticated-user", "description": "Creates an SSH signing key for the authenticated user's GitHub account.\n\nOAuth app tokens and personal access tokens (classic) need the `write:ssh_signing_key` scope to use this endpoint.", "input": [ { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/usersCreateSshSigningKeyForAuthenticatedUser" }, "task": true }, { "name": "usersGetSshSigningKeyForAuthenticatedUser", "summary": "users/get-ssh-signing-key-for-authenticated-user", "description": "Gets extended details for an SSH signing key.\n\nOAuth app tokens and personal access tokens (classic) need the `read:ssh_signing_key` scope to use this endpoint.", "input": [ { "name": "sshSigningKeyId", "type": "number", "info": "The unique identifier of the SSH signing key.: 123", "required": true, "schema": { "title": "sshSigningKeyId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/usersGetSshSigningKeyForAuthenticatedUser" }, "task": true }, { "name": "usersDeleteSshSigningKeyForAuthenticatedUser", "summary": "users/delete-ssh-signing-key-for-authenticated-user", "description": "Deletes an SSH signing key from the authenticated user's GitHub account.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:ssh_signing_key` scope to use this endpoint.", "input": [ { "name": "sshSigningKeyId", "type": "number", "info": "The unique identifier of the SSH signing key.: 123", "required": true, "schema": { "title": "sshSigningKeyId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/usersDeleteSshSigningKeyForAuthenticatedUser" }, "task": true }, { "name": "usersGetById", "summary": "users/get-by-id", "description": "Provides publicly available information about someone with a GitHub account. This method takes their durable user `ID` instead of their `login`, which can change over time.\n\nThe `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address fo...(description truncated)", "input": [ { "name": "accountId", "type": "number", "info": "account_id parameter: 123", "required": true, "schema": { "title": "accountId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/usersGetById" }, "task": true }, { "name": "getUsersQuery", "summary": "users/list", "description": "Lists all users, in the order that they signed up on GitHub. This list includes personal user accounts and organization accounts.\n\nNote: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of users.", "input": [ { "name": "since", "type": "number", "info": "A user ID. Only return users with an ID greater than this ID.: 123", "required": false, "schema": { "title": "since", "type": "number" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getUsersQuery" }, "task": true }, { "name": "usersListAttestations", "summary": "users/list-attestations", "description": "List a collection of artifact attestations with a given subject digest that are associated with repositories owned by a user.\n\nThe collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required.\n\n**Please note...(description truncated)", "input": [ { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "before", "type": "string", "info": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches fo...(description truncated): string", "required": false, "schema": { "title": "before", "type": "string" } }, { "name": "after", "type": "string", "info": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches fo...(description truncated): string", "required": false, "schema": { "title": "after", "type": "string" } }, { "name": "username", "type": "string", "info": "The handle for the GitHub user account.: string", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "subjectDigest", "type": "string", "info": "Subject Digest: string", "required": true, "schema": { "title": "subjectDigest", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/usersListAttestations" }, "task": true }, { "name": "getUsersUsernameFollowersQuery", "summary": "users/list-followers-for-user", "description": "Lists the people following the specified user.", "input": [ { "name": "username", "type": "string", "info": "The handle for the GitHub user account.: string", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getUsersUsernameFollowersQuery" }, "task": true }, { "name": "usersListFollowingForUser", "summary": "users/list-following-for-user", "description": "Lists the people who the specified user follows.", "input": [ { "name": "username", "type": "string", "info": "The handle for the GitHub user account.: string", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/usersListFollowingForUser" }, "task": true }, { "name": "usersCheckFollowingForUser", "summary": "users/check-following-for-user", "description": "users/check-following-for-user", "input": [ { "name": "username", "type": "string", "info": "The handle for the GitHub user account.: string", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "targetUser", "type": "string", "info": ": string", "required": true, "schema": { "title": "targetUser", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/usersCheckFollowingForUser" }, "task": true }, { "name": "usersListGpgKeysForUser", "summary": "users/list-gpg-keys-for-user", "description": "Lists the GPG keys for a user. This information is accessible by anyone.", "input": [ { "name": "username", "type": "string", "info": "The handle for the GitHub user account.: string", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/usersListGpgKeysForUser" }, "task": true }, { "name": "usersGetContextForUser", "summary": "users/get-context-for-user", "description": "Provides hovercard information. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations.\n\n The `subject_type` and `subject_id` parameters provide context for the person's hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about `octocat` who owns the `Spoon-Knife` repository, you would use a `subject_type` value of `repository` and a `subject_id` value of `1300192` (the ID of ...(description truncated)", "input": [ { "name": "username", "type": "string", "info": "The handle for the GitHub user account.: string", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "subjectType", "type": "string", "info": "Identifies which additional information you'd like to receive about the person's hovercard. Can be `organization`, `repository`, `issue`, `pull_request`. **Required** whe...(description truncated): ", "required": false, "schema": { "title": "subjectType", "type": "string" } }, { "name": "subjectId", "type": "string", "info": "Uses the ID for the `subject_type` you specified. **Required** when using `subject_type`.: string", "required": false, "schema": { "title": "subjectId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/usersGetContextForUser" }, "task": true }, { "name": "getUsersUsernameKeysQuery", "summary": "users/list-public-keys-for-user", "description": "Lists the _verified_ public SSH keys for a user. This is accessible by anyone.", "input": [ { "name": "username", "type": "string", "info": "The handle for the GitHub user account.: string", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getUsersUsernameKeysQuery" }, "task": true }, { "name": "usersListSocialAccountsForUser", "summary": "users/list-social-accounts-for-user", "description": "Lists social media accounts for a user. This endpoint is accessible by anyone.", "input": [ { "name": "username", "type": "string", "info": "The handle for the GitHub user account.: string", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/usersListSocialAccountsForUser" }, "task": true }, { "name": "usersListSshSigningKeysForUser", "summary": "users/list-ssh-signing-keys-for-user", "description": "Lists the SSH signing keys for a user. This operation is accessible by anyone.", "input": [ { "name": "username", "type": "string", "info": "The handle for the GitHub user account.: string", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/usersListSshSigningKeysForUser" }, "task": true }, { "name": "appsGetAuthenticated", "summary": "apps/get-authenticated", "description": "Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the `installations_count` in the response. For more details about your app's installations, see the \"[List installations for the authenticated app](https://docs.github.com/rest/apps/apps#list-installations-for-the-authenticated-app)\" endpoint.\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#...(description truncated)", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/appsGetAuthenticated" }, "task": true }, { "name": "appsCreateFromManifest", "summary": "apps/create-from-manifest", "description": "Use this endpoint to complete the handshake necessary when implementing the [GitHub App Manifest flow](https://docs.github.com/apps/building-github-apps/creating-github-apps-from-a-manifest/). When you create a GitHub App with the manifest flow, you receive a temporary `code` used to retrieve the GitHub App's `id`, `pem` (private key), and `webhook_secret`.", "input": [ { "name": "code", "type": "string", "info": ": string", "required": true, "schema": { "title": "code", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/appsCreateFromManifest" }, "task": true }, { "name": "appsGetWebhookConfigForApp", "summary": "apps/get-webhook-config-for-app", "description": "Returns the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see \"[Creating a GitHub App](/developers/apps/creating-a-github-app).\"\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/appsGetWebhookConfigForApp" }, "task": true }, { "name": "appsUpdateWebhookConfigForApp", "summary": "apps/update-webhook-config-for-app", "description": "Updates the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see \"[Creating a GitHub App](/developers/apps/creating-a-github-app).\"\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", "input": [ { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/appsUpdateWebhookConfigForApp" }, "task": true }, { "name": "appsListWebhookDeliveries", "summary": "apps/list-webhook-deliveries", "description": "Returns a list of webhook deliveries for the webhook configured for a GitHub App.\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", "input": [ { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "cursor", "type": "string", "info": "Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors.: string", "required": false, "schema": { "title": "cursor", "type": "string" } }, { "name": "redelivery", "type": "boolean", "info": ": boolean", "required": false, "schema": { "title": "redelivery", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/appsListWebhookDeliveries" }, "task": true }, { "name": "appsGetWebhookDelivery", "summary": "apps/get-webhook-delivery", "description": "Returns a delivery for the webhook configured for a GitHub App.\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", "input": [ { "name": "deliveryId", "type": "number", "info": ": 123", "required": true, "schema": { "title": "deliveryId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/appsGetWebhookDelivery" }, "task": true }, { "name": "appsRedeliverWebhookDelivery", "summary": "apps/redeliver-webhook-delivery", "description": "Redeliver a delivery for the webhook configured for a GitHub App.\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", "input": [ { "name": "deliveryId", "type": "number", "info": ": 123", "required": true, "schema": { "title": "deliveryId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/appsRedeliverWebhookDelivery" }, "task": true }, { "name": "appsListInstallationRequestsForAuthenticatedApp", "summary": "apps/list-installation-requests-for-authenticated-app", "description": "Lists all the pending installation requests for the authenticated GitHub App.", "input": [ { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/appsListInstallationRequestsForAuthenticatedApp" }, "task": true }, { "name": "appsListInstallations", "summary": "apps/list-installations", "description": "The permissions the installation has are included under the `permissions` key.\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", "input": [ { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "since", "type": "string", "info": "Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.: string", "required": false, "schema": { "title": "since", "type": "string" } }, { "name": "outdated", "type": "string", "info": ": string", "required": false, "schema": { "title": "outdated", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/appsListInstallations" }, "task": true }, { "name": "appsGetInstallation", "summary": "apps/get-installation", "description": "Enables an authenticated GitHub App to find an installation's information using the installation id.\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", "input": [ { "name": "installationId", "type": "number", "info": "The unique identifier of the installation.: 123", "required": true, "schema": { "title": "installationId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/appsGetInstallation" }, "task": true }, { "name": "appsDeleteInstallation", "summary": "apps/delete-installation", "description": "Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the \"[Suspend an app installation](https://docs.github.com/rest/apps/apps#suspend-an-app-installation)\" endpoint.\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", "input": [ { "name": "installationId", "type": "number", "info": "The unique identifier of the installation.: 123", "required": true, "schema": { "title": "installationId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/appsDeleteInstallation" }, "task": true }, { "name": "appsCreateInstallationAccessToken", "summary": "apps/create-installation-access-token", "description": "Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of `401 - Unauthorized`, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access.\n\nOptionally, you can use the `repositories` or `...(description truncated)", "input": [ { "name": "installationId", "type": "number", "info": "The unique identifier of the installation.: 123", "required": true, "schema": { "title": "installationId", "type": "number" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/appsCreateInstallationAccessToken" }, "task": true }, { "name": "appsSuspendInstallation", "summary": "apps/suspend-installation", "description": "Suspends a GitHub App on a user, organization, or business account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub API or webhook events is blocked for that account.\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", "input": [ { "name": "installationId", "type": "number", "info": "The unique identifier of the installation.: 123", "required": true, "schema": { "title": "installationId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/appsSuspendInstallation" }, "task": true }, { "name": "appsUnsuspendInstallation", "summary": "apps/unsuspend-installation", "description": "Removes a GitHub App installation suspension.\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", "input": [ { "name": "installationId", "type": "number", "info": "The unique identifier of the installation.: 123", "required": true, "schema": { "title": "installationId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/appsUnsuspendInstallation" }, "task": true }, { "name": "appsDeleteAuthorization", "summary": "apps/delete-authorization", "description": "OAuth and GitHub application owners can revoke a grant for their application and a specific user. You must provide a valid OAuth `access_token` as an input parameter and the grant for the token's owner will be deleted.\nDeleting an application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the application authorizations settings screen within GitHub](ht...(description truncated)", "input": [ { "name": "clientId", "type": "string", "info": "The client ID of the GitHub app.: string", "required": true, "schema": { "title": "clientId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/appsDeleteAuthorization" }, "task": true }, { "name": "appsCheckToken", "summary": "apps/check-token", "description": "OAuth applications and GitHub applications with OAuth authorizations can use this API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. Invalid tokens will return `404 NOT FOUND`.", "input": [ { "name": "clientId", "type": "string", "info": "The client ID of the GitHub app.: string", "required": true, "schema": { "title": "clientId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/appsCheckToken" }, "task": true }, { "name": "appsResetToken", "summary": "apps/reset-token", "description": "OAuth applications and GitHub applications with OAuth authorizations can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the \"token\" property in the response because changes take effect immediately. Invalid tokens will return `404 NOT FOUND`.", "input": [ { "name": "clientId", "type": "string", "info": "The client ID of the GitHub app.: string", "required": true, "schema": { "title": "clientId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/appsResetToken" }, "task": true }, { "name": "appsDeleteToken", "summary": "apps/delete-token", "description": "OAuth or GitHub application owners can revoke a single token for an OAuth application or a GitHub application with an OAuth authorization.", "input": [ { "name": "clientId", "type": "string", "info": "The client ID of the GitHub app.: string", "required": true, "schema": { "title": "clientId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/appsDeleteToken" }, "task": true }, { "name": "appsScopeToken", "summary": "apps/scope-token", "description": "Use a non-scoped user access token to create a repository-scoped and/or permission-scoped user access token. You can specify\nwhich repositories the token can access and which permissions are granted to the\ntoken.\n\nInvalid tokens will return `404 NOT FOUND`.", "input": [ { "name": "clientId", "type": "string", "info": "The client ID of the GitHub app.: string", "required": true, "schema": { "title": "clientId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/appsScopeToken" }, "task": true }, { "name": "appsGetBySlug", "summary": "apps/get-by-slug", "description": "> [!NOTE]\n> The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`).", "input": [ { "name": "appSlug", "type": "string", "info": ": string", "required": true, "schema": { "title": "appSlug", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/appsGetBySlug" }, "task": true }, { "name": "appsListReposAccessibleToInstallation", "summary": "apps/list-repos-accessible-to-installation", "description": "List repositories that an app installation can access.", "input": [ { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/appsListReposAccessibleToInstallation" }, "task": true }, { "name": "appsRevokeInstallationAccessToken", "summary": "apps/revoke-installation-access-token", "description": "Revokes the installation token you're using to authenticate as an installation and access this endpoint.\n\nOnce an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the \"[Create an installation access token for an app](https://docs.github.com/rest/apps/apps#create-an-installation-access-token-for-an-app)\" endpoint.", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/appsRevokeInstallationAccessToken" }, "task": true }, { "name": "appsGetSubscriptionPlanForAccount", "summary": "apps/get-subscription-plan-for-account", "description": "Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.\n\nGitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/re...(description truncated)", "input": [ { "name": "accountId", "type": "number", "info": "account_id parameter: 123", "required": true, "schema": { "title": "accountId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/appsGetSubscriptionPlanForAccount" }, "task": true }, { "name": "appsListPlans", "summary": "apps/list-plans", "description": "Lists all plans that are part of your GitHub Marketplace listing.\n\nGitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint.", "input": [ { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/appsListPlans" }, "task": true }, { "name": "appsListAccountsForPlan", "summary": "apps/list-accounts-for-plan", "description": "Returns user and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.\n\nGitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-gith...(description truncated)", "input": [ { "name": "planId", "type": "number", "info": "The unique identifier of the plan.: 123", "required": true, "schema": { "title": "planId", "type": "number" } }, { "name": "sort", "type": "string", "info": "The property to sort the results by.: ", "required": false, "schema": { "title": "sort", "type": "string" } }, { "name": "direction", "type": "string", "info": "To return the oldest accounts first, set to `asc`. Ignored without the `sort` parameter.: ", "required": false, "schema": { "title": "direction", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/appsListAccountsForPlan" }, "task": true }, { "name": "appsGetSubscriptionPlanForAccountStubbed", "summary": "apps/get-subscription-plan-for-account-stubbed", "description": "Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.\n\nGitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/re...(description truncated)", "input": [ { "name": "accountId", "type": "number", "info": "account_id parameter: 123", "required": true, "schema": { "title": "accountId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/appsGetSubscriptionPlanForAccountStubbed" }, "task": true }, { "name": "appsListPlansStubbed", "summary": "apps/list-plans-stubbed", "description": "Lists all plans that are part of your GitHub Marketplace listing.\n\nGitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint.", "input": [ { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/appsListPlansStubbed" }, "task": true }, { "name": "appsListAccountsForPlanStubbed", "summary": "apps/list-accounts-for-plan-stubbed", "description": "Returns repository and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.\n\nGitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-...(description truncated)", "input": [ { "name": "planId", "type": "number", "info": "The unique identifier of the plan.: 123", "required": true, "schema": { "title": "planId", "type": "number" } }, { "name": "sort", "type": "string", "info": "The property to sort the results by.: ", "required": false, "schema": { "title": "sort", "type": "string" } }, { "name": "direction", "type": "string", "info": "To return the oldest accounts first, set to `asc`. Ignored without the `sort` parameter.: ", "required": false, "schema": { "title": "direction", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/appsListAccountsForPlanStubbed" }, "task": true }, { "name": "appsGetOrgInstallation", "summary": "apps/get-org-installation", "description": "Enables an authenticated GitHub App to find the organization's installation information.\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/appsGetOrgInstallation" }, "task": true }, { "name": "appsGetRepoInstallation", "summary": "apps/get-repo-installation", "description": "Enables an authenticated GitHub App to find the repository's installation information. The installation's account type will be either an organization or a user account, depending which account the repository belongs to.\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/appsGetRepoInstallation" }, "task": true }, { "name": "appsListInstallationsForAuthenticatedUser", "summary": "apps/list-installations-for-authenticated-user", "description": "Lists installations of your GitHub App that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access.\n\nThe authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.\n\nYou can find the permissions for the installation under the `permissions` key.", "input": [ { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/appsListInstallationsForAuthenticatedUser" }, "task": true }, { "name": "appsListInstallationReposForAuthenticatedUser", "summary": "apps/list-installation-repos-for-authenticated-user", "description": "List repositories that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access for an installation.\n\nThe authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.\n\nThe access the user has to each repository is included in the hash under the `permissions` key.", "input": [ { "name": "installationId", "type": "number", "info": "The unique identifier of the installation.: 123", "required": true, "schema": { "title": "installationId", "type": "number" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/appsListInstallationReposForAuthenticatedUser" }, "task": true }, { "name": "appsAddRepoToInstallationForAuthenticatedUser", "summary": "apps/add-repo-to-installation-for-authenticated-user", "description": "Add a single repository to an installation. The authenticated user must have admin access to the repository. \n\nThis endpoint only works for PATs (classic) with the `repo` scope.", "input": [ { "name": "installationId", "type": "number", "info": "The unique identifier of the installation.: 123", "required": true, "schema": { "title": "installationId", "type": "number" } }, { "name": "repositoryId", "type": "number", "info": "The unique identifier of the repository.: 123", "required": true, "schema": { "title": "repositoryId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/appsAddRepoToInstallationForAuthenticatedUser" }, "task": true }, { "name": "appsRemoveRepoFromInstallationForAuthenticatedUser", "summary": "apps/remove-repo-from-installation-for-authenticated-user", "description": "Remove a single repository from an installation. The authenticated user must have admin access to the repository. The installation must have the `repository_selection` of `selected`. \n\nThis endpoint only works for PATs (classic) with the `repo` scope.", "input": [ { "name": "installationId", "type": "number", "info": "The unique identifier of the installation.: 123", "required": true, "schema": { "title": "installationId", "type": "number" } }, { "name": "repositoryId", "type": "number", "info": "The unique identifier of the repository.: 123", "required": true, "schema": { "title": "repositoryId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/appsRemoveRepoFromInstallationForAuthenticatedUser" }, "task": true }, { "name": "appsListSubscriptionsForAuthenticatedUser", "summary": "apps/list-subscriptions-for-authenticated-user", "description": "Lists the active subscriptions for the authenticated user.", "input": [ { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/appsListSubscriptionsForAuthenticatedUser" }, "task": true }, { "name": "appsListSubscriptionsForAuthenticatedUserStubbed", "summary": "apps/list-subscriptions-for-authenticated-user-stubbed", "description": "Lists the active subscriptions for the authenticated user.", "input": [ { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/appsListSubscriptionsForAuthenticatedUserStubbed" }, "task": true }, { "name": "appsGetUserInstallation", "summary": "apps/get-user-installation", "description": "Enables an authenticated GitHub App to find the user’s installation information.\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", "input": [ { "name": "username", "type": "string", "info": "The handle for the GitHub user account.: string", "required": true, "schema": { "title": "username", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/appsGetUserInstallation" }, "task": true }, { "name": "billingGetGithubActionsBillingOrg", "summary": "billing/get-github-actions-billing-org", "description": "Gets the summary of the free and paid GitHub Actions minutes used.\n\nPaid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see \"[Managing billing for GitHub Actions](https://docs.github.com/gi...(description truncated)", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/billingGetGithubActionsBillingOrg" }, "task": true }, { "name": "billingGetGithubPackagesBillingOrg", "summary": "billing/get-github-packages-billing-org", "description": "Gets the free and paid storage used for GitHub Packages in gigabytes.\n\nPaid minutes only apply to packages stored for private repositories. For more information, see \"[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `admin:org` scope to use this endpoint.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/billingGetGithubPackagesBillingOrg" }, "task": true }, { "name": "billingGetSharedStorageBillingOrg", "summary": "billing/get-shared-storage-billing-org", "description": "Gets the estimated paid and estimated total storage used for GitHub Actions and GitHub Packages.\n\nPaid minutes only apply to packages stored for private repositories. For more information, see \"[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `admin:org` scope to use this endpoint.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/billingGetSharedStorageBillingOrg" }, "task": true }, { "name": "billingGetGithubActionsBillingUser", "summary": "billing/get-github-actions-billing-user", "description": "Gets the summary of the free and paid GitHub Actions minutes used.\n\nPaid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see \"[Managing billing for GitHub Actions](https://docs.github.com/gi...(description truncated)", "input": [ { "name": "username", "type": "string", "info": "The handle for the GitHub user account.: string", "required": true, "schema": { "title": "username", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/billingGetGithubActionsBillingUser" }, "task": true }, { "name": "billingGetGithubPackagesBillingUser", "summary": "billing/get-github-packages-billing-user", "description": "Gets the free and paid storage used for GitHub Packages in gigabytes.\n\nPaid minutes only apply to packages stored for private repositories. For more information, see \"[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.", "input": [ { "name": "username", "type": "string", "info": "The handle for the GitHub user account.: string", "required": true, "schema": { "title": "username", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/billingGetGithubPackagesBillingUser" }, "task": true }, { "name": "billingGetSharedStorageBillingUser", "summary": "billing/get-shared-storage-billing-user", "description": "Gets the estimated paid and estimated total storage used for GitHub Actions and GitHub Packages.\n\nPaid minutes only apply to packages stored for private repositories. For more information, see \"[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.", "input": [ { "name": "username", "type": "string", "info": "The handle for the GitHub user account.: string", "required": true, "schema": { "title": "username", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/billingGetSharedStorageBillingUser" }, "task": true }, { "name": "checksCreate", "summary": "checks/create", "description": "Creates a new check run for a specific commit in a repository.\n\nTo create a check run, you must use a GitHub App. OAuth apps and authenticated users are not able to create a check suite.\n\nIn a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs.\n\n> [!NOTE]\n> The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a bra...(description truncated)", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/checksCreate" }, "task": true }, { "name": "checksGet", "summary": "checks/get", "description": "Gets a single check run using its `id`.\n\n> [!NOTE]\n> The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "checkRunId", "type": "number", "info": "The unique identifier of the check run.: 123", "required": true, "schema": { "title": "checkRunId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/checksGet" }, "task": true }, { "name": "checksUpdate", "summary": "checks/update", "description": "Updates a check run for a specific commit in a repository.\n\n> [!NOTE]\n> The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nOAuth apps and personal access tokens (classic) cannot use this endpoint.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "checkRunId", "type": "number", "info": "The unique identifier of the check run.: 123", "required": true, "schema": { "title": "checkRunId", "type": "number" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/checksUpdate" }, "task": true }, { "name": "checksListAnnotations", "summary": "checks/list-annotations", "description": "Lists annotations for a check run using the annotation `id`.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "checkRunId", "type": "number", "info": "The unique identifier of the check run.: 123", "required": true, "schema": { "title": "checkRunId", "type": "number" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/checksListAnnotations" }, "task": true }, { "name": "checksRerequestRun", "summary": "checks/rerequest-run", "description": "Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared.\n\nFor more information about how to re-run GitHub Actions jobs, see \"[Re-run a job from a workflow run](https://docs.github.com/rest/actions/workflow-runs#...(description truncated)", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "checkRunId", "type": "number", "info": "The unique identifier of the check run.: 123", "required": true, "schema": { "title": "checkRunId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/checksRerequestRun" }, "task": true }, { "name": "checksCreateSuite", "summary": "checks/create-suite", "description": "Creates a check suite manually. By default, check suites are automatically created when you create a [check run](https://docs.github.com/rest/checks/runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using \"[Update repository preferences for check suites](https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites)\".\n\n> [!NOTE]\n> The Checks API only looks for pushes in the repository where the check s...(description truncated)", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/checksCreateSuite" }, "task": true }, { "name": "checksSetSuitesPreferences", "summary": "checks/set-suites-preferences", "description": "Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually [Create a check suite](https://docs.github.com/rest/checks/suites#create-a-check-suite).\nYou must have admin permissions in the repository to set preferences for check suites.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/checksSetSuitesPreferences" }, "task": true }, { "name": "checksGetSuite", "summary": "checks/get-suite", "description": "Gets a single check suite using its `id`.\n\n> [!NOTE]\n> The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "checkSuiteId", "type": "number", "info": "The unique identifier of the check suite.: 123", "required": true, "schema": { "title": "checkSuiteId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/checksGetSuite" }, "task": true }, { "name": "checksListForSuite", "summary": "checks/list-for-suite", "description": "Lists check runs for a check suite using its `id`.\n\n> [!NOTE]\n> The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "checkSuiteId", "type": "number", "info": "The unique identifier of the check suite.: 123", "required": true, "schema": { "title": "checkSuiteId", "type": "number" } }, { "name": "checkName", "type": "string", "info": "Returns check runs with the specified `name`.: string", "required": false, "schema": { "title": "checkName", "type": "string" } }, { "name": "status", "type": "string", "info": "Returns check runs with the specified `status`.: ", "required": false, "schema": { "title": "status", "type": "string" } }, { "name": "filter", "type": "string", "info": "Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs.: ", "required": false, "schema": { "title": "filter", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/checksListForSuite" }, "task": true }, { "name": "checksRerequestSuite", "summary": "checks/rerequest-suite", "description": "Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://docs.github.com/webhooks/event-payloads/#check_suite) event with the action `rerequested`. When a check suite is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared.\n\nOAuth apps and personal access tokens (classic) cannot use this endpoint.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "checkSuiteId", "type": "number", "info": "The unique identifier of the check suite.: 123", "required": true, "schema": { "title": "checkSuiteId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/checksRerequestSuite" }, "task": true }, { "name": "checksListForRef", "summary": "checks/list-for-ref", "description": "Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name.\n\n> [!NOTE]\n> The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nIf there are more than 1000 check suites on a single git reference, this endpoint will limit check runs to the 1000 most recent check suites. To iterate over all possible check r...(description truncated)", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "ref", "type": "string", "info": "The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see \"[Git References](https://git-scm.c...(description truncated): string", "required": true, "schema": { "title": "ref", "type": "string" } }, { "name": "checkName", "type": "string", "info": "Returns check runs with the specified `name`.: string", "required": false, "schema": { "title": "checkName", "type": "string" } }, { "name": "status", "type": "string", "info": "Returns check runs with the specified `status`.: ", "required": false, "schema": { "title": "status", "type": "string" } }, { "name": "filter", "type": "string", "info": "Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs.: ", "required": false, "schema": { "title": "filter", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "appId", "type": "number", "info": ": 123", "required": false, "schema": { "title": "appId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/checksListForRef" }, "task": true }, { "name": "checksListSuitesForRef", "summary": "checks/list-suites-for-ref", "description": "Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name.\n\n> [!NOTE]\n> The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "ref", "type": "string", "info": "The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see \"[Git References](https://git-scm.c...(description truncated): string", "required": true, "schema": { "title": "ref", "type": "string" } }, { "name": "appId", "type": "number", "info": "Filters check suites by GitHub App `id`.: 123", "required": false, "schema": { "title": "appId", "type": "number" } }, { "name": "checkName", "type": "string", "info": "Returns check runs with the specified `name`.: string", "required": false, "schema": { "title": "checkName", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/checksListSuitesForRef" }, "task": true }, { "name": "codeScanningListAlertsForOrg", "summary": "code-scanning/list-alerts-for-org", "description": "Lists code scanning alerts for the default branch for all eligible repositories in an organization. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nThe authenticated user must be an owner or security ...(description truncated)", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "toolName", "type": "string", "info": "The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both.: string", "required": false, "schema": { "title": "toolName", "type": "string" } }, { "name": "toolGuid", "type": "string", "info": "The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can spec...(description truncated): string", "required": false, "schema": { "title": "toolGuid", "type": "string" } }, { "name": "before", "type": "string", "info": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches fo...(description truncated): string", "required": false, "schema": { "title": "before", "type": "string" } }, { "name": "after", "type": "string", "info": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches fo...(description truncated): string", "required": false, "schema": { "title": "after", "type": "string" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "direction", "type": "string", "info": "The direction to sort the results by.: ", "required": false, "schema": { "title": "direction", "type": "string" } }, { "name": "state", "type": "string", "info": "If specified, only code scanning alerts with this state will be returned.: ", "required": false, "schema": { "title": "state", "type": "string" } }, { "name": "sort", "type": "string", "info": "The property by which to sort the results.: ", "required": false, "schema": { "title": "sort", "type": "string" } }, { "name": "severity", "type": "string", "info": "If specified, only code scanning alerts with this severity will be returned.: ", "required": false, "schema": { "title": "severity", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/codeScanningListAlertsForOrg" }, "task": true }, { "name": "codeScanningListAlertsForRepo", "summary": "code-scanning/list-alerts-for-repo", "description": "Lists code scanning alerts.\n\nThe response includes a `most_recent_instance` object.\nThis provides details of the most recent instance of this alert\nfor the default branch (or for the specified Git reference if you used `ref` in the request).\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "toolName", "type": "string", "info": "The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both.: string", "required": false, "schema": { "title": "toolName", "type": "string" } }, { "name": "toolGuid", "type": "string", "info": "The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can spec...(description truncated): string", "required": false, "schema": { "title": "toolGuid", "type": "string" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "ref", "type": "string", "info": "The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/ ` or simply ` `. To reference a pull request use `refs/...(description truncated): string", "required": false, "schema": { "title": "ref", "type": "string" } }, { "name": "direction", "type": "string", "info": "The direction to sort the results by.: ", "required": false, "schema": { "title": "direction", "type": "string" } }, { "name": "sort", "type": "string", "info": "The property by which to sort the results.: ", "required": false, "schema": { "title": "sort", "type": "string" } }, { "name": "state", "type": "string", "info": "If specified, only code scanning alerts with this state will be returned.: ", "required": false, "schema": { "title": "state", "type": "string" } }, { "name": "severity", "type": "string", "info": "If specified, only code scanning alerts with this severity will be returned.: ", "required": false, "schema": { "title": "severity", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/codeScanningListAlertsForRepo" }, "task": true }, { "name": "codeScanningGetAlert", "summary": "code-scanning/get-alert", "description": "Gets a single code scanning alert.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "alertNumber", "type": "number", "info": "The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `...(description truncated): 123", "required": true, "schema": { "title": "alertNumber", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/codeScanningGetAlert" }, "task": true }, { "name": "codeScanningUpdateAlert", "summary": "code-scanning/update-alert", "description": "Updates the status of a single code scanning alert.\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "alertNumber", "type": "number", "info": "The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `...(description truncated): 123", "required": true, "schema": { "title": "alertNumber", "type": "number" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/codeScanningUpdateAlert" }, "task": true }, { "name": "codeScanningListAlertInstances", "summary": "code-scanning/list-alert-instances", "description": "Lists all instances of the specified code scanning alert.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "alertNumber", "type": "number", "info": "The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `...(description truncated): 123", "required": true, "schema": { "title": "alertNumber", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "ref", "type": "string", "info": "The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/ ` or simply ` `. To reference a pull request use `refs/...(description truncated): string", "required": false, "schema": { "title": "ref", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/codeScanningListAlertInstances" }, "task": true }, { "name": "codeScanningListRecentAnalyses", "summary": "code-scanning/list-recent-analyses", "description": "Lists the details of all code scanning analyses for a repository,\nstarting with the most recent.\nThe response is paginated and you can use the `page` and `per_page` parameters\nto list the analyses you're interested in.\nBy default 30 analyses are listed per page.\n\nThe `rules_count` field in the response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand `0` is returned in this field.\n\n> [!WARNING]\n> **Deprecation notice:** The `tool_name`...(description truncated)", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "toolName", "type": "string", "info": "The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both.: string", "required": false, "schema": { "title": "toolName", "type": "string" } }, { "name": "toolGuid", "type": "string", "info": "The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can spec...(description truncated): string", "required": false, "schema": { "title": "toolGuid", "type": "string" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "ref", "type": "string", "info": "The Git reference for the analyses you want to list. The `ref` for a branch can be formatted either as `refs/heads/ ` or simply ` `. To reference a pull request use `refs...(description truncated): string", "required": false, "schema": { "title": "ref", "type": "string" } }, { "name": "sarifId", "type": "string", "info": "Filter analyses belonging to the same SARIF upload.: string", "required": false, "schema": { "title": "sarifId", "type": "string" } }, { "name": "direction", "type": "string", "info": "The direction to sort the results by.: ", "required": false, "schema": { "title": "direction", "type": "string" } }, { "name": "sort", "type": "string", "info": "The property by which to sort the results.: ", "required": false, "schema": { "title": "sort", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/codeScanningListRecentAnalyses" }, "task": true }, { "name": "codeScanningGetAnalysis", "summary": "code-scanning/get-analysis", "description": "Gets a specified code scanning analysis for a repository.\n\nThe default JSON response contains fields that describe the analysis.\nThis includes the Git reference and commit SHA to which the analysis relates,\nthe datetime of the analysis, the name of the code scanning tool,\nand the number of alerts.\n\nThe `rules_count` field in the default response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand `0` is returned in this field.\n\nThis endpo...(description truncated)", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "analysisId", "type": "number", "info": "The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` operation.: 123", "required": true, "schema": { "title": "analysisId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/codeScanningGetAnalysis" }, "task": true }, { "name": "codeScanningDeleteAnalysis", "summary": "code-scanning/delete-analysis", "description": "Deletes a specified code scanning analysis from a repository.\n\nYou can delete one analysis at a time.\nTo delete a series of analyses, start with the most recent analysis and work backwards.\nConceptually, the process is similar to the undo function in a text editor.\n\nWhen you list the analyses for a repository,\none or more will be identified as deletable in the response:\n\n```\n\"deletable\": true\n```\n\nAn analysis is deletable when it's the most recent in a set of analyses.\nTypically, a repository wi...(description truncated)", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "analysisId", "type": "number", "info": "The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` operation.: 123", "required": true, "schema": { "title": "analysisId", "type": "number" } }, { "name": "confirmDelete", "type": "string", "info": "Allow deletion if the specified analysis is the last in a set. If you attempt to delete the final analysis in a set without setting this parameter to `true`, you'll get a...(description truncated): string", "required": false, "schema": { "title": "confirmDelete", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/codeScanningDeleteAnalysis" }, "task": true }, { "name": "codeScanningListCodeqlDatabases", "summary": "code-scanning/list-codeql-databases", "description": "Lists the CodeQL databases that are available in a repository.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/codeScanningListCodeqlDatabases" }, "task": true }, { "name": "codeScanningGetCodeqlDatabase", "summary": "code-scanning/get-codeql-database", "description": "Gets a CodeQL database for a language in a repository.\n\nBy default this endpoint returns JSON metadata about the CodeQL database. To\ndownload the CodeQL database binary content, set the `Accept` header of the request\nto [`application/zip`](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types), and make sure\nyour HTTP client is configured to follow redirects or use the `Location` header\nto make a second request to get the redirect URL.\n\nOAuth app tokens an...(description truncated)", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "language", "type": "string", "info": "The language of the CodeQL database.: string", "required": true, "schema": { "title": "language", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/codeScanningGetCodeqlDatabase" }, "task": true }, { "name": "codeScanningCreateVariantAnalysis", "summary": "code-scanning/create-variant-analysis", "description": "Creates a new CodeQL variant analysis, which will run a CodeQL query against one or more repositories.\n\nGet started by learning more about [running CodeQL queries at scale with Multi-Repository Variant Analysis](https://docs.github.com/code-security/codeql-for-vs-code/getting-started-with-codeql-for-vs-code/running-codeql-queries-at-scale-with-multi-repository-variant-analysis).\n\nUse the `owner` and `repo` parameters in the URL to specify the controller repository that\nwill be used for running G...(description truncated)", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/codeScanningCreateVariantAnalysis" }, "task": true }, { "name": "codeScanningGetVariantAnalysis", "summary": "code-scanning/get-variant-analysis", "description": "Gets the summary of a CodeQL variant analysis.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "codeqlVariantAnalysisId", "type": "number", "info": "The unique identifier of the variant analysis.: 123", "required": true, "schema": { "title": "codeqlVariantAnalysisId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/codeScanningGetVariantAnalysis" }, "task": true }, { "name": "codeScanningGetVariantAnalysisRepoTask", "summary": "code-scanning/get-variant-analysis-repo-task", "description": "Gets the analysis status of a repository in a CodeQL variant analysis.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the controller repository.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "codeqlVariantAnalysisId", "type": "number", "info": "The ID of the variant analysis.: 123", "required": true, "schema": { "title": "codeqlVariantAnalysisId", "type": "number" } }, { "name": "repoOwner", "type": "string", "info": "The account owner of the variant analysis repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "repoOwner", "type": "string" } }, { "name": "repoName", "type": "string", "info": "The name of the variant analysis repository.: string", "required": true, "schema": { "title": "repoName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/codeScanningGetVariantAnalysisRepoTask" }, "task": true }, { "name": "codeScanningGetDefaultSetup", "summary": "code-scanning/get-default-setup", "description": "Gets a code scanning default setup configuration.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/codeScanningGetDefaultSetup" }, "task": true }, { "name": "codeScanningUpdateDefaultSetup", "summary": "code-scanning/update-default-setup", "description": "Updates a code scanning default setup configuration.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/codeScanningUpdateDefaultSetup" }, "task": true }, { "name": "codeScanningUploadSarif", "summary": "code-scanning/upload-sarif", "description": "Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. For troubleshooting information, see \"[Troubleshooting SARIF uploads](https://docs.github.com/code-security/code-scanning/troubleshooting-sarif).\"\n\nThere are two places where you can upload code scanning results.\n - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For mo...(description truncated)", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/codeScanningUploadSarif" }, "task": true }, { "name": "codeScanningGetSarif", "summary": "code-scanning/get-sarif", "description": "Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see \"[Get a code scanning analysis for a repository](/rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository).\"\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this en...(description truncated)", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "sarifId", "type": "string", "info": "The SARIF ID obtained after uploading.: string", "required": true, "schema": { "title": "sarifId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/codeScanningGetSarif" }, "task": true }, { "name": "codesOfConductGetAllCodesOfConduct", "summary": "codes-of-conduct/get-all-codes-of-conduct", "description": "Returns array of all GitHub's codes of conduct.", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/codesOfConductGetAllCodesOfConduct" }, "task": true }, { "name": "codesOfConductGetConductCode", "summary": "codes-of-conduct/get-conduct-code", "description": "Returns information about the specified GitHub code of conduct.", "input": [ { "name": "key", "type": "string", "info": ": string", "required": true, "schema": { "title": "key", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/codesOfConductGetConductCode" }, "task": true }, { "name": "dependabotListAlertsForEnterprise", "summary": "dependabot/list-alerts-for-enterprise", "description": "Lists Dependabot alerts for repositories that are owned by the specified enterprise.\n\nThe authenticated user must be a member of the enterprise to use this endpoint.\n\nAlerts are only returned for organizations in the enterprise for which you are an organization owner or a security manager. For more information about security managers, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-secur...(description truncated)", "input": [ { "name": "enterprise", "type": "string", "info": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.: string", "required": true, "schema": { "title": "enterprise", "type": "string" } }, { "name": "state", "type": "string", "info": "A comma-separated list of states. If specified, only alerts with these states will be returned.\n\nCan be: `auto_dismissed`, `dismissed`, `fixed`, `open`: string", "required": false, "schema": { "title": "state", "type": "string" } }, { "name": "severity", "type": "string", "info": "A comma-separated list of severities. If specified, only alerts with these severities will be returned.\n\nCan be: `low`, `medium`, `high`, `critical`: string", "required": false, "schema": { "title": "severity", "type": "string" } }, { "name": "ecosystem", "type": "string", "info": "A comma-separated list of ecosystems. If specified, only alerts for these ecosystems will be returned.\n\nCan be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `...(description truncated): string", "required": false, "schema": { "title": "ecosystem", "type": "string" } }, { "name": "packageParam", "type": "string", "info": "A comma-separated list of package names. If specified, only alerts for these packages will be returned.: string", "required": false, "schema": { "title": "packageParam", "type": "string" } }, { "name": "scope", "type": "string", "info": "The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned.: ", "required": false, "schema": { "title": "scope", "type": "string" } }, { "name": "sort", "type": "string", "info": "The property by which to sort the results.\n`created` means when the alert was created.\n`updated` means when the alert's state last changed.: ", "required": false, "schema": { "title": "sort", "type": "string" } }, { "name": "direction", "type": "string", "info": "The direction to sort the results by.: ", "required": false, "schema": { "title": "direction", "type": "string" } }, { "name": "before", "type": "string", "info": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches fo...(description truncated): string", "required": false, "schema": { "title": "before", "type": "string" } }, { "name": "after", "type": "string", "info": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches fo...(description truncated): string", "required": false, "schema": { "title": "after", "type": "string" } }, { "name": "first", "type": "number", "info": "**Deprecated**. The number of results per page (max 100), starting from the first matching result.\nThis parameter must not be used in combination with `last`.\nInstead, us...(description truncated): 123", "required": false, "schema": { "title": "first", "type": "number" } }, { "name": "last", "type": "number", "info": "**Deprecated**. The number of results per page (max 100), starting from the last matching result.\nThis parameter must not be used in combination with `first`.\nInstead, us...(description truncated): 123", "required": false, "schema": { "title": "last", "type": "number" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/dependabotListAlertsForEnterprise" }, "task": true }, { "name": "dependabotListAlertsForOrg", "summary": "dependabot/list-alerts-for-org", "description": "Lists Dependabot alerts for an organization.\n\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "state", "type": "string", "info": "A comma-separated list of states. If specified, only alerts with these states will be returned.\n\nCan be: `auto_dismissed`, `dismissed`, `fixed`, `open`: string", "required": false, "schema": { "title": "state", "type": "string" } }, { "name": "severity", "type": "string", "info": "A comma-separated list of severities. If specified, only alerts with these severities will be returned.\n\nCan be: `low`, `medium`, `high`, `critical`: string", "required": false, "schema": { "title": "severity", "type": "string" } }, { "name": "ecosystem", "type": "string", "info": "A comma-separated list of ecosystems. If specified, only alerts for these ecosystems will be returned.\n\nCan be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `...(description truncated): string", "required": false, "schema": { "title": "ecosystem", "type": "string" } }, { "name": "packageParam", "type": "string", "info": "A comma-separated list of package names. If specified, only alerts for these packages will be returned.: string", "required": false, "schema": { "title": "packageParam", "type": "string" } }, { "name": "scope", "type": "string", "info": "The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned.: ", "required": false, "schema": { "title": "scope", "type": "string" } }, { "name": "sort", "type": "string", "info": "The property by which to sort the results.\n`created` means when the alert was created.\n`updated` means when the alert's state last changed.: ", "required": false, "schema": { "title": "sort", "type": "string" } }, { "name": "direction", "type": "string", "info": "The direction to sort the results by.: ", "required": false, "schema": { "title": "direction", "type": "string" } }, { "name": "before", "type": "string", "info": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches fo...(description truncated): string", "required": false, "schema": { "title": "before", "type": "string" } }, { "name": "after", "type": "string", "info": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches fo...(description truncated): string", "required": false, "schema": { "title": "after", "type": "string" } }, { "name": "first", "type": "number", "info": "**Deprecated**. The number of results per page (max 100), starting from the first matching result.\nThis parameter must not be used in combination with `last`.\nInstead, us...(description truncated): 123", "required": false, "schema": { "title": "first", "type": "number" } }, { "name": "last", "type": "number", "info": "**Deprecated**. The number of results per page (max 100), starting from the last matching result.\nThis parameter must not be used in combination with `first`.\nInstead, us...(description truncated): 123", "required": false, "schema": { "title": "last", "type": "number" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/dependabotListAlertsForOrg" }, "task": true }, { "name": "dependabotListOrgSecrets", "summary": "dependabot/list-org-secrets", "description": "Lists all secrets available in an organization without revealing their\nencrypted values.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/dependabotListOrgSecrets" }, "task": true }, { "name": "dependabotGetOrgPublicKey", "summary": "dependabot/get-org-public-key", "description": "Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/dependabotGetOrgPublicKey" }, "task": true }, { "name": "dependabotGetOrgSecret", "summary": "dependabot/get-org-secret", "description": "Gets a single organization secret without revealing its encrypted value.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "secretName", "type": "string", "info": "The name of the secret.: string", "required": true, "schema": { "title": "secretName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/dependabotGetOrgSecret" }, "task": true }, { "name": "dependabotCreateOrUpdateOrgSecret", "summary": "dependabot/create-or-update-org-secret", "description": "Creates or updates an organization secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "secretName", "type": "string", "info": "The name of the secret.: string", "required": true, "schema": { "title": "secretName", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/dependabotCreateOrUpdateOrgSecret" }, "task": true }, { "name": "dependabotDeleteOrgSecret", "summary": "dependabot/delete-org-secret", "description": "Deletes a secret in an organization using the secret name.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "secretName", "type": "string", "info": "The name of the secret.: string", "required": true, "schema": { "title": "secretName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/dependabotDeleteOrgSecret" }, "task": true }, { "name": "dependabotListSelectedReposForOrgSecret", "summary": "dependabot/list-selected-repos-for-org-secret", "description": "Lists all repositories that have been selected when the `visibility`\nfor repository access to a secret is set to `selected`.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "secretName", "type": "string", "info": "The name of the secret.: string", "required": true, "schema": { "title": "secretName", "type": "string" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/dependabotListSelectedReposForOrgSecret" }, "task": true }, { "name": "dependabotSetSelectedReposForOrgSecret", "summary": "dependabot/set-selected-repos-for-org-secret", "description": "Replaces all repositories for an organization secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret).\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "secretName", "type": "string", "info": "The name of the secret.: string", "required": true, "schema": { "title": "secretName", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/dependabotSetSelectedReposForOrgSecret" }, "task": true }, { "name": "dependabotAddSelectedRepoToOrgSecret", "summary": "dependabot/add-selected-repo-to-org-secret", "description": "Adds a repository to an organization secret when the `visibility` for\nrepository access is set to `selected`. The visibility is set when you [Create or\nupdate an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret).\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "secretName", "type": "string", "info": "The name of the secret.: string", "required": true, "schema": { "title": "secretName", "type": "string" } }, { "name": "repositoryId", "type": "number", "info": ": 123", "required": true, "schema": { "title": "repositoryId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/dependabotAddSelectedRepoToOrgSecret" }, "task": true }, { "name": "dependabotRemoveSelectedRepoFromOrgSecret", "summary": "dependabot/remove-selected-repo-from-org-secret", "description": "Removes a repository from an organization secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret).\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "secretName", "type": "string", "info": "The name of the secret.: string", "required": true, "schema": { "title": "secretName", "type": "string" } }, { "name": "repositoryId", "type": "number", "info": ": 123", "required": true, "schema": { "title": "repositoryId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/dependabotRemoveSelectedRepoFromOrgSecret" }, "task": true }, { "name": "dependabotListAlertsForRepo", "summary": "dependabot/list-alerts-for-repo", "description": "OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "state", "type": "string", "info": "A comma-separated list of states. If specified, only alerts with these states will be returned.\n\nCan be: `auto_dismissed`, `dismissed`, `fixed`, `open`: string", "required": false, "schema": { "title": "state", "type": "string" } }, { "name": "severity", "type": "string", "info": "A comma-separated list of severities. If specified, only alerts with these severities will be returned.\n\nCan be: `low`, `medium`, `high`, `critical`: string", "required": false, "schema": { "title": "severity", "type": "string" } }, { "name": "ecosystem", "type": "string", "info": "A comma-separated list of ecosystems. If specified, only alerts for these ecosystems will be returned.\n\nCan be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `...(description truncated): string", "required": false, "schema": { "title": "ecosystem", "type": "string" } }, { "name": "packageParam", "type": "string", "info": "A comma-separated list of package names. If specified, only alerts for these packages will be returned.: string", "required": false, "schema": { "title": "packageParam", "type": "string" } }, { "name": "manifest", "type": "string", "info": "A comma-separated list of full manifest paths. If specified, only alerts for these manifests will be returned.: string", "required": false, "schema": { "title": "manifest", "type": "string" } }, { "name": "scope", "type": "string", "info": "The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned.: ", "required": false, "schema": { "title": "scope", "type": "string" } }, { "name": "sort", "type": "string", "info": "The property by which to sort the results.\n`created` means when the alert was created.\n`updated` means when the alert's state last changed.: ", "required": false, "schema": { "title": "sort", "type": "string" } }, { "name": "direction", "type": "string", "info": "The direction to sort the results by.: ", "required": false, "schema": { "title": "direction", "type": "string" } }, { "name": "page", "type": "number", "info": "**Deprecated**. Page number of the results to fetch. Use cursor-based pagination with `before` or `after` instead.: 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "before", "type": "string", "info": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches fo...(description truncated): string", "required": false, "schema": { "title": "before", "type": "string" } }, { "name": "after", "type": "string", "info": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches fo...(description truncated): string", "required": false, "schema": { "title": "after", "type": "string" } }, { "name": "first", "type": "number", "info": "**Deprecated**. The number of results per page (max 100), starting from the first matching result.\nThis parameter must not be used in combination with `last`.\nInstead, us...(description truncated): 123", "required": false, "schema": { "title": "first", "type": "number" } }, { "name": "last", "type": "number", "info": "**Deprecated**. The number of results per page (max 100), starting from the last matching result.\nThis parameter must not be used in combination with `first`.\nInstead, us...(description truncated): 123", "required": false, "schema": { "title": "last", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/dependabotListAlertsForRepo" }, "task": true }, { "name": "dependabotGetAlert", "summary": "dependabot/get-alert", "description": "OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "alertNumber", "type": "number", "info": "The number that identifies a Dependabot alert in its repository.\nYou can find this at the end of the URL for a Dependabot alert within GitHub,\nor in `number` fields in th...(description truncated): 123", "required": true, "schema": { "title": "alertNumber", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/dependabotGetAlert" }, "task": true }, { "name": "dependabotUpdateAlert", "summary": "dependabot/update-alert", "description": "The authenticated user must have access to security alerts for the repository to use this endpoint. For more information, see \"[Granting access to security alerts](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts).\"\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If th...(description truncated)", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "alertNumber", "type": "number", "info": "The number that identifies a Dependabot alert in its repository.\nYou can find this at the end of the URL for a Dependabot alert within GitHub,\nor in `number` fields in th...(description truncated): 123", "required": true, "schema": { "title": "alertNumber", "type": "number" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/dependabotUpdateAlert" }, "task": true }, { "name": "dependabotListRepoSecrets", "summary": "dependabot/list-repo-secrets", "description": "Lists all secrets available in a repository without revealing their encrypted\nvalues.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/dependabotListRepoSecrets" }, "task": true }, { "name": "dependabotGetRepoPublicKey", "summary": "dependabot/get-repo-public-key", "description": "Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets. Anyone with read access\nto the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint if the repository is private.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/dependabotGetRepoPublicKey" }, "task": true }, { "name": "dependabotGetRepoSecret", "summary": "dependabot/get-repo-secret", "description": "Gets a single repository secret without revealing its encrypted value.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "secretName", "type": "string", "info": "The name of the secret.: string", "required": true, "schema": { "title": "secretName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/dependabotGetRepoSecret" }, "task": true }, { "name": "dependabotCreateOrUpdateRepoSecret", "summary": "dependabot/create-or-update-repo-secret", "description": "Creates or updates a repository secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "secretName", "type": "string", "info": "The name of the secret.: string", "required": true, "schema": { "title": "secretName", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/dependabotCreateOrUpdateRepoSecret" }, "task": true }, { "name": "dependabotDeleteRepoSecret", "summary": "dependabot/delete-repo-secret", "description": "Deletes a secret in a repository using the secret name.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "secretName", "type": "string", "info": "The name of the secret.: string", "required": true, "schema": { "title": "secretName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/dependabotDeleteRepoSecret" }, "task": true }, { "name": "dependencyGraphDiffRange", "summary": "dependency-graph/diff-range", "description": "Gets the diff of the dependency changes between two commits of a repository, based on the changes to the dependency manifests made in those commits.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "basehead", "type": "string", "info": "The base and head Git revisions to compare. The Git revisions will be resolved to commit SHAs. Named revisions will be resolved to their corresponding HEAD commits, and a...(description truncated): string", "required": true, "schema": { "title": "basehead", "type": "string" } }, { "name": "name", "type": "string", "info": "The full path, relative to the repository root, of the dependency manifest file.: string", "required": false, "schema": { "title": "name", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/dependencyGraphDiffRange" }, "task": true }, { "name": "dependencyGraphExportSbom", "summary": "dependency-graph/export-sbom", "description": "Exports the software bill of materials (SBOM) for a repository in SPDX JSON format.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/dependencyGraphExportSbom" }, "task": true }, { "name": "dependencyGraphCreateRepositorySnapshot", "summary": "dependency-graph/create-repository-snapshot", "description": "Create a new snapshot of a repository's dependencies.\n\nThe authenticated user must have access to the repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/dependencyGraphCreateRepositorySnapshot" }, "task": true }, { "name": "getGistsQuery", "summary": "gists/list", "description": "Lists the authenticated user's gists or if called anonymously, this endpoint returns all public gists:", "input": [ { "name": "since", "type": "string", "info": "Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.: string", "required": false, "schema": { "title": "since", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getGistsQuery" }, "task": true }, { "name": "getGistsPublicQuery", "summary": "gists/list-public", "description": "List public gists sorted by most recently updated to least recently updated.\n\nNote: With [pagination](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api), you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page.", "input": [ { "name": "since", "type": "string", "info": "Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.: string", "required": false, "schema": { "title": "since", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getGistsPublicQuery" }, "task": true }, { "name": "getGistsStarredQuery", "summary": "gists/list-starred", "description": "List the authenticated user's starred gists:", "input": [ { "name": "since", "type": "string", "info": "Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.: string", "required": false, "schema": { "title": "since", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getGistsStarredQuery" }, "task": true }, { "name": "getGistsIdCommentsQuery", "summary": "gists/list-comments", "description": "Lists the comments on a gist.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 se...(description truncated)", "input": [ { "name": "gistId", "type": "string", "info": "The unique identifier of the gist.: string", "required": true, "schema": { "title": "gistId", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getGistsIdCommentsQuery" }, "task": true }, { "name": "gistsListCommits", "summary": "gists/list-commits", "description": "gists/list-commits", "input": [ { "name": "gistId", "type": "string", "info": "The unique identifier of the gist.: string", "required": true, "schema": { "title": "gistId", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/gistsListCommits" }, "task": true }, { "name": "gistsListForks", "summary": "gists/list-forks", "description": "gists/list-forks", "input": [ { "name": "gistId", "type": "string", "info": "The unique identifier of the gist.: string", "required": true, "schema": { "title": "gistId", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/gistsListForks" }, "task": true }, { "name": "gistsGetRevision", "summary": "gists/get-revision", "description": "Gets a specified gist revision.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 ...(description truncated)", "input": [ { "name": "gistId", "type": "string", "info": "The unique identifier of the gist.: string", "required": true, "schema": { "title": "gistId", "type": "string" } }, { "name": "sha", "type": "string", "info": ": string", "required": true, "schema": { "title": "sha", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/gistsGetRevision" }, "task": true }, { "name": "gitGetRef", "summary": "git/get-ref", "description": "Returns a single reference from your Git database. The `:ref` in the URL must be formatted as `heads/ ` for branches and `tags/ ` for tags. If the `:ref` doesn't match an existing ref, a `404` is returned.\n\n> [!NOTE]\n> You need to explicitly [request a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"[Checking mergeability of pull requests](https://docs.github.com/...(description truncated)", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "ref", "type": "string", "info": "The Git reference. For more information, see \"[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)\" in the Git documentation.: string", "required": true, "schema": { "title": "ref", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/gitGetRef" }, "task": true }, { "name": "gitignoreGetTemplate", "summary": "gitignore/get-template", "description": "Get the content of a gitignore template.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw .gitignore contents.", "input": [ { "name": "name", "type": "string", "info": ": string", "required": true, "schema": { "title": "name", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/gitignoreGetTemplate" }, "task": true }, { "name": "getIssuesQuery", "summary": "issues/list", "description": "List issues assigned to the authenticated user across all visible repositories including owned repositories, member\nrepositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not\nnecessarily assigned to you.\n\n> [!NOTE]\n> GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the...(description truncated)", "input": [ { "name": "filter", "type": "string", "info": "Indicates which sorts of issues to return. `assigned` means issues assigned to you. `created` means issues created by you. `mentioned` means issues mentioning you. `subsc...(description truncated): ", "required": false, "schema": { "title": "filter", "type": "string" } }, { "name": "state", "type": "string", "info": "Indicates the state of the issues to return.: ", "required": false, "schema": { "title": "state", "type": "string" } }, { "name": "labels", "type": "string", "info": "A list of comma separated label names. Example: `bug,ui,@high`: string", "required": false, "schema": { "title": "labels", "type": "string" } }, { "name": "sort", "type": "string", "info": "What to sort results by.: ", "required": false, "schema": { "title": "sort", "type": "string" } }, { "name": "direction", "type": "string", "info": "The direction to sort the results by.: ", "required": false, "schema": { "title": "direction", "type": "string" } }, { "name": "since", "type": "string", "info": "Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.: string", "required": false, "schema": { "title": "since", "type": "string" } }, { "name": "collab", "type": "boolean", "info": ": boolean", "required": false, "schema": { "title": "collab", "type": "boolean" } }, { "name": "orgs", "type": "boolean", "info": ": boolean", "required": false, "schema": { "title": "orgs", "type": "boolean" } }, { "name": "owned", "type": "boolean", "info": ": boolean", "required": false, "schema": { "title": "owned", "type": "boolean" } }, { "name": "pulls", "type": "boolean", "info": ": boolean", "required": false, "schema": { "title": "pulls", "type": "boolean" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getIssuesQuery" }, "task": true }, { "name": "issuesAddAssignees", "summary": "issues/add-assignees", "description": "Adds up to 10 assignees to an issue. Users already assigned to an issue are not replaced.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "issueNumber", "type": "number", "info": "The number that identifies the issue.: 123", "required": true, "schema": { "title": "issueNumber", "type": "number" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/issuesAddAssignees" }, "task": true }, { "name": "issuesRemoveAssignees", "summary": "issues/remove-assignees", "description": "Removes one or more assignees from an issue.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "issueNumber", "type": "number", "info": "The number that identifies the issue.: 123", "required": true, "schema": { "title": "issueNumber", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/issuesRemoveAssignees" }, "task": true }, { "name": "issuesCheckUserCanBeAssignedToIssue", "summary": "issues/check-user-can-be-assigned-to-issue", "description": "Checks if a user has permission to be assigned to a specific issue.\n\nIf the `assignee` can be assigned to this issue, a `204` status code with no content is returned.\n\nOtherwise a `404` status code is returned.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "issueNumber", "type": "number", "info": "The number that identifies the issue.: 123", "required": true, "schema": { "title": "issueNumber", "type": "number" } }, { "name": "assignee", "type": "string", "info": ": string", "required": true, "schema": { "title": "assignee", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/issuesCheckUserCanBeAssignedToIssue" }, "task": true }, { "name": "issuesLock", "summary": "issues/lock", "description": "Users with push access can lock an issue or pull request's conversation.\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method).\"", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "issueNumber", "type": "number", "info": "The number that identifies the issue.: 123", "required": true, "schema": { "title": "issueNumber", "type": "number" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/issuesLock" }, "task": true }, { "name": "issuesUnlock", "summary": "issues/unlock", "description": "Users with push access can unlock an issue's conversation.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "issueNumber", "type": "number", "info": "The number that identifies the issue.: 123", "required": true, "schema": { "title": "issueNumber", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/issuesUnlock" }, "task": true }, { "name": "issuesListEventsForTimeline", "summary": "issues/list-events-for-timeline", "description": "List all timeline events for an issue.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "issueNumber", "type": "number", "info": "The number that identifies the issue.: 123", "required": true, "schema": { "title": "issueNumber", "type": "number" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/issuesListEventsForTimeline" }, "task": true }, { "name": "licensesGetAllCommonlyUsed", "summary": "licenses/get-all-commonly-used", "description": "Lists the most commonly used licenses on GitHub. For more information, see \"[Licensing a repository ](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository).\"", "input": [ { "name": "featured", "type": "boolean", "info": ": boolean", "required": false, "schema": { "title": "featured", "type": "boolean" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/licensesGetAllCommonlyUsed" }, "task": true }, { "name": "licensesGet", "summary": "licenses/get", "description": "Gets information about a specific license. For more information, see \"[Licensing a repository ](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository).\"", "input": [ { "name": "license", "type": "string", "info": ": string", "required": true, "schema": { "title": "license", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/licensesGet" }, "task": true }, { "name": "licensesGetForRepo", "summary": "licenses/get-for-repo", "description": "This method returns the contents of the repository's license file, if one is detected.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw contents of the license.\n- **`application/vnd.github.html+json`**: Returns the license contents in HTML. Markup languages are rendered to HTML using GitHub's o...(description truncated)", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "ref", "type": "string", "info": "The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/ ` or simply ` `. To reference a pull request use `refs/...(description truncated): string", "required": false, "schema": { "title": "ref", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/licensesGetForRepo" }, "task": true }, { "name": "metaRoot", "summary": "meta/root", "description": "Get Hypermedia links to resources accessible in GitHub's REST API", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/metaRoot" }, "task": true }, { "name": "metaGetOctocat", "summary": "meta/get-octocat", "description": "Get the octocat as ASCII art", "input": [ { "name": "s", "type": "string", "info": "The words to show in Octocat's speech bubble: string", "required": false, "schema": { "title": "s", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/metaGetOctocat" }, "task": true }, { "name": "metaGetAllVersions", "summary": "meta/get-all-versions", "description": "Get all supported GitHub API versions.", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/metaGetAllVersions" }, "task": true }, { "name": "metaGetZen", "summary": "meta/get-zen", "description": "Get a random sentence from the Zen of GitHub", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/metaGetZen" }, "task": true }, { "name": "migrationsListForOrg", "summary": "migrations/list-for-org", "description": "Lists the most recent migrations, including both exports (which can be started through the REST API) and imports (which cannot be started using the REST API).\n\nA list of `repositories` is only returned for export migrations.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "exclude", "type": "array", "info": "Exclude attributes from the API response to improve performance: array", "required": false, "schema": { "title": "exclude", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/migrationsListForOrg" }, "task": true }, { "name": "migrationsStartForOrg", "summary": "migrations/start-for-org", "description": "Initiates the generation of a migration archive.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/migrationsStartForOrg" }, "task": true }, { "name": "migrationsGetStatusForOrg", "summary": "migrations/get-status-for-org", "description": "Fetches the status of a migration.\n\nThe `state` of a migration can be one of the following values:\n\n* `pending`, which means the migration hasn't started yet.\n* `exporting`, which means the migration is in progress.\n* `exported`, which means the migration finished successfully.\n* `failed`, which means the migration failed.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "migrationId", "type": "number", "info": "The unique identifier of the migration.: 123", "required": true, "schema": { "title": "migrationId", "type": "number" } }, { "name": "exclude", "type": "array", "info": "Exclude attributes from the API response to improve performance: array", "required": false, "schema": { "title": "exclude", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/migrationsGetStatusForOrg" }, "task": true }, { "name": "migrationsDownloadArchiveForOrg", "summary": "migrations/download-archive-for-org", "description": "Fetches the URL to a migration archive.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "migrationId", "type": "number", "info": "The unique identifier of the migration.: 123", "required": true, "schema": { "title": "migrationId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/migrationsDownloadArchiveForOrg" }, "task": true }, { "name": "migrationsDeleteArchiveForOrg", "summary": "migrations/delete-archive-for-org", "description": "Deletes a previous migration archive. Migration archives are automatically deleted after seven days.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "migrationId", "type": "number", "info": "The unique identifier of the migration.: 123", "required": true, "schema": { "title": "migrationId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/migrationsDeleteArchiveForOrg" }, "task": true }, { "name": "migrationsUnlockRepoForOrg", "summary": "migrations/unlock-repo-for-org", "description": "Unlocks a repository that was locked for migration. You should unlock each migrated repository and [delete them](https://docs.github.com/rest/repos/repos#delete-a-repository) when the migration is complete and you no longer need the source data.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "migrationId", "type": "number", "info": "The unique identifier of the migration.: 123", "required": true, "schema": { "title": "migrationId", "type": "number" } }, { "name": "repoName", "type": "string", "info": "repo_name parameter: string", "required": true, "schema": { "title": "repoName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/migrationsUnlockRepoForOrg" }, "task": true }, { "name": "migrationsListReposForOrg", "summary": "migrations/list-repos-for-org", "description": "List all the repositories for this organization migration.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "migrationId", "type": "number", "info": "The unique identifier of the migration.: 123", "required": true, "schema": { "title": "migrationId", "type": "number" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/migrationsListReposForOrg" }, "task": true }, { "name": "migrationsGetImportStatus", "summary": "migrations/get-import-status", "description": "View the progress of an import.\n\n> [!WARNING]\n> **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).\n\n**Import status**\n\nThis section includes details about the possible values of the `status` field of the Import Progress response.\n\nAn import that does not have errors will...(description truncated)", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/migrationsGetImportStatus" }, "task": true }, { "name": "migrationsStartImport", "summary": "migrations/start-import", "description": "Start a source import to a GitHub repository using GitHub Importer.\nImporting into a GitHub repository with GitHub Actions enabled is not supported and will\nreturn a status `422 Unprocessable Entity` response.\n\n> [!WARNING]\n> **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecat...(description truncated)", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/migrationsStartImport" }, "task": true }, { "name": "migrationsUpdateImport", "summary": "migrations/update-import", "description": "An import can be updated with credentials or a project choice by passing in the appropriate parameters in this API\nrequest. If no parameters are provided, the import will be restarted.\n\nSome servers (e.g. TFS servers) can have several projects at a single URL. In those cases the import progress will\nhave the status `detection_found_multiple` and the Import Progress response will include a `project_choices` array.\nYou can select the project to import by providing one of the objects in the `projec...(description truncated)", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/migrationsUpdateImport" }, "task": true }, { "name": "migrationsCancelImport", "summary": "migrations/cancel-import", "description": "Stop an import for a repository.\n\n> [!WARNING]\n> **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/migrationsCancelImport" }, "task": true }, { "name": "migrationsGetCommitAuthors", "summary": "migrations/get-commit-authors", "description": "Each type of source control system represents authors in a different way. For example, a Git commit author has a display name and an email address, but a Subversion commit author just has a username. The GitHub Importer will make the author information valid, but the author might not be correct. For example, it will change the bare Subversion username `hubot` into something like `hubot `.\n\nThis endpoint and the [Map a commit author](https://docs.github.com/rest/migrations/source-imports#map-a-c...(description truncated)", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "since", "type": "number", "info": "A user ID. Only return users with an ID greater than this ID.: 123", "required": false, "schema": { "title": "since", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/migrationsGetCommitAuthors" }, "task": true }, { "name": "migrationsMapCommitAuthor", "summary": "migrations/map-commit-author", "description": "Update an author's identity for the import. Your application can continue updating authors any time before you push\nnew commits to the repository.\n\n> [!WARNING]\n> **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "authorId", "type": "number", "info": ": 123", "required": true, "schema": { "title": "authorId", "type": "number" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/migrationsMapCommitAuthor" }, "task": true }, { "name": "migrationsGetLargeFiles", "summary": "migrations/get-large-files", "description": "List files larger than 100MB found during the import\n\n> [!WARNING]\n> **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/migrationsGetLargeFiles" }, "task": true }, { "name": "migrationsSetLfsPreference", "summary": "migrations/set-lfs-preference", "description": "You can import repositories from Subversion, Mercurial, and TFS that include files larger than 100MB. This ability\nis powered by [Git LFS](https://git-lfs.com).\n\nYou can learn more about our LFS feature and working with large files [on our help\nsite](https://docs.github.com/repositories/working-with-files/managing-large-files).\n\n> [!WARNING]\n> **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00...(description truncated)", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/migrationsSetLfsPreference" }, "task": true }, { "name": "migrationsListForAuthenticatedUser", "summary": "migrations/list-for-authenticated-user", "description": "Lists all migrations a user has started.", "input": [ { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/migrationsListForAuthenticatedUser" }, "task": true }, { "name": "migrationsStartForAuthenticatedUser", "summary": "migrations/start-for-authenticated-user", "description": "Initiates the generation of a user migration archive.", "input": [ { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/migrationsStartForAuthenticatedUser" }, "task": true }, { "name": "migrationsGetStatusForAuthenticatedUser", "summary": "migrations/get-status-for-authenticated-user", "description": "Fetches a single user migration. The response includes the `state` of the migration, which can be one of the following values:\n\n* `pending` - the migration hasn't started yet.\n* `exporting` - the migration is in progress.\n* `exported` - the migration finished successfully.\n* `failed` - the migration failed.\n\nOnce the migration has been `exported` you can [download the migration archive](https://docs.github.com/rest/migrations/users#download-a-user-migration-archive).", "input": [ { "name": "migrationId", "type": "number", "info": "The unique identifier of the migration.: 123", "required": true, "schema": { "title": "migrationId", "type": "number" } }, { "name": "exclude", "type": "array", "info": ": array", "required": false, "schema": { "title": "exclude", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/migrationsGetStatusForAuthenticatedUser" }, "task": true }, { "name": "migrationsGetArchiveForAuthenticatedUser", "summary": "migrations/get-archive-for-authenticated-user", "description": "Fetches the URL to download the migration archive as a `tar.gz` file. Depending on the resources your repository uses, the migration archive can contain JSON files with data for these objects:\n\n* attachments\n* bases\n* commit\\_comments\n* issue\\_comments\n* issue\\_events\n* issues\n* milestones\n* organizations\n* projects\n* protected\\_branches\n* pull\\_request\\_reviews\n* pull\\_requests\n* releases\n* repositories\n* review\\_comments\n* schema\n* users\n\nThe archive will also...(description truncated)", "input": [ { "name": "migrationId", "type": "number", "info": "The unique identifier of the migration.: 123", "required": true, "schema": { "title": "migrationId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/migrationsGetArchiveForAuthenticatedUser" }, "task": true }, { "name": "migrationsDeleteArchiveForAuthenticatedUser", "summary": "migrations/delete-archive-for-authenticated-user", "description": "Deletes a previous migration archive. Downloadable migration archives are automatically deleted after seven days. Migration metadata, which is returned in the [List user migrations](https://docs.github.com/rest/migrations/users#list-user-migrations) and [Get a user migration status](https://docs.github.com/rest/migrations/users#get-a-user-migration-status) endpoints, will continue to be available even after an archive is deleted.", "input": [ { "name": "migrationId", "type": "number", "info": "The unique identifier of the migration.: 123", "required": true, "schema": { "title": "migrationId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/migrationsDeleteArchiveForAuthenticatedUser" }, "task": true }, { "name": "migrationsUnlockRepoForAuthenticatedUser", "summary": "migrations/unlock-repo-for-authenticated-user", "description": "Unlocks a repository. You can lock repositories when you [start a user migration](https://docs.github.com/rest/migrations/users#start-a-user-migration). Once the migration is complete you can unlock each repository to begin using it again or [delete the repository](https://docs.github.com/rest/repos/repos#delete-a-repository) if you no longer need the source data. Returns a status of `404 Not Found` if the repository is not locked.", "input": [ { "name": "migrationId", "type": "number", "info": "The unique identifier of the migration.: 123", "required": true, "schema": { "title": "migrationId", "type": "number" } }, { "name": "repoName", "type": "string", "info": "repo_name parameter: string", "required": true, "schema": { "title": "repoName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/migrationsUnlockRepoForAuthenticatedUser" }, "task": true }, { "name": "migrationsListReposForAuthenticatedUser", "summary": "migrations/list-repos-for-authenticated-user", "description": "Lists all the repositories for this user migration.", "input": [ { "name": "migrationId", "type": "number", "info": "The unique identifier of the migration.: 123", "required": true, "schema": { "title": "migrationId", "type": "number" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/migrationsListReposForAuthenticatedUser" }, "task": true }, { "name": "oidcGetOidcCustomSubTemplateForOrg", "summary": "oidc/get-oidc-custom-sub-template-for-org", "description": "Gets the customization template for an OpenID Connect (OIDC) subject claim.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/oidcGetOidcCustomSubTemplateForOrg" }, "task": true }, { "name": "oidcUpdateOidcCustomSubTemplateForOrg", "summary": "oidc/update-oidc-custom-sub-template-for-org", "description": "Creates or updates the customization template for an OpenID Connect (OIDC) subject claim.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/oidcUpdateOidcCustomSubTemplateForOrg" }, "task": true }, { "name": "packagesListDockerMigrationConflictingPackagesForOrganization", "summary": "packages/list-docker-migration-conflicting-packages-for-organization", "description": "Lists all packages that are in a specific organization, are readable by the requesting user, and that encountered a conflict during a Docker migration.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/packagesListDockerMigrationConflictingPackagesForOrganization" }, "task": true }, { "name": "packagesListPackagesForOrganization", "summary": "packages/list-packages-for-organization", "description": "Lists packages in an organization readable by the user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-rep...(description truncated)", "input": [ { "name": "packageType", "type": "string", "info": "The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `...(description truncated): ", "required": true, "schema": { "title": "packageType", "type": "string" } }, { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "visibility", "type": "string", "info": "The selected visibility of the packages. This parameter is optional and only filters an existing result set.\n\nThe `internal` visibility is only supported for GitHub Pack...(description truncated): ", "required": false, "schema": { "title": "visibility", "type": "string" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/packagesListPackagesForOrganization" }, "task": true }, { "name": "packagesGetPackageForOrganization", "summary": "packages/get-package-for-organization", "description": "Gets a specific package in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scop...(description truncated)", "input": [ { "name": "packageType", "type": "string", "info": "The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `...(description truncated): ", "required": true, "schema": { "title": "packageType", "type": "string" } }, { "name": "packageName", "type": "string", "info": "The name of the package.: string", "required": true, "schema": { "title": "packageName", "type": "string" } }, { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/packagesGetPackageForOrganization" }, "task": true }, { "name": "packagesDeletePackageForOrg", "summary": "packages/delete-package-for-org", "description": "Deletes an entire package in an organization. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registrie...(description truncated)", "input": [ { "name": "packageType", "type": "string", "info": "The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `...(description truncated): ", "required": true, "schema": { "title": "packageType", "type": "string" } }, { "name": "packageName", "type": "string", "info": "The name of the package.: string", "required": true, "schema": { "title": "packageName", "type": "string" } }, { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/packagesDeletePackageForOrg" }, "task": true }, { "name": "packagesRestorePackageForOrg", "summary": "packages/restore-package-for-org", "description": "Restores an entire package in an organization.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nThe authent...(description truncated)", "input": [ { "name": "packageType", "type": "string", "info": "The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `...(description truncated): ", "required": true, "schema": { "title": "packageType", "type": "string" } }, { "name": "packageName", "type": "string", "info": "The name of the package.: string", "required": true, "schema": { "title": "packageName", "type": "string" } }, { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "token", "type": "string", "info": "package token: string", "required": false, "schema": { "title": "token", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/packagesRestorePackageForOrg" }, "task": true }, { "name": "packagesGetAllPackageVersionsForPackageOwnedByOrg", "summary": "packages/get-all-package-versions-for-package-owned-by-org", "description": "Lists package versions for a package owned by an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint if the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "input": [ { "name": "packageType", "type": "string", "info": "The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `...(description truncated): ", "required": true, "schema": { "title": "packageType", "type": "string" } }, { "name": "packageName", "type": "string", "info": "The name of the package.: string", "required": true, "schema": { "title": "packageName", "type": "string" } }, { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "state", "type": "string", "info": "The state of the package, either active or deleted.: ", "required": false, "schema": { "title": "state", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/packagesGetAllPackageVersionsForPackageOwnedByOrg" }, "task": true }, { "name": "packagesGetPackageVersionForOrganization", "summary": "packages/get-package-version-for-organization", "description": "Gets a specific package version in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-reposit...(description truncated)", "input": [ { "name": "packageType", "type": "string", "info": "The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `...(description truncated): ", "required": true, "schema": { "title": "packageType", "type": "string" } }, { "name": "packageName", "type": "string", "info": "The name of the package.: string", "required": true, "schema": { "title": "packageName", "type": "string" } }, { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "packageVersionId", "type": "number", "info": "Unique identifier of the package version.: 123", "required": true, "schema": { "title": "packageVersionId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/packagesGetPackageVersionForOrganization" }, "task": true }, { "name": "packagesDeletePackageVersionForOrg", "summary": "packages/delete-package-version-for-org", "description": "Deletes a specific package version in an organization. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package....(description truncated)", "input": [ { "name": "packageType", "type": "string", "info": "The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `...(description truncated): ", "required": true, "schema": { "title": "packageType", "type": "string" } }, { "name": "packageName", "type": "string", "info": "The name of the package.: string", "required": true, "schema": { "title": "packageName", "type": "string" } }, { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "packageVersionId", "type": "number", "info": "Unique identifier of the package version.: 123", "required": true, "schema": { "title": "packageVersionId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/packagesDeletePackageVersionForOrg" }, "task": true }, { "name": "packagesRestorePackageVersionForOrg", "summary": "packages/restore-package-version-for-org", "description": "Restores a specific package version in an organization.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nTh...(description truncated)", "input": [ { "name": "packageType", "type": "string", "info": "The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `...(description truncated): ", "required": true, "schema": { "title": "packageType", "type": "string" } }, { "name": "packageName", "type": "string", "info": "The name of the package.: string", "required": true, "schema": { "title": "packageName", "type": "string" } }, { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "packageVersionId", "type": "number", "info": "Unique identifier of the package version.: 123", "required": true, "schema": { "title": "packageVersionId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/packagesRestorePackageVersionForOrg" }, "task": true }, { "name": "packagesListDockerMigrationConflictingPackagesForAuthenticatedUser", "summary": "packages/list-docker-migration-conflicting-packages-for-authenticated-user", "description": "Lists all packages that are owned by the authenticated user within the user's namespace, and that encountered a conflict during a Docker migration.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint.", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/packagesListDockerMigrationConflictingPackagesForAuthenticatedUser" }, "task": true }, { "name": "packagesListPackagesForAuthenticatedUser", "summary": "packages/list-packages-for-authenticated-user", "description": "Lists packages owned by the authenticated user within the user's namespace.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages...(description truncated)", "input": [ { "name": "packageType", "type": "string", "info": "The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `...(description truncated): ", "required": true, "schema": { "title": "packageType", "type": "string" } }, { "name": "visibility", "type": "string", "info": "The selected visibility of the packages. This parameter is optional and only filters an existing result set.\n\nThe `internal` visibility is only supported for GitHub Pack...(description truncated): ", "required": false, "schema": { "title": "visibility", "type": "string" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/packagesListPackagesForAuthenticatedUser" }, "task": true }, { "name": "packagesGetPackageForAuthenticatedUser", "summary": "packages/get-package-for-authenticated-user", "description": "Gets a specific package for a package owned by the authenticated user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#perm...(description truncated)", "input": [ { "name": "packageType", "type": "string", "info": "The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `...(description truncated): ", "required": true, "schema": { "title": "packageType", "type": "string" } }, { "name": "packageName", "type": "string", "info": "The name of the package.: string", "required": true, "schema": { "title": "packageName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/packagesGetPackageForAuthenticatedUser" }, "task": true }, { "name": "packagesDeletePackageForAuthenticatedUser", "summary": "packages/delete-package-for-authenticated-user", "description": "Deletes a package owned by the authenticated user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, `repo` scope is also required. For the list the...(description truncated)", "input": [ { "name": "packageType", "type": "string", "info": "The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `...(description truncated): ", "required": true, "schema": { "title": "packageType", "type": "string" } }, { "name": "packageName", "type": "string", "info": "The name of the package.: string", "required": true, "schema": { "title": "packageName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/packagesDeletePackageForAuthenticatedUser" }, "task": true }, { "name": "packagesRestorePackageForAuthenticatedUser", "summary": "packages/restore-package-for-authenticated-user", "description": "Restores a package owned by the authenticated user.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nOAuth ...(description truncated)", "input": [ { "name": "packageType", "type": "string", "info": "The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `...(description truncated): ", "required": true, "schema": { "title": "packageType", "type": "string" } }, { "name": "packageName", "type": "string", "info": "The name of the package.: string", "required": true, "schema": { "title": "packageName", "type": "string" } }, { "name": "token", "type": "string", "info": "package token: string", "required": false, "schema": { "title": "token", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/packagesRestorePackageForAuthenticatedUser" }, "task": true }, { "name": "packagesGetAllPackageVersionsForPackageOwnedByAuthenticatedUser", "summary": "packages/get-all-package-versions-for-package-owned-by-authenticated-user", "description": "Lists package versions for a package owned by the authenticated user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permi...(description truncated)", "input": [ { "name": "packageType", "type": "string", "info": "The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `...(description truncated): ", "required": true, "schema": { "title": "packageType", "type": "string" } }, { "name": "packageName", "type": "string", "info": "The name of the package.: string", "required": true, "schema": { "title": "packageName", "type": "string" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "state", "type": "string", "info": "The state of the package, either active or deleted.: ", "required": false, "schema": { "title": "state", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/packagesGetAllPackageVersionsForPackageOwnedByAuthenticatedUser" }, "task": true }, { "name": "packagesGetPackageVersionForAuthenticatedUser", "summary": "packages/get-package-version-for-authenticated-user", "description": "Gets a specific package version for a package owned by the authenticated user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packa...(description truncated)", "input": [ { "name": "packageType", "type": "string", "info": "The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `...(description truncated): ", "required": true, "schema": { "title": "packageType", "type": "string" } }, { "name": "packageName", "type": "string", "info": "The name of the package.: string", "required": true, "schema": { "title": "packageName", "type": "string" } }, { "name": "packageVersionId", "type": "number", "info": "Unique identifier of the package version.: 123", "required": true, "schema": { "title": "packageVersionId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/packagesGetPackageVersionForAuthenticatedUser" }, "task": true }, { "name": "packagesDeletePackageVersionForAuthenticatedUser", "summary": "packages/delete-package-version-for-authenticated-user", "description": "Deletes a specific package version for a package owned by the authenticated user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `...(description truncated)", "input": [ { "name": "packageType", "type": "string", "info": "The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `...(description truncated): ", "required": true, "schema": { "title": "packageType", "type": "string" } }, { "name": "packageName", "type": "string", "info": "The name of the package.: string", "required": true, "schema": { "title": "packageName", "type": "string" } }, { "name": "packageVersionId", "type": "number", "info": "Unique identifier of the package version.: 123", "required": true, "schema": { "title": "packageVersionId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/packagesDeletePackageVersionForAuthenticatedUser" }, "task": true }, { "name": "packagesRestorePackageVersionForAuthenticatedUser", "summary": "packages/restore-package-version-for-authenticated-user", "description": "Restores a package version owned by the authenticated user.\n\nYou can restore a deleted package version under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespac...(description truncated)", "input": [ { "name": "packageType", "type": "string", "info": "The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `...(description truncated): ", "required": true, "schema": { "title": "packageType", "type": "string" } }, { "name": "packageName", "type": "string", "info": "The name of the package.: string", "required": true, "schema": { "title": "packageName", "type": "string" } }, { "name": "packageVersionId", "type": "number", "info": "Unique identifier of the package version.: 123", "required": true, "schema": { "title": "packageVersionId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/packagesRestorePackageVersionForAuthenticatedUser" }, "task": true }, { "name": "packagesListDockerMigrationConflictingPackagesForUser", "summary": "packages/list-docker-migration-conflicting-packages-for-user", "description": "Lists all packages that are in a specific user's namespace, that the requesting user has access to, and that encountered a conflict during Docker migration.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint.", "input": [ { "name": "username", "type": "string", "info": "The handle for the GitHub user account.: string", "required": true, "schema": { "title": "username", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/packagesListDockerMigrationConflictingPackagesForUser" }, "task": true }, { "name": "packagesListPackagesForUser", "summary": "packages/list-packages-for-user", "description": "Lists all packages in a user's namespace for which the requesting user has access.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-p...(description truncated)", "input": [ { "name": "packageType", "type": "string", "info": "The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `...(description truncated): ", "required": true, "schema": { "title": "packageType", "type": "string" } }, { "name": "visibility", "type": "string", "info": "The selected visibility of the packages. This parameter is optional and only filters an existing result set.\n\nThe `internal` visibility is only supported for GitHub Pack...(description truncated): ", "required": false, "schema": { "title": "visibility", "type": "string" } }, { "name": "username", "type": "string", "info": "The handle for the GitHub user account.: string", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/packagesListPackagesForUser" }, "task": true }, { "name": "packagesGetPackageForUser", "summary": "packages/get-package-for-user", "description": "Gets a specific package metadata for a public package owned by a user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#perm...(description truncated)", "input": [ { "name": "packageType", "type": "string", "info": "The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `...(description truncated): ", "required": true, "schema": { "title": "packageType", "type": "string" } }, { "name": "packageName", "type": "string", "info": "The name of the package.: string", "required": true, "schema": { "title": "packageName", "type": "string" } }, { "name": "username", "type": "string", "info": "The handle for the GitHub user account.: string", "required": true, "schema": { "title": "username", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/packagesGetPackageForUser" }, "task": true }, { "name": "packagesDeletePackageForUser", "summary": "packages/delete-package-for-user", "description": "Deletes an entire package for a user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.\n\nIf the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/abo...(description truncated)", "input": [ { "name": "packageType", "type": "string", "info": "The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `...(description truncated): ", "required": true, "schema": { "title": "packageType", "type": "string" } }, { "name": "packageName", "type": "string", "info": "The name of the package.: string", "required": true, "schema": { "title": "packageName", "type": "string" } }, { "name": "username", "type": "string", "info": "The handle for the GitHub user account.: string", "required": true, "schema": { "title": "username", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/packagesDeletePackageForUser" }, "task": true }, { "name": "packagesRestorePackageForUser", "summary": "packages/restore-package-for-user", "description": "Restores an entire package for a user.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nIf the `package_typ...(description truncated)", "input": [ { "name": "packageType", "type": "string", "info": "The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `...(description truncated): ", "required": true, "schema": { "title": "packageType", "type": "string" } }, { "name": "packageName", "type": "string", "info": "The name of the package.: string", "required": true, "schema": { "title": "packageName", "type": "string" } }, { "name": "username", "type": "string", "info": "The handle for the GitHub user account.: string", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "token", "type": "string", "info": "package token: string", "required": false, "schema": { "title": "token", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/packagesRestorePackageForUser" }, "task": true }, { "name": "packagesGetAllPackageVersionsForPackageOwnedByUser", "summary": "packages/get-all-package-versions-for-package-owned-by-user", "description": "Lists package versions for a public package owned by a specified user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#perm...(description truncated)", "input": [ { "name": "packageType", "type": "string", "info": "The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `...(description truncated): ", "required": true, "schema": { "title": "packageType", "type": "string" } }, { "name": "packageName", "type": "string", "info": "The name of the package.: string", "required": true, "schema": { "title": "packageName", "type": "string" } }, { "name": "username", "type": "string", "info": "The handle for the GitHub user account.: string", "required": true, "schema": { "title": "username", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/packagesGetAllPackageVersionsForPackageOwnedByUser" }, "task": true }, { "name": "packagesGetPackageVersionForUser", "summary": "packages/get-package-version-for-user", "description": "Gets a specific package version for a public package owned by a specified user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-pack...(description truncated)", "input": [ { "name": "packageType", "type": "string", "info": "The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `...(description truncated): ", "required": true, "schema": { "title": "packageType", "type": "string" } }, { "name": "packageName", "type": "string", "info": "The name of the package.: string", "required": true, "schema": { "title": "packageName", "type": "string" } }, { "name": "packageVersionId", "type": "number", "info": "Unique identifier of the package version.: 123", "required": true, "schema": { "title": "packageVersionId", "type": "number" } }, { "name": "username", "type": "string", "info": "The handle for the GitHub user account.: string", "required": true, "schema": { "title": "username", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/packagesGetPackageVersionForUser" }, "task": true }, { "name": "packagesDeletePackageVersionForUser", "summary": "packages/delete-package-version-for-user", "description": "Deletes a specific package version for a user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.\n\nIf the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/pa...(description truncated)", "input": [ { "name": "packageType", "type": "string", "info": "The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `...(description truncated): ", "required": true, "schema": { "title": "packageType", "type": "string" } }, { "name": "packageName", "type": "string", "info": "The name of the package.: string", "required": true, "schema": { "title": "packageName", "type": "string" } }, { "name": "username", "type": "string", "info": "The handle for the GitHub user account.: string", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "packageVersionId", "type": "number", "info": "Unique identifier of the package version.: 123", "required": true, "schema": { "title": "packageVersionId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/packagesDeletePackageVersionForUser" }, "task": true }, { "name": "packagesRestorePackageVersionForUser", "summary": "packages/restore-package-version-for-user", "description": "Restores a specific package version for a user.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nIf the `pa...(description truncated)", "input": [ { "name": "packageType", "type": "string", "info": "The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `...(description truncated): ", "required": true, "schema": { "title": "packageType", "type": "string" } }, { "name": "packageName", "type": "string", "info": "The name of the package.: string", "required": true, "schema": { "title": "packageName", "type": "string" } }, { "name": "username", "type": "string", "info": "The handle for the GitHub user account.: string", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "packageVersionId", "type": "number", "info": "Unique identifier of the package version.: 123", "required": true, "schema": { "title": "packageVersionId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/packagesRestorePackageVersionForUser" }, "task": true }, { "name": "projectsListForOrg", "summary": "projects/list-for-org", "description": "Lists the projects in an organization. Returns a `404 Not Found` status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "state", "type": "string", "info": "Indicates the state of the projects to return.: ", "required": false, "schema": { "title": "state", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/projectsListForOrg" }, "task": true }, { "name": "projectsCreateForOrg", "summary": "projects/create-for-org", "description": "Creates an organization project board. Returns a `410 Gone` status if projects are disabled in the organization or if the organization does not have existing classic projects. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/projectsCreateForOrg" }, "task": true }, { "name": "projectsGetCard", "summary": "projects/get-card", "description": "Gets information about a project card.", "input": [ { "name": "cardId", "type": "number", "info": "The unique identifier of the card.: 123", "required": true, "schema": { "title": "cardId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/projectsGetCard" }, "task": true }, { "name": "projectsUpdateCard", "summary": "projects/update-card", "description": "projects/update-card", "input": [ { "name": "cardId", "type": "number", "info": "The unique identifier of the card.: 123", "required": true, "schema": { "title": "cardId", "type": "number" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/projectsUpdateCard" }, "task": true }, { "name": "projectsDeleteCard", "summary": "projects/delete-card", "description": "Deletes a project card", "input": [ { "name": "cardId", "type": "number", "info": "The unique identifier of the card.: 123", "required": true, "schema": { "title": "cardId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/projectsDeleteCard" }, "task": true }, { "name": "projectsMoveCard", "summary": "projects/move-card", "description": "projects/move-card", "input": [ { "name": "cardId", "type": "number", "info": "The unique identifier of the card.: 123", "required": true, "schema": { "title": "cardId", "type": "number" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/projectsMoveCard" }, "task": true }, { "name": "projectsGetColumn", "summary": "projects/get-column", "description": "Gets information about a project column.", "input": [ { "name": "columnId", "type": "number", "info": "The unique identifier of the column.: 123", "required": true, "schema": { "title": "columnId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/projectsGetColumn" }, "task": true }, { "name": "projectsUpdateColumn", "summary": "projects/update-column", "description": "projects/update-column", "input": [ { "name": "columnId", "type": "number", "info": "The unique identifier of the column.: 123", "required": true, "schema": { "title": "columnId", "type": "number" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/projectsUpdateColumn" }, "task": true }, { "name": "projectsDeleteColumn", "summary": "projects/delete-column", "description": "Deletes a project column.", "input": [ { "name": "columnId", "type": "number", "info": "The unique identifier of the column.: 123", "required": true, "schema": { "title": "columnId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/projectsDeleteColumn" }, "task": true }, { "name": "projectsListCards", "summary": "projects/list-cards", "description": "Lists the project cards in a project.", "input": [ { "name": "columnId", "type": "number", "info": "The unique identifier of the column.: 123", "required": true, "schema": { "title": "columnId", "type": "number" } }, { "name": "archivedState", "type": "string", "info": "Filters the project cards that are returned by the card's state.: ", "required": false, "schema": { "title": "archivedState", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/projectsListCards" }, "task": true }, { "name": "projectsCreateCard", "summary": "projects/create-card", "description": "projects/create-card", "input": [ { "name": "columnId", "type": "number", "info": "The unique identifier of the column.: 123", "required": true, "schema": { "title": "columnId", "type": "number" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/projectsCreateCard" }, "task": true }, { "name": "projectsMoveColumn", "summary": "projects/move-column", "description": "projects/move-column", "input": [ { "name": "columnId", "type": "number", "info": "The unique identifier of the column.: 123", "required": true, "schema": { "title": "columnId", "type": "number" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/projectsMoveColumn" }, "task": true }, { "name": "projectsGet", "summary": "projects/get", "description": "Gets a project by its `id`. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.", "input": [ { "name": "projectId", "type": "number", "info": "The unique identifier of the project.: 123", "required": true, "schema": { "title": "projectId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/projectsGet" }, "task": true }, { "name": "projectsUpdate", "summary": "projects/update", "description": "Updates a project board's information. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.", "input": [ { "name": "projectId", "type": "number", "info": "The unique identifier of the project.: 123", "required": true, "schema": { "title": "projectId", "type": "number" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/projectsUpdate" }, "task": true }, { "name": "projectsDelete", "summary": "projects/delete", "description": "Deletes a project board. Returns a `404 Not Found` status if projects are disabled.", "input": [ { "name": "projectId", "type": "number", "info": "The unique identifier of the project.: 123", "required": true, "schema": { "title": "projectId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/projectsDelete" }, "task": true }, { "name": "projectsListCollaborators", "summary": "projects/list-collaborators", "description": "Lists the collaborators for an organization project. For a project, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. You must be an organization owner or a project `admin` to list collaborators.", "input": [ { "name": "projectId", "type": "number", "info": "The unique identifier of the project.: 123", "required": true, "schema": { "title": "projectId", "type": "number" } }, { "name": "affiliation", "type": "string", "info": "Filters the collaborators by their affiliation. `outside` means outside collaborators of a project that are not a member of the project's organization. `direct` means col...(description truncated): ", "required": false, "schema": { "title": "affiliation", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/projectsListCollaborators" }, "task": true }, { "name": "projectsAddCollaborator", "summary": "projects/add-collaborator", "description": "Adds a collaborator to an organization project and sets their permission level. You must be an organization owner or a project `admin` to add a collaborator.", "input": [ { "name": "projectId", "type": "number", "info": "The unique identifier of the project.: 123", "required": true, "schema": { "title": "projectId", "type": "number" } }, { "name": "username", "type": "string", "info": "The handle for the GitHub user account.: string", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/projectsAddCollaborator" }, "task": true }, { "name": "projectsRemoveCollaborator", "summary": "projects/remove-collaborator", "description": "Removes a collaborator from an organization project. You must be an organization owner or a project `admin` to remove a collaborator.", "input": [ { "name": "projectId", "type": "number", "info": "The unique identifier of the project.: 123", "required": true, "schema": { "title": "projectId", "type": "number" } }, { "name": "username", "type": "string", "info": "The handle for the GitHub user account.: string", "required": true, "schema": { "title": "username", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/projectsRemoveCollaborator" }, "task": true }, { "name": "projectsGetPermissionForUser", "summary": "projects/get-permission-for-user", "description": "Returns the collaborator's permission level for an organization project. Possible values for the `permission` key: `admin`, `write`, `read`, `none`. You must be an organization owner or a project `admin` to review a user's permission level.", "input": [ { "name": "projectId", "type": "number", "info": "The unique identifier of the project.: 123", "required": true, "schema": { "title": "projectId", "type": "number" } }, { "name": "username", "type": "string", "info": "The handle for the GitHub user account.: string", "required": true, "schema": { "title": "username", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/projectsGetPermissionForUser" }, "task": true }, { "name": "projectsListColumns", "summary": "projects/list-columns", "description": "Lists the project columns in a project.", "input": [ { "name": "projectId", "type": "number", "info": "The unique identifier of the project.: 123", "required": true, "schema": { "title": "projectId", "type": "number" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/projectsListColumns" }, "task": true }, { "name": "projectsCreateColumn", "summary": "projects/create-column", "description": "Creates a new project column.", "input": [ { "name": "projectId", "type": "number", "info": "The unique identifier of the project.: 123", "required": true, "schema": { "title": "projectId", "type": "number" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/projectsCreateColumn" }, "task": true }, { "name": "projectsListForRepo", "summary": "projects/list-for-repo", "description": "Lists the projects in a repository. Returns a `404 Not Found` status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "state", "type": "string", "info": "Indicates the state of the projects to return.: ", "required": false, "schema": { "title": "state", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/projectsListForRepo" }, "task": true }, { "name": "projectsCreateForRepo", "summary": "projects/create-for-repo", "description": "Creates a repository project board. Returns a `410 Gone` status if projects are disabled in the repository or if the repository does not have existing classic projects. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/projectsCreateForRepo" }, "task": true }, { "name": "projectsCreateForAuthenticatedUser", "summary": "projects/create-for-authenticated-user", "description": "Creates a user project board. Returns a `410 Gone` status if the user does not have existing classic projects. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.", "input": [ { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/projectsCreateForAuthenticatedUser" }, "task": true }, { "name": "projectsListForUser", "summary": "projects/list-for-user", "description": "Lists projects for a user.", "input": [ { "name": "username", "type": "string", "info": "The handle for the GitHub user account.: string", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "state", "type": "string", "info": "Indicates the state of the projects to return.: ", "required": false, "schema": { "title": "state", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/projectsListForUser" }, "task": true }, { "name": "pullsCreateReplyForReviewComment", "summary": "pulls/create-reply-for-review-comment", "description": "Creates a reply to a review comment for a pull request. For the `comment_id`, provide the ID of the review comment you are replying to. This must be the ID of a _top-level review comment_, not a reply to that comment. Replies to replies are not supported.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more inf...(description truncated)", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "pullNumber", "type": "number", "info": "The number that identifies the pull request.: 123", "required": true, "schema": { "title": "pullNumber", "type": "number" } }, { "name": "commentId", "type": "number", "info": "The unique identifier of the comment.: 123", "required": true, "schema": { "title": "commentId", "type": "number" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/pullsCreateReplyForReviewComment" }, "task": true }, { "name": "pullsListRequestedReviewers", "summary": "pulls/list-requested-reviewers", "description": "Gets the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the [List reviews for a pull request](https://docs.github.com/rest/pulls/reviews#list-reviews-for-a-pull-request) operation.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "pullNumber", "type": "number", "info": "The number that identifies the pull request.: 123", "required": true, "schema": { "title": "pullNumber", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/pullsListRequestedReviewers" }, "task": true }, { "name": "pullsRequestReviewers", "summary": "pulls/request-reviewers", "description": "Requests reviews for a pull request from a given set of users and/or teams.\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using th...(description truncated)", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "pullNumber", "type": "number", "info": "The number that identifies the pull request.: 123", "required": true, "schema": { "title": "pullNumber", "type": "number" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/pullsRequestReviewers" }, "task": true }, { "name": "pullsRemoveRequestedReviewers", "summary": "pulls/remove-requested-reviewers", "description": "Removes review requests from a pull request for a given set of users and/or teams.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "pullNumber", "type": "number", "info": "The number that identifies the pull request.: 123", "required": true, "schema": { "title": "pullNumber", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/pullsRemoveRequestedReviewers" }, "task": true }, { "name": "pullsListReviews", "summary": "pulls/list-reviews", "description": "Lists all reviews for a specified pull request. The list of reviews returns in chronological order.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.gi...(description truncated)", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "pullNumber", "type": "number", "info": "The number that identifies the pull request.: 123", "required": true, "schema": { "title": "pullNumber", "type": "number" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/pullsListReviews" }, "task": true }, { "name": "pullsCreateReview", "summary": "pulls/create-review", "description": "Creates a review on a specified pull request.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.gith...(description truncated)", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "pullNumber", "type": "number", "info": "The number that identifies the pull request.: 123", "required": true, "schema": { "title": "pullNumber", "type": "number" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/pullsCreateReview" }, "task": true }, { "name": "pullsGetReview", "summary": "pulls/get-review", "description": "Retrieves a pull request review by its ID.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only repr...(description truncated)", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "pullNumber", "type": "number", "info": "The number that identifies the pull request.: 123", "required": true, "schema": { "title": "pullNumber", "type": "number" } }, { "name": "reviewId", "type": "number", "info": "The unique identifier of the review.: 123", "required": true, "schema": { "title": "reviewId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/pullsGetReview" }, "task": true }, { "name": "pullsUpdateReview", "summary": "pulls/update-review", "description": "Updates the contents of a specified review summary comment.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns...(description truncated)", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "pullNumber", "type": "number", "info": "The number that identifies the pull request.: 123", "required": true, "schema": { "title": "pullNumber", "type": "number" } }, { "name": "reviewId", "type": "number", "info": "The unique identifier of the review.: 123", "required": true, "schema": { "title": "reviewId", "type": "number" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/pullsUpdateReview" }, "task": true }, { "name": "pullsDeletePendingReview", "summary": "pulls/delete-pending-review", "description": "Deletes a pull request review that has not been submitted. Submitted reviews cannot be deleted.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github...(description truncated)", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "pullNumber", "type": "number", "info": "The number that identifies the pull request.: 123", "required": true, "schema": { "title": "pullNumber", "type": "number" } }, { "name": "reviewId", "type": "number", "info": "The unique identifier of the review.: 123", "required": true, "schema": { "title": "reviewId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/pullsDeletePendingReview" }, "task": true }, { "name": "pullsListCommentsForReview", "summary": "pulls/list-comments-for-review", "description": "Lists comments for a specific pull request review.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text o...(description truncated)", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "pullNumber", "type": "number", "info": "The number that identifies the pull request.: 123", "required": true, "schema": { "title": "pullNumber", "type": "number" } }, { "name": "reviewId", "type": "number", "info": "The unique identifier of the review.: 123", "required": true, "schema": { "title": "reviewId", "type": "number" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/pullsListCommentsForReview" }, "task": true }, { "name": "pullsDismissReview", "summary": "pulls/dismiss-review", "description": "Dismisses a specified review on a pull request.\n\n> [!NOTE]\n> To dismiss a pull request review on a [protected branch](https://docs.github.com/rest/branches/branch-protection), you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **...(description truncated)", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "pullNumber", "type": "number", "info": "The number that identifies the pull request.: 123", "required": true, "schema": { "title": "pullNumber", "type": "number" } }, { "name": "reviewId", "type": "number", "info": "The unique identifier of the review.: 123", "required": true, "schema": { "title": "reviewId", "type": "number" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/pullsDismissReview" }, "task": true }, { "name": "pullsSubmitReview", "summary": "pulls/submit-review", "description": "Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see \"[Create a review for a pull request](https://docs.github.com/rest/pulls/reviews#create-a-review-for-a-pull-request).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns...(description truncated)", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "pullNumber", "type": "number", "info": "The number that identifies the pull request.: 123", "required": true, "schema": { "title": "pullNumber", "type": "number" } }, { "name": "reviewId", "type": "number", "info": "The unique identifier of the review.: 123", "required": true, "schema": { "title": "reviewId", "type": "number" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/pullsSubmitReview" }, "task": true }, { "name": "pullsUpdateBranch", "summary": "pulls/update-branch", "description": "Updates the pull request branch with the latest upstream changes by merging HEAD from the base branch into the pull request branch.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "pullNumber", "type": "number", "info": "The number that identifies the pull request.: 123", "required": true, "schema": { "title": "pullNumber", "type": "number" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/pullsUpdateBranch" }, "task": true }, { "name": "reactionsListForTeamDiscussionCommentInOrg", "summary": "reactions/list-for-team-discussion-comment-in-org", "description": "List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment).\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "teamSlug", "type": "string", "info": "The slug of the team name.: string", "required": true, "schema": { "title": "teamSlug", "type": "string" } }, { "name": "discussionNumber", "type": "number", "info": "The number that identifies the discussion.: 123", "required": true, "schema": { "title": "discussionNumber", "type": "number" } }, { "name": "commentNumber", "type": "number", "info": "The number that identifies the comment.: 123", "required": true, "schema": { "title": "commentNumber", "type": "number" } }, { "name": "content", "type": "string", "info": "Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion comment...(description truncated): ", "required": false, "schema": { "title": "content", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reactionsListForTeamDiscussionCommentInOrg" }, "task": true }, { "name": "reactionsCreateForTeamDiscussionCommentInOrg", "summary": "reactions/create-for-team-discussion-comment-in-org", "description": "Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment).\n\nA response with an HTTP `200` status means that you already added the reaction type to this team discussion comment.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`.\n\nOAuth app tokens and personal access tokens (classic) ne...(description truncated)", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "teamSlug", "type": "string", "info": "The slug of the team name.: string", "required": true, "schema": { "title": "teamSlug", "type": "string" } }, { "name": "discussionNumber", "type": "number", "info": "The number that identifies the discussion.: 123", "required": true, "schema": { "title": "discussionNumber", "type": "number" } }, { "name": "commentNumber", "type": "number", "info": "The number that identifies the comment.: 123", "required": true, "schema": { "title": "commentNumber", "type": "number" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reactionsCreateForTeamDiscussionCommentInOrg" }, "task": true }, { "name": "reactionsDeleteForTeamDiscussionComment", "summary": "reactions/delete-for-team-discussion-comment", "description": "> [!NOTE]\n> You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`.\n\nDelete a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment).\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "teamSlug", "type": "string", "info": "The slug of the team name.: string", "required": true, "schema": { "title": "teamSlug", "type": "string" } }, { "name": "discussionNumber", "type": "number", "info": "The number that identifies the discussion.: 123", "required": true, "schema": { "title": "discussionNumber", "type": "number" } }, { "name": "commentNumber", "type": "number", "info": "The number that identifies the comment.: 123", "required": true, "schema": { "title": "commentNumber", "type": "number" } }, { "name": "reactionId", "type": "number", "info": "The unique identifier of the reaction.: 123", "required": true, "schema": { "title": "reactionId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reactionsDeleteForTeamDiscussionComment" }, "task": true }, { "name": "reactionsListForTeamDiscussionInOrg", "summary": "reactions/list-for-team-discussion-in-org", "description": "List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion).\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "teamSlug", "type": "string", "info": "The slug of the team name.: string", "required": true, "schema": { "title": "teamSlug", "type": "string" } }, { "name": "discussionNumber", "type": "number", "info": "The number that identifies the discussion.: 123", "required": true, "schema": { "title": "discussionNumber", "type": "number" } }, { "name": "content", "type": "string", "info": "Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion.: ", "required": false, "schema": { "title": "content", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reactionsListForTeamDiscussionInOrg" }, "task": true }, { "name": "reactionsCreateForTeamDiscussionInOrg", "summary": "reactions/create-for-team-discussion-in-org", "description": "Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion).\n\nA response with an HTTP `200` status means that you already added the reaction type to this team discussion.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "teamSlug", "type": "string", "info": "The slug of the team name.: string", "required": true, "schema": { "title": "teamSlug", "type": "string" } }, { "name": "discussionNumber", "type": "number", "info": "The number that identifies the discussion.: 123", "required": true, "schema": { "title": "discussionNumber", "type": "number" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reactionsCreateForTeamDiscussionInOrg" }, "task": true }, { "name": "reactionsDeleteForTeamDiscussion", "summary": "reactions/delete-for-team-discussion", "description": "> [!NOTE]\n> You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`.\n\nDelete a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion).\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "teamSlug", "type": "string", "info": "The slug of the team name.: string", "required": true, "schema": { "title": "teamSlug", "type": "string" } }, { "name": "discussionNumber", "type": "number", "info": "The number that identifies the discussion.: 123", "required": true, "schema": { "title": "discussionNumber", "type": "number" } }, { "name": "reactionId", "type": "number", "info": "The unique identifier of the reaction.: 123", "required": true, "schema": { "title": "reactionId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reactionsDeleteForTeamDiscussion" }, "task": true }, { "name": "reactionsListForCommitComment", "summary": "reactions/list-for-commit-comment", "description": "List the reactions to a [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment).", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "commentId", "type": "number", "info": "The unique identifier of the comment.: 123", "required": true, "schema": { "title": "commentId", "type": "number" } }, { "name": "content", "type": "string", "info": "Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a commit comment.: ", "required": false, "schema": { "title": "content", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reactionsListForCommitComment" }, "task": true }, { "name": "reactionsCreateForCommitComment", "summary": "reactions/create-for-commit-comment", "description": "Create a reaction to a [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment). A response with an HTTP `200` status means that you already added the reaction type to this commit comment.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "commentId", "type": "number", "info": "The unique identifier of the comment.: 123", "required": true, "schema": { "title": "commentId", "type": "number" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reactionsCreateForCommitComment" }, "task": true }, { "name": "reactionsDeleteForCommitComment", "summary": "reactions/delete-for-commit-comment", "description": "> [!NOTE]\n> You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`.\n\nDelete a reaction to a [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment).", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "commentId", "type": "number", "info": "The unique identifier of the comment.: 123", "required": true, "schema": { "title": "commentId", "type": "number" } }, { "name": "reactionId", "type": "number", "info": "The unique identifier of the reaction.: 123", "required": true, "schema": { "title": "reactionId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reactionsDeleteForCommitComment" }, "task": true }, { "name": "reactionsListForIssueComment", "summary": "reactions/list-for-issue-comment", "description": "List the reactions to an [issue comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment).", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "commentId", "type": "number", "info": "The unique identifier of the comment.: 123", "required": true, "schema": { "title": "commentId", "type": "number" } }, { "name": "content", "type": "string", "info": "Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue comment.: ", "required": false, "schema": { "title": "content", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reactionsListForIssueComment" }, "task": true }, { "name": "reactionsCreateForIssueComment", "summary": "reactions/create-for-issue-comment", "description": "Create a reaction to an [issue comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment). A response with an HTTP `200` status means that you already added the reaction type to this issue comment.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "commentId", "type": "number", "info": "The unique identifier of the comment.: 123", "required": true, "schema": { "title": "commentId", "type": "number" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reactionsCreateForIssueComment" }, "task": true }, { "name": "reactionsDeleteForIssueComment", "summary": "reactions/delete-for-issue-comment", "description": "> [!NOTE]\n> You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`.\n\nDelete a reaction to an [issue comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment).", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "commentId", "type": "number", "info": "The unique identifier of the comment.: 123", "required": true, "schema": { "title": "commentId", "type": "number" } }, { "name": "reactionId", "type": "number", "info": "The unique identifier of the reaction.: 123", "required": true, "schema": { "title": "reactionId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reactionsDeleteForIssueComment" }, "task": true }, { "name": "reactionsListForIssue", "summary": "reactions/list-for-issue", "description": "List the reactions to an [issue](https://docs.github.com/rest/issues/issues#get-an-issue).", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "issueNumber", "type": "number", "info": "The number that identifies the issue.: 123", "required": true, "schema": { "title": "issueNumber", "type": "number" } }, { "name": "content", "type": "string", "info": "Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue.: ", "required": false, "schema": { "title": "content", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reactionsListForIssue" }, "task": true }, { "name": "reactionsCreateForIssue", "summary": "reactions/create-for-issue", "description": "Create a reaction to an [issue](https://docs.github.com/rest/issues/issues#get-an-issue). A response with an HTTP `200` status means that you already added the reaction type to this issue.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "issueNumber", "type": "number", "info": "The number that identifies the issue.: 123", "required": true, "schema": { "title": "issueNumber", "type": "number" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reactionsCreateForIssue" }, "task": true }, { "name": "reactionsDeleteForIssue", "summary": "reactions/delete-for-issue", "description": "> [!NOTE]\n> You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`.\n\nDelete a reaction to an [issue](https://docs.github.com/rest/issues/issues#get-an-issue).", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "issueNumber", "type": "number", "info": "The number that identifies the issue.: 123", "required": true, "schema": { "title": "issueNumber", "type": "number" } }, { "name": "reactionId", "type": "number", "info": "The unique identifier of the reaction.: 123", "required": true, "schema": { "title": "reactionId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reactionsDeleteForIssue" }, "task": true }, { "name": "reactionsListForPullRequestReviewComment", "summary": "reactions/list-for-pull-request-review-comment", "description": "List the reactions to a [pull request review comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request).", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "commentId", "type": "number", "info": "The unique identifier of the comment.: 123", "required": true, "schema": { "title": "commentId", "type": "number" } }, { "name": "content", "type": "string", "info": "Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a pull request review com...(description truncated): ", "required": false, "schema": { "title": "content", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reactionsListForPullRequestReviewComment" }, "task": true }, { "name": "reactionsCreateForPullRequestReviewComment", "summary": "reactions/create-for-pull-request-review-comment", "description": "Create a reaction to a [pull request review comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request). A response with an HTTP `200` status means that you already added the reaction type to this pull request review comment.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "commentId", "type": "number", "info": "The unique identifier of the comment.: 123", "required": true, "schema": { "title": "commentId", "type": "number" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reactionsCreateForPullRequestReviewComment" }, "task": true }, { "name": "reactionsDeleteForPullRequestComment", "summary": "reactions/delete-for-pull-request-comment", "description": "> [!NOTE]\n> You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.`\n\nDelete a reaction to a [pull request review comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request).", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "commentId", "type": "number", "info": "The unique identifier of the comment.: 123", "required": true, "schema": { "title": "commentId", "type": "number" } }, { "name": "reactionId", "type": "number", "info": "The unique identifier of the reaction.: 123", "required": true, "schema": { "title": "reactionId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reactionsDeleteForPullRequestComment" }, "task": true }, { "name": "reactionsListForRelease", "summary": "reactions/list-for-release", "description": "List the reactions to a [release](https://docs.github.com/rest/releases/releases#get-a-release).", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "releaseId", "type": "number", "info": "The unique identifier of the release.: 123", "required": true, "schema": { "title": "releaseId", "type": "number" } }, { "name": "content", "type": "string", "info": "Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a release.: ", "required": false, "schema": { "title": "content", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reactionsListForRelease" }, "task": true }, { "name": "reactionsCreateForRelease", "summary": "reactions/create-for-release", "description": "Create a reaction to a [release](https://docs.github.com/rest/releases/releases#get-a-release). A response with a `Status: 200 OK` means that you already added the reaction type to this release.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "releaseId", "type": "number", "info": "The unique identifier of the release.: 123", "required": true, "schema": { "title": "releaseId", "type": "number" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reactionsCreateForRelease" }, "task": true }, { "name": "reactionsDeleteForRelease", "summary": "reactions/delete-for-release", "description": "> [!NOTE]\n> You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id`.\n\nDelete a reaction to a [release](https://docs.github.com/rest/releases/releases#get-a-release).", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "releaseId", "type": "number", "info": "The unique identifier of the release.: 123", "required": true, "schema": { "title": "releaseId", "type": "number" } }, { "name": "reactionId", "type": "number", "info": "The unique identifier of the reaction.: 123", "required": true, "schema": { "title": "reactionId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reactionsDeleteForRelease" }, "task": true }, { "name": "reactionsListForTeamDiscussionCommentLegacy", "summary": "reactions/list-for-team-discussion-comment-legacy", "description": "> [!WARNING]\n> **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint.\n\nList the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment).\n\nOAuth app tokens and personal access token...(description truncated)", "input": [ { "name": "teamId", "type": "number", "info": "The unique identifier of the team.: 123", "required": true, "schema": { "title": "teamId", "type": "number" } }, { "name": "discussionNumber", "type": "number", "info": "The number that identifies the discussion.: 123", "required": true, "schema": { "title": "discussionNumber", "type": "number" } }, { "name": "commentNumber", "type": "number", "info": "The number that identifies the comment.: 123", "required": true, "schema": { "title": "commentNumber", "type": "number" } }, { "name": "content", "type": "string", "info": "Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion comment...(description truncated): ", "required": false, "schema": { "title": "content", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reactionsListForTeamDiscussionCommentLegacy" }, "task": true }, { "name": "reactionsCreateForTeamDiscussionCommentLegacy", "summary": "reactions/create-for-team-discussion-comment-legacy", "description": "> [!WARNING]\n> **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new \"[Create reaction for a team discussion comment](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)\" endpoint.\n\nCreate a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment).\n\nA response with an HTTP `200` status mean...(description truncated)", "input": [ { "name": "teamId", "type": "number", "info": "The unique identifier of the team.: 123", "required": true, "schema": { "title": "teamId", "type": "number" } }, { "name": "discussionNumber", "type": "number", "info": "The number that identifies the discussion.: 123", "required": true, "schema": { "title": "discussionNumber", "type": "number" } }, { "name": "commentNumber", "type": "number", "info": "The number that identifies the comment.: 123", "required": true, "schema": { "title": "commentNumber", "type": "number" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reactionsCreateForTeamDiscussionCommentLegacy" }, "task": true }, { "name": "reactionsListForTeamDiscussionLegacy", "summary": "reactions/list-for-team-discussion-legacy", "description": "> [!WARNING]\n> **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint.\n\nList the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion).\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` s...(description truncated)", "input": [ { "name": "teamId", "type": "number", "info": "The unique identifier of the team.: 123", "required": true, "schema": { "title": "teamId", "type": "number" } }, { "name": "discussionNumber", "type": "number", "info": "The number that identifies the discussion.: 123", "required": true, "schema": { "title": "discussionNumber", "type": "number" } }, { "name": "content", "type": "string", "info": "Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion.: ", "required": false, "schema": { "title": "content", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reactionsListForTeamDiscussionLegacy" }, "task": true }, { "name": "reactionsCreateForTeamDiscussionLegacy", "summary": "reactions/create-for-team-discussion-legacy", "description": "> [!WARNING]\n> **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint.\n\nCreate a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion).\n\nA response with an HTTP `200` status means that you already added the reaction ty...(description truncated)", "input": [ { "name": "teamId", "type": "number", "info": "The unique identifier of the team.: 123", "required": true, "schema": { "title": "teamId", "type": "number" } }, { "name": "discussionNumber", "type": "number", "info": "The number that identifies the discussion.: 123", "required": true, "schema": { "title": "discussionNumber", "type": "number" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reactionsCreateForTeamDiscussionLegacy" }, "task": true }, { "name": "searchCommits", "summary": "search/commits", "description": "Find commits via various criteria on the default branch (usually `main`). This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for commits, you can get text match metadata for the **message** field when you provide the `text-match` media type. For more details about how to receive highlighted search results, see [Text match\nmetadata](https://docs.github.com/rest/search/search#text-match-metadata).\n\nFor example, if...(description truncated)", "input": [ { "name": "q", "type": "string", "info": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same quali...(description truncated): string", "required": true, "schema": { "title": "q", "type": "string" } }, { "name": "sort", "type": "string", "info": "Sorts the results of your query by `author-date` or `committer-date`. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results): ", "required": false, "schema": { "title": "sort", "type": "string" } }, { "name": "order", "type": "string", "info": "Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you pr...(description truncated): ", "required": false, "schema": { "title": "order", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/searchCommits" }, "task": true }, { "name": "searchLabels", "summary": "search/labels", "description": "Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for labels, you can get text match metadata for the label **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata)....(description truncated)", "input": [ { "name": "repositoryId", "type": "number", "info": "The id of the repository.: 123", "required": true, "schema": { "title": "repositoryId", "type": "number" } }, { "name": "q", "type": "string", "info": "The search keywords. This endpoint does not accept qualifiers in the query. To learn more about the format of the query, see [Constructing a search query](https://docs.gi...(description truncated): string", "required": true, "schema": { "title": "q", "type": "string" } }, { "name": "sort", "type": "string", "info": "Sorts the results of your query by when the label was `created` or `updated`. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results): ", "required": false, "schema": { "title": "sort", "type": "string" } }, { "name": "order", "type": "string", "info": "Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you pr...(description truncated): ", "required": false, "schema": { "title": "order", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/searchLabels" }, "task": true }, { "name": "getSearchRepositoriesQuery", "summary": "search/repos", "description": "Find repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for repositories, you can get text match metadata for the **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata).\n\nFor example, if you want to s...(description truncated)", "input": [ { "name": "q", "type": "string", "info": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same quali...(description truncated): string", "required": true, "schema": { "title": "q", "type": "string" } }, { "name": "sort", "type": "string", "info": "Sorts the results of your query by number of `stars`, `forks`, or `help-wanted-issues` or how recently the items were `updated`. Default: [best match](https://docs.github...(description truncated): ", "required": false, "schema": { "title": "sort", "type": "string" } }, { "name": "order", "type": "string", "info": "Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you pr...(description truncated): ", "required": false, "schema": { "title": "order", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getSearchRepositoriesQuery" }, "task": true }, { "name": "searchTopics", "summary": "search/topics", "description": "Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). See \"[Searching topics](https://docs.github.com/articles/searching-topics/)\" for a detailed list of qualifiers.\n\nWhen searching for topics, you can get text match metadata for the topic's **short\\_description**, **description**, **name**, or **display\\_name** field when you pass the `text-match` media type. For...(description truncated)", "input": [ { "name": "q", "type": "string", "info": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same quali...(description truncated): string", "required": true, "schema": { "title": "q", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/searchTopics" }, "task": true }, { "name": "getSearchUsersQuery", "summary": "search/users", "description": "Find users via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for users, you can get text match metadata for the issue **login**, public **email**, and **name** fields when you pass the `text-match` media type. For more details about highlighting search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). For more details about how to receive h...(description truncated)", "input": [ { "name": "q", "type": "string", "info": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same quali...(description truncated): string", "required": true, "schema": { "title": "q", "type": "string" } }, { "name": "sort", "type": "string", "info": "Sorts the results of your query by number of `followers` or `repositories`, or when the person `joined` GitHub. Default: [best match](https://docs.github.com/rest/search/...(description truncated): ", "required": false, "schema": { "title": "sort", "type": "string" } }, { "name": "order", "type": "string", "info": "Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you pr...(description truncated): ", "required": false, "schema": { "title": "order", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getSearchUsersQuery" }, "task": true }, { "name": "secretScanningListAlertsForEnterprise", "summary": "secret-scanning/list-alerts-for-enterprise", "description": "Lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest.\n\nAlerts are only returned for organizations in the enterprise for which the authenticated user is an organization owner or a [security manager](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\n\nThe authenticated user must be a member of the enterprise in order to use this endpoint.\n\nOAuth app tokens and pers...(description truncated)", "input": [ { "name": "enterprise", "type": "string", "info": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.: string", "required": true, "schema": { "title": "enterprise", "type": "string" } }, { "name": "state", "type": "string", "info": "Set to `open` or `resolved` to only list secret scanning alerts in a specific state.: ", "required": false, "schema": { "title": "state", "type": "string" } }, { "name": "secretType", "type": "string", "info": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[Supported secret scanning patterns](https://docs.github.com/code-securit...(description truncated): string", "required": false, "schema": { "title": "secretType", "type": "string" } }, { "name": "resolution", "type": "string", "info": "A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`...(description truncated): string", "required": false, "schema": { "title": "resolution", "type": "string" } }, { "name": "sort", "type": "string", "info": "The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved.: ", "required": false, "schema": { "title": "sort", "type": "string" } }, { "name": "direction", "type": "string", "info": "The direction to sort the results by.: ", "required": false, "schema": { "title": "direction", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "before", "type": "string", "info": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches fo...(description truncated): string", "required": false, "schema": { "title": "before", "type": "string" } }, { "name": "after", "type": "string", "info": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches fo...(description truncated): string", "required": false, "schema": { "title": "after", "type": "string" } }, { "name": "validity", "type": "string", "info": "A comma-separated list of validities that, when present, will return alerts that match the validities in this list. Valid options are `active`, `inactive`, and `unknown`.: string", "required": false, "schema": { "title": "validity", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/secretScanningListAlertsForEnterprise" }, "task": true }, { "name": "secretScanningListAlertsForOrg", "summary": "secret-scanning/list-alerts-for-org", "description": "Lists secret scanning alerts for eligible repositories in an organization, from newest to oldest.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "state", "type": "string", "info": "Set to `open` or `resolved` to only list secret scanning alerts in a specific state.: ", "required": false, "schema": { "title": "state", "type": "string" } }, { "name": "secretType", "type": "string", "info": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[Supported secret scanning patterns](https://docs.github.com/code-securit...(description truncated): string", "required": false, "schema": { "title": "secretType", "type": "string" } }, { "name": "resolution", "type": "string", "info": "A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`...(description truncated): string", "required": false, "schema": { "title": "resolution", "type": "string" } }, { "name": "sort", "type": "string", "info": "The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved.: ", "required": false, "schema": { "title": "sort", "type": "string" } }, { "name": "direction", "type": "string", "info": "The direction to sort the results by.: ", "required": false, "schema": { "title": "direction", "type": "string" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "before", "type": "string", "info": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches fo...(description truncated): string", "required": false, "schema": { "title": "before", "type": "string" } }, { "name": "after", "type": "string", "info": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches fo...(description truncated): string", "required": false, "schema": { "title": "after", "type": "string" } }, { "name": "validity", "type": "string", "info": "A comma-separated list of validities that, when present, will return alerts that match the validities in this list. Valid options are `active`, `inactive`, and `unknown`.: string", "required": false, "schema": { "title": "validity", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/secretScanningListAlertsForOrg" }, "task": true }, { "name": "secretScanningListAlertsForRepo", "summary": "secret-scanning/list-alerts-for-repo", "description": "Lists secret scanning alerts for an eligible repository, from newest to oldest.\n\nThe authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "state", "type": "string", "info": "Set to `open` or `resolved` to only list secret scanning alerts in a specific state.: ", "required": false, "schema": { "title": "state", "type": "string" } }, { "name": "secretType", "type": "string", "info": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[Supported secret scanning patterns](https://docs.github.com/code-securit...(description truncated): string", "required": false, "schema": { "title": "secretType", "type": "string" } }, { "name": "resolution", "type": "string", "info": "A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`...(description truncated): string", "required": false, "schema": { "title": "resolution", "type": "string" } }, { "name": "sort", "type": "string", "info": "The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved.: ", "required": false, "schema": { "title": "sort", "type": "string" } }, { "name": "direction", "type": "string", "info": "The direction to sort the results by.: ", "required": false, "schema": { "title": "direction", "type": "string" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "before", "type": "string", "info": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches fo...(description truncated): string", "required": false, "schema": { "title": "before", "type": "string" } }, { "name": "after", "type": "string", "info": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches fo...(description truncated): string", "required": false, "schema": { "title": "after", "type": "string" } }, { "name": "validity", "type": "string", "info": "A comma-separated list of validities that, when present, will return alerts that match the validities in this list. Valid options are `active`, `inactive`, and `unknown`.: string", "required": false, "schema": { "title": "validity", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/secretScanningListAlertsForRepo" }, "task": true }, { "name": "secretScanningGetAlert", "summary": "secret-scanning/get-alert", "description": "Gets a single secret scanning alert detected in an eligible repository.\n\nThe authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "alertNumber", "type": "number", "info": "The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `...(description truncated): 123", "required": true, "schema": { "title": "alertNumber", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/secretScanningGetAlert" }, "task": true }, { "name": "secretScanningUpdateAlert", "summary": "secret-scanning/update-alert", "description": "Updates the status of a secret scanning alert in an eligible repository.\n\nThe authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "alertNumber", "type": "number", "info": "The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `...(description truncated): 123", "required": true, "schema": { "title": "alertNumber", "type": "number" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/secretScanningUpdateAlert" }, "task": true }, { "name": "secretScanningListLocationsForAlert", "summary": "secret-scanning/list-locations-for-alert", "description": "Lists all locations for a given secret scanning alert for an eligible repository.\n\nThe authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "alertNumber", "type": "number", "info": "The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `...(description truncated): 123", "required": true, "schema": { "title": "alertNumber", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/secretScanningListLocationsForAlert" }, "task": true }, { "name": "secretScanningCreatePushProtectionBypass", "summary": "secret-scanning/create-push-protection-bypass", "description": "Creates a bypass for a previously push protected secret.\n\nThe authenticated user must be the original author of the committed secret.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/secretScanningCreatePushProtectionBypass" }, "task": true }, { "name": "teamsGetByName", "summary": "teams/get-by-name", "description": "Gets a team using the team's `slug`. To create the `slug`, GitHub replaces special characters in the `name` string, changes all words to lowercase, and replaces spaces with a `-` separator. For example, `\"My TEam Näme\"` would become `my-team-name`.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "teamSlug", "type": "string", "info": "The slug of the team name.: string", "required": true, "schema": { "title": "teamSlug", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/teamsGetByName" }, "task": true }, { "name": "teamsUpdateInOrg", "summary": "teams/update-in-org", "description": "To edit a team, the authenticated user must either be an organization owner or a team maintainer.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "teamSlug", "type": "string", "info": "The slug of the team name.: string", "required": true, "schema": { "title": "teamSlug", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/teamsUpdateInOrg" }, "task": true }, { "name": "teamsDeleteInOrg", "summary": "teams/delete-in-org", "description": "To delete a team, the authenticated user must be an organization owner or team maintainer.\n\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "teamSlug", "type": "string", "info": "The slug of the team name.: string", "required": true, "schema": { "title": "teamSlug", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/teamsDeleteInOrg" }, "task": true }, { "name": "teamsListDiscussionsInOrg", "summary": "teams/list-discussions-in-org", "description": "List all discussions on a team's page.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "teamSlug", "type": "string", "info": "The slug of the team name.: string", "required": true, "schema": { "title": "teamSlug", "type": "string" } }, { "name": "direction", "type": "string", "info": "The direction to sort the results by.: ", "required": false, "schema": { "title": "direction", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "pinned", "type": "string", "info": "Pinned discussions only filter: string", "required": false, "schema": { "title": "pinned", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/teamsListDiscussionsInOrg" }, "task": true }, { "name": "teamsCreateDiscussionInOrg", "summary": "teams/create-discussion-in-org", "description": "Creates a new discussion post on a team's page.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.gi...(description truncated)", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "teamSlug", "type": "string", "info": "The slug of the team name.: string", "required": true, "schema": { "title": "teamSlug", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/teamsCreateDiscussionInOrg" }, "task": true }, { "name": "teamsGetDiscussionInOrg", "summary": "teams/get-discussion-in-org", "description": "Get a specific discussion on a team's page.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "teamSlug", "type": "string", "info": "The slug of the team name.: string", "required": true, "schema": { "title": "teamSlug", "type": "string" } }, { "name": "discussionNumber", "type": "number", "info": "The number that identifies the discussion.: 123", "required": true, "schema": { "title": "discussionNumber", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/teamsGetDiscussionInOrg" }, "task": true }, { "name": "teamsUpdateDiscussionInOrg", "summary": "teams/update-discussion-in-org", "description": "Edits the title and body text of a discussion post. Only the parameters you provide are updated.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "teamSlug", "type": "string", "info": "The slug of the team name.: string", "required": true, "schema": { "title": "teamSlug", "type": "string" } }, { "name": "discussionNumber", "type": "number", "info": "The number that identifies the discussion.: 123", "required": true, "schema": { "title": "discussionNumber", "type": "number" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/teamsUpdateDiscussionInOrg" }, "task": true }, { "name": "teamsDeleteDiscussionInOrg", "summary": "teams/delete-discussion-in-org", "description": "Delete a discussion from a team's page.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "teamSlug", "type": "string", "info": "The slug of the team name.: string", "required": true, "schema": { "title": "teamSlug", "type": "string" } }, { "name": "discussionNumber", "type": "number", "info": "The number that identifies the discussion.: 123", "required": true, "schema": { "title": "discussionNumber", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/teamsDeleteDiscussionInOrg" }, "task": true }, { "name": "teamsListDiscussionCommentsInOrg", "summary": "teams/list-discussion-comments-in-org", "description": "List all comments on a team discussion.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "teamSlug", "type": "string", "info": "The slug of the team name.: string", "required": true, "schema": { "title": "teamSlug", "type": "string" } }, { "name": "discussionNumber", "type": "number", "info": "The number that identifies the discussion.: 123", "required": true, "schema": { "title": "discussionNumber", "type": "number" } }, { "name": "direction", "type": "string", "info": "The direction to sort the results by.: ", "required": false, "schema": { "title": "direction", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/teamsListDiscussionCommentsInOrg" }, "task": true }, { "name": "teamsCreateDiscussionCommentInOrg", "summary": "teams/create-discussion-comment-in-org", "description": "Creates a new comment on a team discussion.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github...(description truncated)", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "teamSlug", "type": "string", "info": "The slug of the team name.: string", "required": true, "schema": { "title": "teamSlug", "type": "string" } }, { "name": "discussionNumber", "type": "number", "info": "The number that identifies the discussion.: 123", "required": true, "schema": { "title": "discussionNumber", "type": "number" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/teamsCreateDiscussionCommentInOrg" }, "task": true }, { "name": "teamsGetDiscussionCommentInOrg", "summary": "teams/get-discussion-comment-in-org", "description": "Get a specific comment on a team discussion.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "teamSlug", "type": "string", "info": "The slug of the team name.: string", "required": true, "schema": { "title": "teamSlug", "type": "string" } }, { "name": "discussionNumber", "type": "number", "info": "The number that identifies the discussion.: 123", "required": true, "schema": { "title": "discussionNumber", "type": "number" } }, { "name": "commentNumber", "type": "number", "info": "The number that identifies the comment.: 123", "required": true, "schema": { "title": "commentNumber", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/teamsGetDiscussionCommentInOrg" }, "task": true }, { "name": "teamsUpdateDiscussionCommentInOrg", "summary": "teams/update-discussion-comment-in-org", "description": "Edits the body text of a discussion comment.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "teamSlug", "type": "string", "info": "The slug of the team name.: string", "required": true, "schema": { "title": "teamSlug", "type": "string" } }, { "name": "discussionNumber", "type": "number", "info": "The number that identifies the discussion.: 123", "required": true, "schema": { "title": "discussionNumber", "type": "number" } }, { "name": "commentNumber", "type": "number", "info": "The number that identifies the comment.: 123", "required": true, "schema": { "title": "commentNumber", "type": "number" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/teamsUpdateDiscussionCommentInOrg" }, "task": true }, { "name": "teamsDeleteDiscussionCommentInOrg", "summary": "teams/delete-discussion-comment-in-org", "description": "Deletes a comment on a team discussion.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "teamSlug", "type": "string", "info": "The slug of the team name.: string", "required": true, "schema": { "title": "teamSlug", "type": "string" } }, { "name": "discussionNumber", "type": "number", "info": "The number that identifies the discussion.: 123", "required": true, "schema": { "title": "discussionNumber", "type": "number" } }, { "name": "commentNumber", "type": "number", "info": "The number that identifies the comment.: 123", "required": true, "schema": { "title": "commentNumber", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/teamsDeleteDiscussionCommentInOrg" }, "task": true }, { "name": "teamsListPendingInvitationsInOrg", "summary": "teams/list-pending-invitations-in-org", "description": "The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/invitations`.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "teamSlug", "type": "string", "info": "The slug of the team name.: string", "required": true, "schema": { "title": "teamSlug", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/teamsListPendingInvitationsInOrg" }, "task": true }, { "name": "teamsListMembersInOrg", "summary": "teams/list-members-in-org", "description": "Team members will include the members of child teams.\n\nTo list members in a team, the team must be visible to the authenticated user.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "teamSlug", "type": "string", "info": "The slug of the team name.: string", "required": true, "schema": { "title": "teamSlug", "type": "string" } }, { "name": "role", "type": "string", "info": "Filters members returned by their role in the team.: ", "required": false, "schema": { "title": "role", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/teamsListMembersInOrg" }, "task": true }, { "name": "teamsGetMembershipForUserInOrg", "summary": "teams/get-membership-for-user-in-org", "description": "Team members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`.\n\n> [!NOTE]\n> The response contains the `state` of the membership and the member's `role`.\n\nThe `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see ...(description truncated)", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "teamSlug", "type": "string", "info": "The slug of the team name.: string", "required": true, "schema": { "title": "teamSlug", "type": "string" } }, { "name": "username", "type": "string", "info": "The handle for the GitHub user account.: string", "required": true, "schema": { "title": "username", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/teamsGetMembershipForUserInOrg" }, "task": true }, { "name": "teamsAddOrUpdateMembershipForUserInOrg", "summary": "teams/add-or-update-membership-for-user-in-org", "description": "Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will ...(description truncated)", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "teamSlug", "type": "string", "info": "The slug of the team name.: string", "required": true, "schema": { "title": "teamSlug", "type": "string" } }, { "name": "username", "type": "string", "info": "The handle for the GitHub user account.: string", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/teamsAddOrUpdateMembershipForUserInOrg" }, "task": true }, { "name": "teamsRemoveMembershipForUserInOrg", "summary": "teams/remove-membership-for-user-in-org", "description": "To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the Git...(description truncated)", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "teamSlug", "type": "string", "info": "The slug of the team name.: string", "required": true, "schema": { "title": "teamSlug", "type": "string" } }, { "name": "username", "type": "string", "info": "The handle for the GitHub user account.: string", "required": true, "schema": { "title": "username", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/teamsRemoveMembershipForUserInOrg" }, "task": true }, { "name": "teamsListProjectsInOrg", "summary": "teams/list-projects-in-org", "description": "Lists the organization projects for a team.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "teamSlug", "type": "string", "info": "The slug of the team name.: string", "required": true, "schema": { "title": "teamSlug", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/teamsListProjectsInOrg" }, "task": true }, { "name": "teamsCheckPermissionsForProjectInOrg", "summary": "teams/check-permissions-for-project-in-org", "description": "Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "teamSlug", "type": "string", "info": "The slug of the team name.: string", "required": true, "schema": { "title": "teamSlug", "type": "string" } }, { "name": "projectId", "type": "number", "info": "The unique identifier of the project.: 123", "required": true, "schema": { "title": "projectId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/teamsCheckPermissionsForProjectInOrg" }, "task": true }, { "name": "teamsAddOrUpdateProjectPermissionsInOrg", "summary": "teams/add-or-update-project-permissions-in-org", "description": "Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "teamSlug", "type": "string", "info": "The slug of the team name.: string", "required": true, "schema": { "title": "teamSlug", "type": "string" } }, { "name": "projectId", "type": "number", "info": "The unique identifier of the project.: 123", "required": true, "schema": { "title": "projectId", "type": "number" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/teamsAddOrUpdateProjectPermissionsInOrg" }, "task": true }, { "name": "teamsRemoveProjectInOrg", "summary": "teams/remove-project-in-org", "description": "Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. This endpoint removes the project from the team, but does not delete the project.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}...(description truncated)", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "teamSlug", "type": "string", "info": "The slug of the team name.: string", "required": true, "schema": { "title": "teamSlug", "type": "string" } }, { "name": "projectId", "type": "number", "info": "The unique identifier of the project.: 123", "required": true, "schema": { "title": "projectId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/teamsRemoveProjectInOrg" }, "task": true }, { "name": "teamsListReposInOrg", "summary": "teams/list-repos-in-org", "description": "Lists a team's repositories visible to the authenticated user.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "teamSlug", "type": "string", "info": "The slug of the team name.: string", "required": true, "schema": { "title": "teamSlug", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/teamsListReposInOrg" }, "task": true }, { "name": "teamsCheckPermissionsForRepoInOrg", "summary": "teams/check-permissions-for-repo-in-org", "description": "Checks whether a team has `admin`, `push`, `maintain`, `triage`, or `pull` permission for a repository. Repositories inherited through a parent team will also be checked.\n\nYou can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types/) via the `application/vnd.github.v3.repository+json` accept header.\n\nIf a tea...(description truncated)", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "teamSlug", "type": "string", "info": "The slug of the team name.: string", "required": true, "schema": { "title": "teamSlug", "type": "string" } }, { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/teamsCheckPermissionsForRepoInOrg" }, "task": true }, { "name": "teamsAddOrUpdateRepoPermissionsInOrg", "summary": "teams/add-or-update-repo-permissions-in-org", "description": "To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Conten...(description truncated)", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "teamSlug", "type": "string", "info": "The slug of the team name.: string", "required": true, "schema": { "title": "teamSlug", "type": "string" } }, { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/teamsAddOrUpdateRepoPermissionsInOrg" }, "task": true }, { "name": "teamsRemoveRepoInOrg", "summary": "teams/remove-repo-in-org", "description": "If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{rep...(description truncated)", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "teamSlug", "type": "string", "info": "The slug of the team name.: string", "required": true, "schema": { "title": "teamSlug", "type": "string" } }, { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/teamsRemoveRepoInOrg" }, "task": true }, { "name": "teamsListChildInOrg", "summary": "teams/list-child-in-org", "description": "Lists the child teams of the team specified by `{team_slug}`.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "teamSlug", "type": "string", "info": "The slug of the team name.: string", "required": true, "schema": { "title": "teamSlug", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/teamsListChildInOrg" }, "task": true }, { "name": "teamsListDiscussionsLegacy", "summary": "teams/list-discussions-legacy", "description": "> [!WARNING]\n> **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/rest/teams/discussions#list-discussions) endpoint.\n\nList all discussions on a team's page.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", "input": [ { "name": "teamId", "type": "number", "info": "The unique identifier of the team.: 123", "required": true, "schema": { "title": "teamId", "type": "number" } }, { "name": "direction", "type": "string", "info": "The direction to sort the results by.: ", "required": false, "schema": { "title": "direction", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/teamsListDiscussionsLegacy" }, "task": true }, { "name": "teamsCreateDiscussionLegacy", "summary": "teams/create-discussion-legacy", "description": "> [!WARNING]\n> **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/rest/teams/discussions#create-a-discussion) endpoint.\n\nCreates a new discussion post on a team's page.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using ...(description truncated)", "input": [ { "name": "teamId", "type": "number", "info": "The unique identifier of the team.: 123", "required": true, "schema": { "title": "teamId", "type": "number" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/teamsCreateDiscussionLegacy" }, "task": true }, { "name": "teamsGetDiscussionLegacy", "summary": "teams/get-discussion-legacy", "description": "> [!WARNING]\n> **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion) endpoint.\n\nGet a specific discussion on a team's page.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", "input": [ { "name": "teamId", "type": "number", "info": "The unique identifier of the team.: 123", "required": true, "schema": { "title": "teamId", "type": "number" } }, { "name": "discussionNumber", "type": "number", "info": "The number that identifies the discussion.: 123", "required": true, "schema": { "title": "discussionNumber", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/teamsGetDiscussionLegacy" }, "task": true }, { "name": "teamsUpdateDiscussionLegacy", "summary": "teams/update-discussion-legacy", "description": "> [!WARNING]\n> **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/rest/teams/discussions#update-a-discussion) endpoint.\n\nEdits the title and body text of a discussion post. Only the parameters you provide are updated.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "input": [ { "name": "teamId", "type": "number", "info": "The unique identifier of the team.: 123", "required": true, "schema": { "title": "teamId", "type": "number" } }, { "name": "discussionNumber", "type": "number", "info": "The number that identifies the discussion.: 123", "required": true, "schema": { "title": "discussionNumber", "type": "number" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/teamsUpdateDiscussionLegacy" }, "task": true }, { "name": "teamsDeleteDiscussionLegacy", "summary": "teams/delete-discussion-legacy", "description": "> [!WARNING]\n> **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/rest/teams/discussions#delete-a-discussion) endpoint.\n\nDelete a discussion from a team's page.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "input": [ { "name": "teamId", "type": "number", "info": "The unique identifier of the team.: 123", "required": true, "schema": { "title": "teamId", "type": "number" } }, { "name": "discussionNumber", "type": "number", "info": "The number that identifies the discussion.: 123", "required": true, "schema": { "title": "discussionNumber", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/teamsDeleteDiscussionLegacy" }, "task": true }, { "name": "teamsListDiscussionCommentsLegacy", "summary": "teams/list-discussion-comments-legacy", "description": "> [!WARNING]\n> **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments) endpoint.\n\nList all comments on a team discussion.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", "input": [ { "name": "teamId", "type": "number", "info": "The unique identifier of the team.: 123", "required": true, "schema": { "title": "teamId", "type": "number" } }, { "name": "discussionNumber", "type": "number", "info": "The number that identifies the discussion.: 123", "required": true, "schema": { "title": "discussionNumber", "type": "number" } }, { "name": "direction", "type": "string", "info": "The direction to sort the results by.: ", "required": false, "schema": { "title": "direction", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/teamsListDiscussionCommentsLegacy" }, "task": true }, { "name": "teamsCreateDiscussionCommentLegacy", "summary": "teams/create-discussion-comment-legacy", "description": "> [!WARNING]\n> **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment) endpoint.\n\nCreates a new comment on a team discussion.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content ...(description truncated)", "input": [ { "name": "teamId", "type": "number", "info": "The unique identifier of the team.: 123", "required": true, "schema": { "title": "teamId", "type": "number" } }, { "name": "discussionNumber", "type": "number", "info": "The number that identifies the discussion.: 123", "required": true, "schema": { "title": "discussionNumber", "type": "number" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/teamsCreateDiscussionCommentLegacy" }, "task": true }, { "name": "teamsGetDiscussionCommentLegacy", "summary": "teams/get-discussion-comment-legacy", "description": "> [!WARNING]\n> **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment) endpoint.\n\nGet a specific comment on a team discussion.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", "input": [ { "name": "teamId", "type": "number", "info": "The unique identifier of the team.: 123", "required": true, "schema": { "title": "teamId", "type": "number" } }, { "name": "discussionNumber", "type": "number", "info": "The number that identifies the discussion.: 123", "required": true, "schema": { "title": "discussionNumber", "type": "number" } }, { "name": "commentNumber", "type": "number", "info": "The number that identifies the comment.: 123", "required": true, "schema": { "title": "commentNumber", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/teamsGetDiscussionCommentLegacy" }, "task": true }, { "name": "teamsUpdateDiscussionCommentLegacy", "summary": "teams/update-discussion-comment-legacy", "description": "> [!WARNING]\n> **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment) endpoint.\n\nEdits the body text of a discussion comment.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "input": [ { "name": "teamId", "type": "number", "info": "The unique identifier of the team.: 123", "required": true, "schema": { "title": "teamId", "type": "number" } }, { "name": "discussionNumber", "type": "number", "info": "The number that identifies the discussion.: 123", "required": true, "schema": { "title": "discussionNumber", "type": "number" } }, { "name": "commentNumber", "type": "number", "info": "The number that identifies the comment.: 123", "required": true, "schema": { "title": "commentNumber", "type": "number" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/teamsUpdateDiscussionCommentLegacy" }, "task": true }, { "name": "teamsDeleteDiscussionCommentLegacy", "summary": "teams/delete-discussion-comment-legacy", "description": "> [!WARNING]\n> **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint.\n\nDeletes a comment on a team discussion.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "input": [ { "name": "teamId", "type": "number", "info": "The unique identifier of the team.: 123", "required": true, "schema": { "title": "teamId", "type": "number" } }, { "name": "discussionNumber", "type": "number", "info": "The number that identifies the discussion.: 123", "required": true, "schema": { "title": "discussionNumber", "type": "number" } }, { "name": "commentNumber", "type": "number", "info": "The number that identifies the comment.: 123", "required": true, "schema": { "title": "commentNumber", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/teamsDeleteDiscussionCommentLegacy" }, "task": true }, { "name": "teamsListPendingInvitationsLegacy", "summary": "teams/list-pending-invitations-legacy", "description": "> [!WARNING]\n> **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List pending team invitations`](https://docs.github.com/rest/teams/members#list-pending-team-invitations) endpoint.\n\nThe return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If...(description truncated)", "input": [ { "name": "teamId", "type": "number", "info": "The unique identifier of the team.: 123", "required": true, "schema": { "title": "teamId", "type": "number" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/teamsListPendingInvitationsLegacy" }, "task": true }, { "name": "getTeamsTeamIdMembersQuery", "summary": "teams/list-members-legacy", "description": "> [!WARNING]\n> **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/rest/teams/members#list-team-members) endpoint.\n\nTeam members will include the members of child teams.", "input": [ { "name": "teamId", "type": "number", "info": "The unique identifier of the team.: 123", "required": true, "schema": { "title": "teamId", "type": "number" } }, { "name": "role", "type": "string", "info": "Filters members returned by their role in the team.: ", "required": false, "schema": { "title": "role", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getTeamsTeamIdMembersQuery" }, "task": true }, { "name": "teamsListProjectsLegacy", "summary": "teams/list-projects-legacy", "description": "> [!WARNING]\n> **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/rest/teams/teams#list-team-projects) endpoint.\n\nLists the organization projects for a team.", "input": [ { "name": "teamId", "type": "number", "info": "The unique identifier of the team.: 123", "required": true, "schema": { "title": "teamId", "type": "number" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/teamsListProjectsLegacy" }, "task": true }, { "name": "teamsCheckPermissionsForProjectLegacy", "summary": "teams/check-permissions-for-project-legacy", "description": "> [!WARNING]\n> **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project) endpoint.\n\nChecks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team.", "input": [ { "name": "teamId", "type": "number", "info": "The unique identifier of the team.: 123", "required": true, "schema": { "title": "teamId", "type": "number" } }, { "name": "projectId", "type": "number", "info": "The unique identifier of the project.: 123", "required": true, "schema": { "title": "projectId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/teamsCheckPermissionsForProjectLegacy" }, "task": true }, { "name": "teamsAddOrUpdateProjectPermissionsLegacy", "summary": "teams/add-or-update-project-permissions-legacy", "description": "> [!WARNING]\n> **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions) endpoint.\n\nAdds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project an...(description truncated)", "input": [ { "name": "teamId", "type": "number", "info": "The unique identifier of the team.: 123", "required": true, "schema": { "title": "teamId", "type": "number" } }, { "name": "projectId", "type": "number", "info": "The unique identifier of the project.: 123", "required": true, "schema": { "title": "projectId", "type": "number" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/teamsAddOrUpdateProjectPermissionsLegacy" }, "task": true }, { "name": "teamsRemoveProjectLegacy", "summary": "teams/remove-project-legacy", "description": "> [!WARNING]\n> **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team) endpoint.\n\nRemoves an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have...(description truncated)", "input": [ { "name": "teamId", "type": "number", "info": "The unique identifier of the team.: 123", "required": true, "schema": { "title": "teamId", "type": "number" } }, { "name": "projectId", "type": "number", "info": "The unique identifier of the project.: 123", "required": true, "schema": { "title": "projectId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/teamsRemoveProjectLegacy" }, "task": true }, { "name": "getTeamsTeamIdReposQuery", "summary": "teams/list-repos-legacy", "description": "> [!WARNING]\n> **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/rest/teams/teams#list-team-repositories) endpoint.", "input": [ { "name": "teamId", "type": "number", "info": "The unique identifier of the team.: 123", "required": true, "schema": { "title": "teamId", "type": "number" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getTeamsTeamIdReposQuery" }, "task": true }, { "name": "teamsListChildLegacy", "summary": "teams/list-child-legacy", "description": "> [!WARNING]\n> **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/rest/teams/teams#list-child-teams) endpoint.", "input": [ { "name": "teamId", "type": "number", "info": "The unique identifier of the team.: 123", "required": true, "schema": { "title": "teamId", "type": "number" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/teamsListChildLegacy" }, "task": true }, { "name": "codespacesListInOrganization", "summary": "codespaces/list-in-organization", "description": "Lists the codespaces associated to a specified organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "input": [ { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/codespacesListInOrganization" }, "task": true }, { "name": "codespacesSetCodespacesAccess", "summary": "codespaces/set-codespaces-access", "description": "Sets which users can access codespaces in an organization. This is synonymous with granting or revoking codespaces access permissions for users according to the visibility.\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/codespacesSetCodespacesAccess" }, "task": true }, { "name": "codespacesSetCodespacesAccessUsers", "summary": "codespaces/set-codespaces-access-users", "description": "Codespaces for the specified users will be billed to the organization.\n\nTo use this endpoint, the access settings for the organization must be set to `selected_members`.\nFor information on how to change this setting, see \"[Manage access control for organization codespaces](https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/codespacesSetCodespacesAccessUsers" }, "task": true }, { "name": "codespacesDeleteCodespacesAccessUsers", "summary": "codespaces/delete-codespaces-access-users", "description": "Codespaces for the specified users will no longer be billed to the organization.\n\nTo use this endpoint, the access settings for the organization must be set to `selected_members`.\nFor information on how to change this setting, see \"[Manage access control for organization codespaces](https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/codespacesDeleteCodespacesAccessUsers" }, "task": true }, { "name": "codespacesListOrgSecrets", "summary": "codespaces/list-org-secrets", "description": "Lists all Codespaces development environment secrets available at the organization-level without revealing their encrypted\nvalues.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/codespacesListOrgSecrets" }, "task": true }, { "name": "codespacesGetOrgPublicKey", "summary": "codespaces/get-org-public-key", "description": "Gets a public key for an organization, which is required in order to encrypt secrets. You need to encrypt the value of a secret before you can create or update secrets.\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/codespacesGetOrgPublicKey" }, "task": true }, { "name": "codespacesGetOrgSecret", "summary": "codespaces/get-org-secret", "description": "Gets an organization development environment secret without revealing its encrypted value.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "secretName", "type": "string", "info": "The name of the secret.: string", "required": true, "schema": { "title": "secretName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/codespacesGetOrgSecret" }, "task": true }, { "name": "codespacesCreateOrUpdateOrgSecret", "summary": "codespaces/create-or-update-org-secret", "description": "Creates or updates an organization development environment secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "secretName", "type": "string", "info": "The name of the secret.: string", "required": true, "schema": { "title": "secretName", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/codespacesCreateOrUpdateOrgSecret" }, "task": true }, { "name": "codespacesDeleteOrgSecret", "summary": "codespaces/delete-org-secret", "description": "Deletes an organization development environment secret using the secret name.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "secretName", "type": "string", "info": "The name of the secret.: string", "required": true, "schema": { "title": "secretName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/codespacesDeleteOrgSecret" }, "task": true }, { "name": "codespacesListSelectedReposForOrgSecret", "summary": "codespaces/list-selected-repos-for-org-secret", "description": "Lists all repositories that have been selected when the `visibility`\nfor repository access to a secret is set to `selected`.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "secretName", "type": "string", "info": "The name of the secret.: string", "required": true, "schema": { "title": "secretName", "type": "string" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/codespacesListSelectedReposForOrgSecret" }, "task": true }, { "name": "codespacesSetSelectedReposForOrgSecret", "summary": "codespaces/set-selected-repos-for-org-secret", "description": "Replaces all repositories for an organization development environment secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret).\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "secretName", "type": "string", "info": "The name of the secret.: string", "required": true, "schema": { "title": "secretName", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/codespacesSetSelectedReposForOrgSecret" }, "task": true }, { "name": "codespacesAddSelectedRepoToOrgSecret", "summary": "codespaces/add-selected-repo-to-org-secret", "description": "Adds a repository to an organization development environment secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret).\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "secretName", "type": "string", "info": "The name of the secret.: string", "required": true, "schema": { "title": "secretName", "type": "string" } }, { "name": "repositoryId", "type": "number", "info": ": 123", "required": true, "schema": { "title": "repositoryId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/codespacesAddSelectedRepoToOrgSecret" }, "task": true }, { "name": "codespacesRemoveSelectedRepoFromOrgSecret", "summary": "codespaces/remove-selected-repo-from-org-secret", "description": "Removes a repository from an organization development environment secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret).\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "secretName", "type": "string", "info": "The name of the secret.: string", "required": true, "schema": { "title": "secretName", "type": "string" } }, { "name": "repositoryId", "type": "number", "info": ": 123", "required": true, "schema": { "title": "repositoryId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/codespacesRemoveSelectedRepoFromOrgSecret" }, "task": true }, { "name": "codespacesGetCodespacesForUserInOrg", "summary": "codespaces/get-codespaces-for-user-in-org", "description": "Lists the codespaces that a member of an organization has for repositories in that organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "input": [ { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "username", "type": "string", "info": "The handle for the GitHub user account.: string", "required": true, "schema": { "title": "username", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/codespacesGetCodespacesForUserInOrg" }, "task": true }, { "name": "codespacesDeleteFromOrganization", "summary": "codespaces/delete-from-organization", "description": "Deletes a user's codespace.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "username", "type": "string", "info": "The handle for the GitHub user account.: string", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "codespaceName", "type": "string", "info": "The name of the codespace.: string", "required": true, "schema": { "title": "codespaceName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/codespacesDeleteFromOrganization" }, "task": true }, { "name": "codespacesStopInOrganization", "summary": "codespaces/stop-in-organization", "description": "Stops a user's codespace.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "username", "type": "string", "info": "The handle for the GitHub user account.: string", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "codespaceName", "type": "string", "info": "The name of the codespace.: string", "required": true, "schema": { "title": "codespaceName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/codespacesStopInOrganization" }, "task": true }, { "name": "codespacesListInRepositoryForAuthenticatedUser", "summary": "codespaces/list-in-repository-for-authenticated-user", "description": "Lists the codespaces associated to a specified repository and the authenticated user.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.", "input": [ { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/codespacesListInRepositoryForAuthenticatedUser" }, "task": true }, { "name": "codespacesCreateWithRepoForAuthenticatedUser", "summary": "codespaces/create-with-repo-for-authenticated-user", "description": "Creates a codespace owned by the authenticated user in the specified repository.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/codespacesCreateWithRepoForAuthenticatedUser" }, "task": true }, { "name": "codespacesListDevcontainersInRepositoryForAuthenticatedUser", "summary": "codespaces/list-devcontainers-in-repository-for-authenticated-user", "description": "Lists the devcontainer.json files associated with a specified repository and the authenticated user. These files\nspecify launchpoint configurations for codespaces created within the repository.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.", "input": [ { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/codespacesListDevcontainersInRepositoryForAuthenticatedUser" }, "task": true }, { "name": "codespacesRepoMachinesForAuthenticatedUser", "summary": "codespaces/repo-machines-for-authenticated-user", "description": "List the machine types available for a given repository based on its configuration.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "location", "type": "string", "info": "The location to check for available machines. Assigned by IP if not provided.: string", "required": false, "schema": { "title": "location", "type": "string" } }, { "name": "clientIp", "type": "string", "info": "IP for location auto-detection when proxying a request: string", "required": false, "schema": { "title": "clientIp", "type": "string" } }, { "name": "ref", "type": "string", "info": "The branch or commit to check for prebuild availability and devcontainer restrictions.: string", "required": false, "schema": { "title": "ref", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/codespacesRepoMachinesForAuthenticatedUser" }, "task": true }, { "name": "codespacesPreFlightWithRepoForAuthenticatedUser", "summary": "codespaces/pre-flight-with-repo-for-authenticated-user", "description": "Gets the default attributes for codespaces created by the user with the repository.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "ref", "type": "string", "info": "The branch or commit to check for a default devcontainer path. If not specified, the default branch will be checked.: string", "required": false, "schema": { "title": "ref", "type": "string" } }, { "name": "clientIp", "type": "string", "info": "An alternative IP for default location auto-detection, such as when proxying a request.: string", "required": false, "schema": { "title": "clientIp", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/codespacesPreFlightWithRepoForAuthenticatedUser" }, "task": true }, { "name": "codespacesCheckPermissionsForDevcontainer", "summary": "codespaces/check-permissions-for-devcontainer", "description": "Checks whether the permissions defined by a given devcontainer configuration have been accepted by the authenticated user.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "ref", "type": "string", "info": "The git reference that points to the location of the devcontainer configuration to use for the permission check. The value of `ref` will typically be a branch name (`head...(description truncated): string", "required": true, "schema": { "title": "ref", "type": "string" } }, { "name": "devcontainerPath", "type": "string", "info": "Path to the devcontainer.json configuration to use for the permission check.: string", "required": true, "schema": { "title": "devcontainerPath", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/codespacesCheckPermissionsForDevcontainer" }, "task": true }, { "name": "codespacesListRepoSecrets", "summary": "codespaces/list-repo-secrets", "description": "Lists all development environment secrets available in a repository without revealing their encrypted\nvalues.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/codespacesListRepoSecrets" }, "task": true }, { "name": "codespacesGetRepoPublicKey", "summary": "codespaces/get-repo-public-key", "description": "Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.\n\nAnyone with read access to the repository can use this endpoint.\n\nIf the repository is private, OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/codespacesGetRepoPublicKey" }, "task": true }, { "name": "codespacesGetRepoSecret", "summary": "codespaces/get-repo-secret", "description": "Gets a single repository development environment secret without revealing its encrypted value.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "secretName", "type": "string", "info": "The name of the secret.: string", "required": true, "schema": { "title": "secretName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/codespacesGetRepoSecret" }, "task": true }, { "name": "codespacesCreateOrUpdateRepoSecret", "summary": "codespaces/create-or-update-repo-secret", "description": "Creates or updates a repository development environment secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "secretName", "type": "string", "info": "The name of the secret.: string", "required": true, "schema": { "title": "secretName", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/codespacesCreateOrUpdateRepoSecret" }, "task": true }, { "name": "codespacesDeleteRepoSecret", "summary": "codespaces/delete-repo-secret", "description": "Deletes a development environment secret in a repository using the secret name.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "secretName", "type": "string", "info": "The name of the secret.: string", "required": true, "schema": { "title": "secretName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/codespacesDeleteRepoSecret" }, "task": true }, { "name": "codespacesCreateWithPrForAuthenticatedUser", "summary": "codespaces/create-with-pr-for-authenticated-user", "description": "Creates a codespace owned by the authenticated user for the specified pull request.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "pullNumber", "type": "number", "info": "The number that identifies the pull request.: 123", "required": true, "schema": { "title": "pullNumber", "type": "number" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/codespacesCreateWithPrForAuthenticatedUser" }, "task": true }, { "name": "codespacesListForAuthenticatedUser", "summary": "codespaces/list-for-authenticated-user", "description": "Lists the authenticated user's codespaces.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.", "input": [ { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "repositoryId", "type": "number", "info": "ID of the Repository to filter on: 123", "required": false, "schema": { "title": "repositoryId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/codespacesListForAuthenticatedUser" }, "task": true }, { "name": "codespacesCreateForAuthenticatedUser", "summary": "codespaces/create-for-authenticated-user", "description": "Creates a new codespace, owned by the authenticated user.\n\nThis endpoint requires either a `repository_id` OR a `pull_request` but not both.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.", "input": [ { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/codespacesCreateForAuthenticatedUser" }, "task": true }, { "name": "codespacesListSecretsForAuthenticatedUser", "summary": "codespaces/list-secrets-for-authenticated-user", "description": "Lists all development environment secrets available for a user's codespaces without revealing their\nencrypted values.\n\nThe authenticated user must have Codespaces access to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint.", "input": [ { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/codespacesListSecretsForAuthenticatedUser" }, "task": true }, { "name": "codespacesGetPublicKeyForAuthenticatedUser", "summary": "codespaces/get-public-key-for-authenticated-user", "description": "Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets.\n\nThe authenticated user must have Codespaces access to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint.", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/codespacesGetPublicKeyForAuthenticatedUser" }, "task": true }, { "name": "codespacesGetSecretForAuthenticatedUser", "summary": "codespaces/get-secret-for-authenticated-user", "description": "Gets a development environment secret available to a user's codespaces without revealing its encrypted value.\n\nThe authenticated user must have Codespaces access to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint.", "input": [ { "name": "secretName", "type": "string", "info": "The name of the secret.: string", "required": true, "schema": { "title": "secretName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/codespacesGetSecretForAuthenticatedUser" }, "task": true }, { "name": "codespacesCreateOrUpdateSecretForAuthenticatedUser", "summary": "codespaces/create-or-update-secret-for-authenticated-user", "description": "Creates or updates a development environment secret for a user's codespace with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nThe authenticated user must have Codespaces access to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` or `code...(description truncated)", "input": [ { "name": "secretName", "type": "string", "info": "The name of the secret.: string", "required": true, "schema": { "title": "secretName", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/codespacesCreateOrUpdateSecretForAuthenticatedUser" }, "task": true }, { "name": "codespacesDeleteSecretForAuthenticatedUser", "summary": "codespaces/delete-secret-for-authenticated-user", "description": "Deletes a development environment secret from a user's codespaces using the secret name. Deleting the secret will remove access from all codespaces that were allowed to access the secret.\n\nThe authenticated user must have Codespaces access to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint.", "input": [ { "name": "secretName", "type": "string", "info": "The name of the secret.: string", "required": true, "schema": { "title": "secretName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/codespacesDeleteSecretForAuthenticatedUser" }, "task": true }, { "name": "codespacesListRepositoriesForSecretForAuthenticatedUser", "summary": "codespaces/list-repositories-for-secret-for-authenticated-user", "description": "List the repositories that have been granted the ability to use a user's development environment secret.\n\nThe authenticated user must have Codespaces access to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint.", "input": [ { "name": "secretName", "type": "string", "info": "The name of the secret.: string", "required": true, "schema": { "title": "secretName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/codespacesListRepositoriesForSecretForAuthenticatedUser" }, "task": true }, { "name": "codespacesSetRepositoriesForSecretForAuthenticatedUser", "summary": "codespaces/set-repositories-for-secret-for-authenticated-user", "description": "Select the repositories that will use a user's development environment secret.\n\nThe authenticated user must have Codespaces access to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint.", "input": [ { "name": "secretName", "type": "string", "info": "The name of the secret.: string", "required": true, "schema": { "title": "secretName", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/codespacesSetRepositoriesForSecretForAuthenticatedUser" }, "task": true }, { "name": "codespacesAddRepositoryForSecretForAuthenticatedUser", "summary": "codespaces/add-repository-for-secret-for-authenticated-user", "description": "Adds a repository to the selected repositories for a user's development environment secret.\n\nThe authenticated user must have Codespaces access to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint.", "input": [ { "name": "secretName", "type": "string", "info": "The name of the secret.: string", "required": true, "schema": { "title": "secretName", "type": "string" } }, { "name": "repositoryId", "type": "number", "info": ": 123", "required": true, "schema": { "title": "repositoryId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/codespacesAddRepositoryForSecretForAuthenticatedUser" }, "task": true }, { "name": "codespacesRemoveRepositoryForSecretForAuthenticatedUser", "summary": "codespaces/remove-repository-for-secret-for-authenticated-user", "description": "Removes a repository from the selected repositories for a user's development environment secret.\n\nThe authenticated user must have Codespaces access to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint.", "input": [ { "name": "secretName", "type": "string", "info": "The name of the secret.: string", "required": true, "schema": { "title": "secretName", "type": "string" } }, { "name": "repositoryId", "type": "number", "info": ": 123", "required": true, "schema": { "title": "repositoryId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/codespacesRemoveRepositoryForSecretForAuthenticatedUser" }, "task": true }, { "name": "codespacesGetForAuthenticatedUser", "summary": "codespaces/get-for-authenticated-user", "description": "Gets information about a user's codespace.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.", "input": [ { "name": "codespaceName", "type": "string", "info": "The name of the codespace.: string", "required": true, "schema": { "title": "codespaceName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/codespacesGetForAuthenticatedUser" }, "task": true }, { "name": "codespacesUpdateForAuthenticatedUser", "summary": "codespaces/update-for-authenticated-user", "description": "Updates a codespace owned by the authenticated user. Currently only the codespace's machine type and recent folders can be modified using this endpoint.\n\nIf you specify a new machine type it will be applied the next time your codespace is started.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.", "input": [ { "name": "codespaceName", "type": "string", "info": "The name of the codespace.: string", "required": true, "schema": { "title": "codespaceName", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/codespacesUpdateForAuthenticatedUser" }, "task": true }, { "name": "codespacesDeleteForAuthenticatedUser", "summary": "codespaces/delete-for-authenticated-user", "description": "Deletes a user's codespace.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.", "input": [ { "name": "codespaceName", "type": "string", "info": "The name of the codespace.: string", "required": true, "schema": { "title": "codespaceName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/codespacesDeleteForAuthenticatedUser" }, "task": true }, { "name": "codespacesExportForAuthenticatedUser", "summary": "codespaces/export-for-authenticated-user", "description": "Triggers an export of the specified codespace and returns a URL and ID where the status of the export can be monitored.\n\nIf changes cannot be pushed to the codespace's repository, they will be pushed to a new or previously-existing fork instead.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.", "input": [ { "name": "codespaceName", "type": "string", "info": "The name of the codespace.: string", "required": true, "schema": { "title": "codespaceName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/codespacesExportForAuthenticatedUser" }, "task": true }, { "name": "codespacesGetExportDetailsForAuthenticatedUser", "summary": "codespaces/get-export-details-for-authenticated-user", "description": "Gets information about an export of a codespace.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.", "input": [ { "name": "codespaceName", "type": "string", "info": "The name of the codespace.: string", "required": true, "schema": { "title": "codespaceName", "type": "string" } }, { "name": "exportId", "type": "string", "info": "The ID of the export operation, or `latest`. Currently only `latest` is currently supported.: string", "required": true, "schema": { "title": "exportId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/codespacesGetExportDetailsForAuthenticatedUser" }, "task": true }, { "name": "codespacesCodespaceMachinesForAuthenticatedUser", "summary": "codespaces/codespace-machines-for-authenticated-user", "description": "List the machine types a codespace can transition to use.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.", "input": [ { "name": "codespaceName", "type": "string", "info": "The name of the codespace.: string", "required": true, "schema": { "title": "codespaceName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/codespacesCodespaceMachinesForAuthenticatedUser" }, "task": true }, { "name": "codespacesPublishForAuthenticatedUser", "summary": "codespaces/publish-for-authenticated-user", "description": "Publishes an unpublished codespace, creating a new repository and assigning it to the codespace.\n\nThe codespace's token is granted write permissions to the repository, allowing the user to push their changes.\n\nThis will fail for a codespace that is already published, meaning it has an associated repository.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.", "input": [ { "name": "codespaceName", "type": "string", "info": "The name of the codespace.: string", "required": true, "schema": { "title": "codespaceName", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/codespacesPublishForAuthenticatedUser" }, "task": true }, { "name": "codespacesStartForAuthenticatedUser", "summary": "codespaces/start-for-authenticated-user", "description": "Starts a user's codespace.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.", "input": [ { "name": "codespaceName", "type": "string", "info": "The name of the codespace.: string", "required": true, "schema": { "title": "codespaceName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/codespacesStartForAuthenticatedUser" }, "task": true }, { "name": "codespacesStopForAuthenticatedUser", "summary": "codespaces/stop-for-authenticated-user", "description": "Stops a user's codespace.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.", "input": [ { "name": "codespaceName", "type": "string", "info": "The name of the codespace.: string", "required": true, "schema": { "title": "codespaceName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/codespacesStopForAuthenticatedUser" }, "task": true }, { "name": "copilotListCopilotSeatsForEnterprise", "summary": "copilot/list-copilot-seats-for-enterprise", "description": "> [!NOTE]\n> This endpoint is in beta and is subject to change.\n\nLists all active Copilot seats across organizations or enterprise teams for an enterprise with a Copilot Business or Copilot Enterprise subscription.\n\nUsers with access through multiple organizations or enterprise teams will only be counted toward `total_seats` once.\n\nFor each organization or enterprise team which grants Copilot access to a user, a seat detail object will appear in the `seats` array.\n\nOnly enterprise owners and bill...(description truncated)", "input": [ { "name": "enterprise", "type": "string", "info": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.: string", "required": true, "schema": { "title": "enterprise", "type": "string" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/copilotListCopilotSeatsForEnterprise" }, "task": true }, { "name": "copilotUsageMetricsForEnterprise", "summary": "copilot/usage-metrics-for-enterprise", "description": "> [!NOTE]\n> This endpoint is in beta and is subject to change.\n\nYou can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE\nfor all users across organizations with access to Copilot within your enterprise, with a further breakdown of suggestions, acceptances,\nand number of active users by editor and language for each day. See the response schema tab for detailed metrics definitions.\n\nThe response contains metrics for up to 28...(description truncated)", "input": [ { "name": "enterprise", "type": "string", "info": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.: string", "required": true, "schema": { "title": "enterprise", "type": "string" } }, { "name": "since", "type": "string", "info": "Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 28 days ag...(description truncated): string", "required": false, "schema": { "title": "since", "type": "string" } }, { "name": "until", "type": "string", "info": "Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `...(description truncated): string", "required": false, "schema": { "title": "until", "type": "string" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "perPage", "type": "number", "info": "The number of days of metrics to display per page (max 28). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/copilotUsageMetricsForEnterprise" }, "task": true }, { "name": "copilotUsageMetricsForEnterpriseTeam", "summary": "copilot/usage-metrics-for-enterprise-team", "description": "> [!NOTE]\n> This endpoint is in beta and is subject to change.\n\nYou can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE\nfor users within an enterprise team, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day.\nSee the response schema tab for detailed metrics definitions.\n\nThe response contains metrics for up to 28 days prior. Usage metrics are processed once...(description truncated)", "input": [ { "name": "enterprise", "type": "string", "info": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.: string", "required": true, "schema": { "title": "enterprise", "type": "string" } }, { "name": "teamSlug", "type": "string", "info": "The slug of the team name.: string", "required": true, "schema": { "title": "teamSlug", "type": "string" } }, { "name": "since", "type": "string", "info": "Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 28 days ag...(description truncated): string", "required": false, "schema": { "title": "since", "type": "string" } }, { "name": "until", "type": "string", "info": "Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `...(description truncated): string", "required": false, "schema": { "title": "until", "type": "string" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "perPage", "type": "number", "info": "The number of days of metrics to display per page (max 28). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/copilotUsageMetricsForEnterpriseTeam" }, "task": true }, { "name": "copilotGetCopilotOrganizationDetails", "summary": "copilot/get-copilot-organization-details", "description": "> [!NOTE]\n> This endpoint is in beta and is subject to change.\n\nGets information about an organization's Copilot subscription, including seat breakdown\nand feature policies. To configure these settings, go to your organization's settings on GitHub.com.\nFor more information, see \"[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization)\".\n\nOnly organization owners can view details about the or...(description truncated)", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/copilotGetCopilotOrganizationDetails" }, "task": true }, { "name": "copilotListCopilotSeats", "summary": "copilot/list-copilot-seats", "description": "> [!NOTE]\n> This endpoint is in beta and is subject to change.\n\nLists all active Copilot seats for an organization with a Copilot Business or Copilot Enterprise subscription.\nOnly organization owners can view assigned seats.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/copilotListCopilotSeats" }, "task": true }, { "name": "copilotAddCopilotSeatsForTeams", "summary": "copilot/add-copilot-seats-for-teams", "description": "> [!NOTE]\n> This endpoint is in beta and is subject to change.\n\nPurchases a GitHub Copilot seat for all users within each specified team.\nThe organization will be billed accordingly. For more information about Copilot pricing, see \"[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)\".\n\nOnly organization owners can add Copilot seats for their organization members.\n\nIn order for an admin...(description truncated)", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/copilotAddCopilotSeatsForTeams" }, "task": true }, { "name": "copilotCancelCopilotSeatAssignmentForTeams", "summary": "copilot/cancel-copilot-seat-assignment-for-teams", "description": "> [!NOTE]\n> This endpoint is in beta and is subject to change.\n\nCancels the Copilot seat assignment for all members of each team specified.\nThis will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users.\n\nFor more information about Copilot pricing, see \"[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-git...(description truncated)", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/copilotCancelCopilotSeatAssignmentForTeams" }, "task": true }, { "name": "copilotAddCopilotSeatsForUsers", "summary": "copilot/add-copilot-seats-for-users", "description": "> [!NOTE]\n> This endpoint is in beta and is subject to change.\n\nPurchases a GitHub Copilot seat for each user specified.\nThe organization will be billed accordingly. For more information about Copilot pricing, see \"[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)\".\n\nOnly organization owners can add Copilot seats for their organization members.\n\nIn order for an admin to use this endp...(description truncated)", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/copilotAddCopilotSeatsForUsers" }, "task": true }, { "name": "copilotCancelCopilotSeatAssignmentForUsers", "summary": "copilot/cancel-copilot-seat-assignment-for-users", "description": "> [!NOTE]\n> This endpoint is in beta and is subject to change.\n\nCancels the Copilot seat assignment for each user specified.\nThis will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users.\n\nFor more information about Copilot pricing, see \"[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-gi...(description truncated)", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/copilotCancelCopilotSeatAssignmentForUsers" }, "task": true }, { "name": "copilotUsageMetricsForOrg", "summary": "copilot/usage-metrics-for-org", "description": "> [!NOTE]\n> This endpoint is in beta and is subject to change.\n\nYou can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE\nacross an organization, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day.\nSee the response schema tab for detailed metrics definitions.\n\nThe response contains metrics for up to 28 days prior. Usage metrics are processed once per day for ...(description truncated)", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "since", "type": "string", "info": "Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 28 days ag...(description truncated): string", "required": false, "schema": { "title": "since", "type": "string" } }, { "name": "until", "type": "string", "info": "Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `...(description truncated): string", "required": false, "schema": { "title": "until", "type": "string" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "perPage", "type": "number", "info": "The number of days of metrics to display per page (max 28). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/copilotUsageMetricsForOrg" }, "task": true }, { "name": "copilotGetCopilotSeatDetailsForUser", "summary": "copilot/get-copilot-seat-details-for-user", "description": "> [!NOTE]\n> This endpoint is in beta and is subject to change.\n\nGets the GitHub Copilot seat assignment details for a member of an organization who currently has access to GitHub Copilot.\n\nOnly organization owners can view Copilot seat assignment details for members of their organization.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "username", "type": "string", "info": "The handle for the GitHub user account.: string", "required": true, "schema": { "title": "username", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/copilotGetCopilotSeatDetailsForUser" }, "task": true }, { "name": "copilotUsageMetricsForTeam", "summary": "copilot/usage-metrics-for-team", "description": "> [!NOTE]\n> This endpoint is in beta and is subject to change.\n\nYou can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE\nfor users within a team, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day.\nSee the response schema tab for detailed metrics definitions.\n\nThe response contains metrics for up to 28 days prior. Usage metrics are processed once per day for...(description truncated)", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "teamSlug", "type": "string", "info": "The slug of the team name.: string", "required": true, "schema": { "title": "teamSlug", "type": "string" } }, { "name": "since", "type": "string", "info": "Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 28 days ag...(description truncated): string", "required": false, "schema": { "title": "since", "type": "string" } }, { "name": "until", "type": "string", "info": "Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `...(description truncated): string", "required": false, "schema": { "title": "until", "type": "string" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "perPage", "type": "number", "info": "The number of days of metrics to display per page (max 28). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/copilotUsageMetricsForTeam" }, "task": true }, { "name": "securityAdvisoriesListGlobalAdvisories", "summary": "security-advisories/list-global-advisories", "description": "Lists all global security advisories that match the specified parameters. If no other parameters are defined, the request will return only GitHub-reviewed advisories that are not malware.\n\nBy default, all responses will exclude advisories for malware, because malware are not standard vulnerabilities. To list advisories for malware, you must include the `type` parameter in your request, with the value `malware`. For more information about the different types of security advisories, see \"[About th...(description truncated)", "input": [ { "name": "ghsaId", "type": "string", "info": "If specified, only advisories with this GHSA (GitHub Security Advisory) identifier will be returned.: string", "required": false, "schema": { "title": "ghsaId", "type": "string" } }, { "name": "type", "type": "string", "info": "If specified, only advisories of this type will be returned. By default, a request with no other parameters defined will only return reviewed advisories that are not malw...(description truncated): ", "required": false, "schema": { "title": "type", "type": "string" } }, { "name": "cveId", "type": "string", "info": "If specified, only advisories with this CVE (Common Vulnerabilities and Exposures) identifier will be returned.: string", "required": false, "schema": { "title": "cveId", "type": "string" } }, { "name": "ecosystem", "type": "string", "info": "If specified, only advisories for these ecosystems will be returned.: ", "required": false, "schema": { "title": "ecosystem", "type": "string" } }, { "name": "severity", "type": "string", "info": "If specified, only advisories with these severities will be returned.: ", "required": false, "schema": { "title": "severity", "type": "string" } }, { "name": "cwes", "type": "string", "info": "If specified, only advisories with these Common Weakness Enumerations (CWEs) will be returned.\n\nExample: `cwes=79,284,22` or `cwes[]=79&cwes[]=284&cwes[]=22`: ", "required": false, "schema": { "title": "cwes", "type": "string" } }, { "name": "isWithdrawn", "type": "boolean", "info": "Whether to only return advisories that have been withdrawn.: boolean", "required": false, "schema": { "title": "isWithdrawn", "type": "boolean" } }, { "name": "affects", "type": "string", "info": "If specified, only return advisories that affect any of `package` or `package@version`. A maximum of 1000 packages can be specified.\nIf the query parameter causes the URL...(description truncated): ", "required": false, "schema": { "title": "affects", "type": "string" } }, { "name": "published", "type": "string", "info": "If specified, only return advisories that were published on a date or date range.\n\nFor more information on the syntax of the date range, see \"[Understanding the search sy...(description truncated): string", "required": false, "schema": { "title": "published", "type": "string" } }, { "name": "updated", "type": "string", "info": "If specified, only return advisories that were updated on a date or date range.\n\nFor more information on the syntax of the date range, see \"[Understanding the search synt...(description truncated): string", "required": false, "schema": { "title": "updated", "type": "string" } }, { "name": "modified", "type": "string", "info": "If specified, only show advisories that were updated or published on a date or date range.\n\nFor more information on the syntax of the date range, see \"[Understanding the ...(description truncated): string", "required": false, "schema": { "title": "modified", "type": "string" } }, { "name": "epssPercentage", "type": "string", "info": "If specified, only return advisories that have an EPSS percentage score that matches the provided value.\nThe EPSS percentage represents the likelihood of a CVE being expl...(description truncated): string", "required": false, "schema": { "title": "epssPercentage", "type": "string" } }, { "name": "epssPercentile", "type": "string", "info": "If specified, only return advisories that have an EPSS percentile score that matches the provided value.\nThe EPSS percentile represents the relative rank of the CVE's lik...(description truncated): string", "required": false, "schema": { "title": "epssPercentile", "type": "string" } }, { "name": "before", "type": "string", "info": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches fo...(description truncated): string", "required": false, "schema": { "title": "before", "type": "string" } }, { "name": "after", "type": "string", "info": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches fo...(description truncated): string", "required": false, "schema": { "title": "after", "type": "string" } }, { "name": "direction", "type": "string", "info": "The direction to sort the results by.: ", "required": false, "schema": { "title": "direction", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "sort", "type": "string", "info": "The property to sort the results by.: ", "required": false, "schema": { "title": "sort", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/securityAdvisoriesListGlobalAdvisories" }, "task": true }, { "name": "securityAdvisoriesGetGlobalAdvisory", "summary": "security-advisories/get-global-advisory", "description": "Gets a global security advisory using its GitHub Security Advisory (GHSA) identifier.", "input": [ { "name": "ghsaId", "type": "string", "info": "The GHSA (GitHub Security Advisory) identifier of the advisory.: string", "required": true, "schema": { "title": "ghsaId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/securityAdvisoriesGetGlobalAdvisory" }, "task": true }, { "name": "securityAdvisoriesListOrgRepositoryAdvisories", "summary": "security-advisories/list-org-repository-advisories", "description": "Lists repository security advisories for an organization.\n\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "direction", "type": "string", "info": "The direction to sort the results by.: ", "required": false, "schema": { "title": "direction", "type": "string" } }, { "name": "sort", "type": "string", "info": "The property to sort the results by.: ", "required": false, "schema": { "title": "sort", "type": "string" } }, { "name": "before", "type": "string", "info": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches fo...(description truncated): string", "required": false, "schema": { "title": "before", "type": "string" } }, { "name": "after", "type": "string", "info": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches fo...(description truncated): string", "required": false, "schema": { "title": "after", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of advisories to return per page. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-paginatio...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "state", "type": "string", "info": "Filter by the state of the repository advisories. Only advisories of this state will be returned.: ", "required": false, "schema": { "title": "state", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/securityAdvisoriesListOrgRepositoryAdvisories" }, "task": true }, { "name": "securityAdvisoriesListRepositoryAdvisories", "summary": "security-advisories/list-repository-advisories", "description": "Lists security advisories in a repository.\n\nThe authenticated user can access unpublished security advisories from a repository if they are a security manager or administrator of that repository, or if they are a collaborator on any security advisory.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:read` scope to to get a published security advisory in a private repository, or any unpublished security advisory that the authenticated user has acces...(description truncated)", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "direction", "type": "string", "info": "The direction to sort the results by.: ", "required": false, "schema": { "title": "direction", "type": "string" } }, { "name": "sort", "type": "string", "info": "The property to sort the results by.: ", "required": false, "schema": { "title": "sort", "type": "string" } }, { "name": "before", "type": "string", "info": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches fo...(description truncated): string", "required": false, "schema": { "title": "before", "type": "string" } }, { "name": "after", "type": "string", "info": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches fo...(description truncated): string", "required": false, "schema": { "title": "after", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of advisories to return per page. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-paginatio...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "state", "type": "string", "info": "Filter by state of the repository advisories. Only advisories of this state will be returned.: ", "required": false, "schema": { "title": "state", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/securityAdvisoriesListRepositoryAdvisories" }, "task": true }, { "name": "securityAdvisoriesCreateRepositoryAdvisory", "summary": "security-advisories/create-repository-advisory", "description": "Creates a new repository security advisory.\n\nIn order to create a draft repository security advisory, the authenticated user must be a security manager or administrator of that repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/securityAdvisoriesCreateRepositoryAdvisory" }, "task": true }, { "name": "securityAdvisoriesCreatePrivateVulnerabilityReport", "summary": "security-advisories/create-private-vulnerability-report", "description": "Report a security vulnerability to the maintainers of the repository.\nSee \"[Privately reporting a security vulnerability](https://docs.github.com/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)\" for more information about private vulnerability reporting.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/securityAdvisoriesCreatePrivateVulnerabilityReport" }, "task": true }, { "name": "securityAdvisoriesGetRepositoryAdvisory", "summary": "security-advisories/get-repository-advisory", "description": "Get a repository security advisory using its GitHub Security Advisory (GHSA) identifier.\n\nAnyone can access any published security advisory on a public repository.\n\nThe authenticated user can access an unpublished security advisory from a repository if they are a security manager or administrator of that repository, or if they are a\ncollaborator on the security advisory.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:read` scope to to get a publi...(description truncated)", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "ghsaId", "type": "string", "info": "The GHSA (GitHub Security Advisory) identifier of the advisory.: string", "required": true, "schema": { "title": "ghsaId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/securityAdvisoriesGetRepositoryAdvisory" }, "task": true }, { "name": "securityAdvisoriesUpdateRepositoryAdvisory", "summary": "security-advisories/update-repository-advisory", "description": "Update a repository security advisory using its GitHub Security Advisory (GHSA) identifier.\n\nIn order to update any security advisory, the authenticated user must be a security manager or administrator of that repository,\nor a collaborator on the repository security advisory.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "ghsaId", "type": "string", "info": "The GHSA (GitHub Security Advisory) identifier of the advisory.: string", "required": true, "schema": { "title": "ghsaId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/securityAdvisoriesUpdateRepositoryAdvisory" }, "task": true }, { "name": "securityAdvisoriesCreateRepositoryAdvisoryCveRequest", "summary": "security-advisories/create-repository-advisory-cve-request", "description": "If you want a CVE identification number for the security vulnerability in your project, and don't already have one, you can request a CVE identification number from GitHub. For more information see \"[Requesting a CVE identification number](https://docs.github.com/code-security/security-advisories/repository-security-advisories/publishing-a-repository-security-advisory#requesting-a-cve-identification-number-optional).\"\n\nYou may request a CVE for public repositories, but cannot do so for private r...(description truncated)", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "ghsaId", "type": "string", "info": "The GHSA (GitHub Security Advisory) identifier of the advisory.: string", "required": true, "schema": { "title": "ghsaId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/securityAdvisoriesCreateRepositoryAdvisoryCveRequest" }, "task": true }, { "name": "securityAdvisoriesCreateFork", "summary": "security-advisories/create-fork", "description": "Create a temporary private fork to collaborate on fixing a security vulnerability in your repository.\n\n> [!NOTE]\n> Forking a repository happens asynchronously. You may have to wait up to 5 minutes before you can access the fork.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "ghsaId", "type": "string", "info": "The GHSA (GitHub Security Advisory) identifier of the advisory.: string", "required": true, "schema": { "title": "ghsaId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/securityAdvisoriesCreateFork" }, "task": true }, { "name": "interactionsGetRestrictionsForOrg", "summary": "interactions/get-restrictions-for-org", "description": "Shows which type of GitHub user can interact with this organization and when the restriction expires. If there is no restrictions, you will see an empty response.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/interactionsGetRestrictionsForOrg" }, "task": true }, { "name": "interactionsSetRestrictionsForOrg", "summary": "interactions/set-restrictions-for-org", "description": "Temporarily restricts interactions to a certain type of GitHub user in any public repository in the given organization. You must be an organization owner to set these restrictions. Setting the interaction limit at the organization level will overwrite any interaction limits that are set for individual repositories owned by the organization.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/interactionsSetRestrictionsForOrg" }, "task": true }, { "name": "interactionsRemoveRestrictionsForOrg", "summary": "interactions/remove-restrictions-for-org", "description": "Removes all interaction restrictions from public repositories in the given organization. You must be an organization owner to remove restrictions.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/interactionsRemoveRestrictionsForOrg" }, "task": true }, { "name": "interactionsGetRestrictionsForRepo", "summary": "interactions/get-restrictions-for-repo", "description": "Shows which type of GitHub user can interact with this repository and when the restriction expires. If there are no restrictions, you will see an empty response.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/interactionsGetRestrictionsForRepo" }, "task": true }, { "name": "interactionsSetRestrictionsForRepo", "summary": "interactions/set-restrictions-for-repo", "description": "Temporarily restricts interactions to a certain type of GitHub user within the given repository. You must have owner or admin access to set these restrictions. If an interaction limit is set for the user or organization that owns this repository, you will receive a `409 Conflict` response and will not be able to use this endpoint to change the interaction limit for a single repository.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/interactionsSetRestrictionsForRepo" }, "task": true }, { "name": "interactionsRemoveRestrictionsForRepo", "summary": "interactions/remove-restrictions-for-repo", "description": "Removes all interaction restrictions from the given repository. You must have owner or admin access to remove restrictions. If the interaction limit is set for the user or organization that owns this repository, you will receive a `409 Conflict` response and will not be able to use this endpoint to change the interaction limit for a single repository.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/interactionsRemoveRestrictionsForRepo" }, "task": true }, { "name": "interactionsGetRestrictionsForAuthenticatedUser", "summary": "interactions/get-restrictions-for-authenticated-user", "description": "Shows which type of GitHub user can interact with your public repositories and when the restriction expires.", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/interactionsGetRestrictionsForAuthenticatedUser" }, "task": true }, { "name": "interactionsSetRestrictionsForAuthenticatedUser", "summary": "interactions/set-restrictions-for-authenticated-user", "description": "Temporarily restricts which type of GitHub user can interact with your public repositories. Setting the interaction limit at the user level will overwrite any interaction limits that are set for individual repositories owned by the user.", "input": [ { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/interactionsSetRestrictionsForAuthenticatedUser" }, "task": true }, { "name": "interactionsRemoveRestrictionsForAuthenticatedUser", "summary": "interactions/remove-restrictions-for-authenticated-user", "description": "Removes any interaction restrictions from your public repositories.", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/interactionsRemoveRestrictionsForAuthenticatedUser" }, "task": true }, { "name": "classroomGetAnAssignment", "summary": "classroom/get-an-assignment", "description": "Gets a GitHub Classroom assignment. Assignment will only be returned if the current user is an administrator of the GitHub Classroom for the assignment.", "input": [ { "name": "assignmentId", "type": "number", "info": "The unique identifier of the classroom assignment.: 123", "required": true, "schema": { "title": "assignmentId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/classroomGetAnAssignment" }, "task": true }, { "name": "classroomListAcceptedAssigmentsForAnAssignment", "summary": "classroom/list-accepted-assigments-for-an-assignment", "description": "Lists any assignment repositories that have been created by students accepting a GitHub Classroom assignment. Accepted assignments will only be returned if the current user is an administrator of the GitHub Classroom for the assignment.", "input": [ { "name": "assignmentId", "type": "number", "info": "The unique identifier of the classroom assignment.: 123", "required": true, "schema": { "title": "assignmentId", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/classroomListAcceptedAssigmentsForAnAssignment" }, "task": true }, { "name": "classroomGetAssignmentGrades", "summary": "classroom/get-assignment-grades", "description": "Gets grades for a GitHub Classroom assignment. Grades will only be returned if the current user is an administrator of the GitHub Classroom for the assignment.", "input": [ { "name": "assignmentId", "type": "number", "info": "The unique identifier of the classroom assignment.: 123", "required": true, "schema": { "title": "assignmentId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/classroomGetAssignmentGrades" }, "task": true }, { "name": "classroomListClassrooms", "summary": "classroom/list-classrooms", "description": "Lists GitHub Classroom classrooms for the current user. Classrooms will only be returned if the current user is an administrator of one or more GitHub Classrooms.", "input": [ { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/classroomListClassrooms" }, "task": true }, { "name": "classroomGetAClassroom", "summary": "classroom/get-a-classroom", "description": "Gets a GitHub Classroom classroom for the current user. Classroom will only be returned if the current user is an administrator of the GitHub Classroom.", "input": [ { "name": "classroomId", "type": "number", "info": "The unique identifier of the classroom.: 123", "required": true, "schema": { "title": "classroomId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/classroomGetAClassroom" }, "task": true }, { "name": "classroomListAssignmentsForAClassroom", "summary": "classroom/list-assignments-for-a-classroom", "description": "Lists GitHub Classroom assignments for a classroom. Assignments will only be returned if the current user is an administrator of the GitHub Classroom.", "input": [ { "name": "classroomId", "type": "number", "info": "The unique identifier of the classroom.: 123", "required": true, "schema": { "title": "classroomId", "type": "number" } }, { "name": "page", "type": "number", "info": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in...(description truncated): 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/classroomListAssignmentsForAClassroom" }, "task": true }, { "name": "codeSecurityGetConfigurationsForOrg", "summary": "code-security/get-configurations-for-org", "description": "Lists all code security configurations available in an organization.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "targetType", "type": "string", "info": "The target type of the code security configuration: ", "required": false, "schema": { "title": "targetType", "type": "string" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "before", "type": "string", "info": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches fo...(description truncated): string", "required": false, "schema": { "title": "before", "type": "string" } }, { "name": "after", "type": "string", "info": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches fo...(description truncated): string", "required": false, "schema": { "title": "after", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/codeSecurityGetConfigurationsForOrg" }, "task": true }, { "name": "codeSecurityCreateConfiguration", "summary": "code-security/create-configuration", "description": "Creates a code security configuration in an organization.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/codeSecurityCreateConfiguration" }, "task": true }, { "name": "codeSecurityGetDefaultConfigurations", "summary": "code-security/get-default-configurations", "description": "Lists the default code security configurations for an organization.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/codeSecurityGetDefaultConfigurations" }, "task": true }, { "name": "codeSecurityDetachConfiguration", "summary": "code-security/detach-configuration", "description": "Detach code security configuration(s) from a set of repositories.\nRepositories will retain their settings but will no longer be associated with the configuration.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/codeSecurityDetachConfiguration" }, "task": true }, { "name": "codeSecurityGetConfiguration", "summary": "code-security/get-configuration", "description": "Gets a code security configuration available in an organization.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "configurationId", "type": "number", "info": "The unique identifier of the code security configuration.: 123", "required": true, "schema": { "title": "configurationId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/codeSecurityGetConfiguration" }, "task": true }, { "name": "codeSecurityUpdateConfiguration", "summary": "code-security/update-configuration", "description": "Updates a code security configuration in an organization.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "configurationId", "type": "number", "info": "The unique identifier of the code security configuration.: 123", "required": true, "schema": { "title": "configurationId", "type": "number" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/codeSecurityUpdateConfiguration" }, "task": true }, { "name": "codeSecurityDeleteConfiguration", "summary": "code-security/delete-configuration", "description": "Deletes the desired code security configuration from an organization.\nRepositories attached to the configuration will retain their settings but will no longer be associated with\nthe configuration.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "configurationId", "type": "number", "info": "The unique identifier of the code security configuration.: 123", "required": true, "schema": { "title": "configurationId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/codeSecurityDeleteConfiguration" }, "task": true }, { "name": "codeSecurityAttachConfiguration", "summary": "code-security/attach-configuration", "description": "Attach a code security configuration to a set of repositories. If the repositories specified are already attached to a configuration, they will be re-attached to the provided configuration.\n\nIf insufficient GHAS licenses are available to attach the configuration to a repository, only free features will be enabled.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:o...(description truncated)", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "configurationId", "type": "number", "info": "The unique identifier of the code security configuration.: 123", "required": true, "schema": { "title": "configurationId", "type": "number" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/codeSecurityAttachConfiguration" }, "task": true }, { "name": "codeSecuritySetConfigurationAsDefault", "summary": "code-security/set-configuration-as-default", "description": "Sets a code security configuration as a default to be applied to new repositories in your organization.\n\nThis configuration will be applied to the matching repository type (all, none, public, private and internal) by default when they are created.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "configurationId", "type": "number", "info": "The unique identifier of the code security configuration.: 123", "required": true, "schema": { "title": "configurationId", "type": "number" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/codeSecuritySetConfigurationAsDefault" }, "task": true }, { "name": "codeSecurityGetRepositoriesForConfiguration", "summary": "code-security/get-repositories-for-configuration", "description": "Lists the repositories associated with a code security configuration in an organization.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", "input": [ { "name": "org", "type": "string", "info": "The organization name. The name is not case sensitive.: string", "required": true, "schema": { "title": "org", "type": "string" } }, { "name": "configurationId", "type": "number", "info": "The unique identifier of the code security configuration.: 123", "required": true, "schema": { "title": "configurationId", "type": "number" } }, { "name": "perPage", "type": "number", "info": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated): 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "before", "type": "string", "info": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches fo...(description truncated): string", "required": false, "schema": { "title": "before", "type": "string" } }, { "name": "after", "type": "string", "info": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches fo...(description truncated): string", "required": false, "schema": { "title": "after", "type": "string" } }, { "name": "status", "type": "string", "info": "A comma-separated list of statuses. If specified, only repositories with these attachment statuses will be returned.\n\nCan be: `all`, `attached`, `attaching`, `detached`, ...(description truncated): string", "required": false, "schema": { "title": "status", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/codeSecurityGetRepositoriesForConfiguration" }, "task": true }, { "name": "codeSecurityGetConfigurationForRepository", "summary": "code-security/get-configuration-for-repository", "description": "Get the code security configuration that manages a repository's code security settings.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "input": [ { "name": "owner", "type": "string", "info": "The account owner of the repository. The name is not case sensitive.: string", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "repo", "type": "string", "info": "The name of the repository without the `.git` extension. The name is not case sensitive.: string", "required": true, "schema": { "title": "repo", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/codeSecurityGetConfigurationForRepository" }, "task": true } ] }