reposGetPagesDeployment
Get the status of a GitHub Pages deployment
Details
- Method:
GET - Path:
/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id} - Operation ID:
repos/get-pages-deployment
Parameters
{
"owner": {
"description": "The account owner of the repository. The name is not case sensitive.",
"required": true,
"location": "path",
"type": "string"
},
"repo": {
"description": "The name of the repository without the `.git` extension. The name is not case sensitive.",
"required": true,
"location": "path",
"type": "string"
},
"pages_deployment_id": {
"description": "The ID of the Pages deployment. You can also give the commit SHA of the deployment.",
"required": true,
"location": "path",
"type": "string"
}
}Response Schema
{
"title": "GitHub Pages deployment status",
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "The current status of the deployment.",
"enum": [
"deployment_in_progress",
"syncing_files",
"finished_file_sync",
"updating_pages",
"purging_cdn",
"deployment_cancelled",
"deployment_failed",
"deployment_content_failed",
"deployment_attempt_error",
"deployment_lost",
"succeed"
]
}
}
}Usage
from ocp_agent import OCPAgent
agent = OCPAgent()
await agent.register_api('github')
# Call this tool
result = await agent.call_tool('reposGetPagesDeployment', {
# Add required parameters here
})