{"openapi":"3.1.0","info":{"title":"GitLab Deployments (BYOK) API","version":"0.1.0","description":"GitLab Deployments (BYOK) lets an AI assistant read your own GitLab Deployments data through the GitLab Deployments API with a key you supply (personal access token (read_api scope)). Read-only: 10 tools (list_environments, get_environment, list_deployments, get_deployment, list_deployment_merge_requests, list_freeze_periods, get_freeze_period, list_pipeline_schedules, get_pipeline_schedule,...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-gitlab-environments.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-gitlab-environments/docs"},"termsOfService":"https://connectorbay.com/byok-gitlab-environments/terms"},"servers":[{"url":"https://byok-gitlab-environments.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-gitlab-environments/docs"},"security":[{"upstreamKey":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Optional. A Pro API key raises rate limits; no credentials are required."},"upstreamKey":{"type":"apiKey","in":"header","name":"X-Upstream-Key","description":"Your own key for the service this connector wraps (bring your own key). Used for that one call only; never stored, logged or cached."}},"schemas":{"Error":{"type":"object","properties":{"ok":{"const":false},"error":{"type":"object"}}}}},"paths":{"/v1/tools/list_environments":{"post":{"operationId":"list_environments","summary":"List a project's environments with state (available, stopping, stopped), tier, external URL and auto-stop time. Use for ","description":"List a project's environments with state (available, stopping, stopped), tier, external URL and auto-stop time. Use for \"What environments does gitlab-org/gitlab have and which are available\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"project":{"description":"Numeric project ID, or the full path with namespace such as 'gitlab-org/gitlab' (slashes are encoded for you).","maxLength":200,"title":"Project","type":"string"},"name":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Return only the environment with exactly this name. Cannot be combined with search.","title":"Name"},"search":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Return environments whose name matches this text (at least 3 characters). Cannot be combined with name.","title":"Search"},"states":{"anyOf":[{"enum":["available","stopping","stopped"],"type":"string"},{"type":"null"}],"default":null,"description":"Only environments in this state.","title":"States"},"per_page":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many results to return (1 to 100).","title":"Per Page"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"}},"required":["project"],"title":"list_environmentsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_environment":{"post":{"operationId":"get_environment","summary":"Get one environment with its last deployment (status, ref, commit and time). Use for \"What was the last deployment to en","description":"Get one environment with its last deployment (status, ref, commit and time). Use for \"What was the last deployment to environment 42 of gitlab-org/gitlab\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"project":{"description":"Numeric project ID, or the full path with namespace such as 'gitlab-org/gitlab' (slashes are encoded for you).","maxLength":200,"title":"Project","type":"string"},"environment_id":{"description":"Numeric ID of the environment (from list_environments).","title":"Environment Id","type":"integer"}},"required":["project","environment_id"],"title":"get_environmentArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_deployments":{"post":{"operationId":"list_deployments","summary":"List a project's deployments with ref, commit, status, environment and who deployed. Date filters need a matching order_","description":"List a project's deployments with ref, commit, status, environment and who deployed. Date filters need a matching order_by (updated_after needs updated_at; finished_after needs finished_at plus status success). Use for \"Which deployments to production failed recently in gitlab-org/gitlab\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"project":{"description":"Numeric project ID, or the full path with namespace such as 'gitlab-org/gitlab' (slashes are encoded for you).","maxLength":200,"title":"Project","type":"string"},"environment":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only deployments to the environment with this name, for example 'production'.","title":"Environment"},"status":{"anyOf":[{"enum":["created","running","success","failed","canceled","skipped","blocked"],"type":"string"},{"type":"null"}],"default":null,"description":"Only deployments with this status.","title":"Status"},"order_by":{"anyOf":[{"enum":["id","iid","created_at","updated_at","finished_at"],"type":"string"},{"type":"null"}],"default":"id","description":"Sort field.","title":"Order By"},"sort":{"anyOf":[{"enum":["asc","desc"],"type":"string"},{"type":"null"}],"default":"asc","description":"Sort direction.","title":"Sort"},"updated_after":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only deployments updated after this ISO 8601 time (use with order_by=updated_at).","title":"Updated After"},"updated_before":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only deployments updated before this ISO 8601 time (use with order_by=updated_at).","title":"Updated Before"},"per_page":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many results to return (1 to 100).","title":"Per Page"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"}},"required":["project"],"title":"list_deploymentsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_deployment":{"post":{"operationId":"get_deployment","summary":"Get one deployment: ref, commit SHA, status, environment, deployer and the CI job and pipeline that ran it. Use for \"Sho","description":"Get one deployment: ref, commit SHA, status, environment, deployer and the CI job and pipeline that ran it. Use for \"Show deployment 101 of gitlab-org/gitlab\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"project":{"description":"Numeric project ID, or the full path with namespace such as 'gitlab-org/gitlab' (slashes are encoded for you).","maxLength":200,"title":"Project","type":"string"},"deployment_id":{"description":"Numeric ID of the deployment (from list_deployments).","title":"Deployment Id","type":"integer"}},"required":["project","deployment_id"],"title":"get_deploymentArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_deployment_merge_requests":{"post":{"operationId":"list_deployment_merge_requests","summary":"List the merge requests that shipped in one deployment. Use for \"Which merge requests went out in deployment 101 of gitl","description":"List the merge requests that shipped in one deployment. Use for \"Which merge requests went out in deployment 101 of gitlab-org/gitlab\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"project":{"description":"Numeric project ID, or the full path with namespace such as 'gitlab-org/gitlab' (slashes are encoded for you).","maxLength":200,"title":"Project","type":"string"},"deployment_id":{"description":"Numeric ID of the deployment (from list_deployments).","title":"Deployment Id","type":"integer"},"state":{"anyOf":[{"enum":["opened","closed","locked","merged"],"type":"string"},{"type":"null"}],"default":null,"description":"Only merge requests in this state.","title":"State"},"per_page":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many results to return (1 to 100).","title":"Per Page"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"}},"required":["project","deployment_id"],"title":"list_deployment_merge_requestsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_freeze_periods":{"post":{"operationId":"list_freeze_periods","summary":"List a project's deploy freeze periods (cron start and end plus time zone). Use for \"When are the deploy freezes for git","description":"List a project's deploy freeze periods (cron start and end plus time zone). Use for \"When are the deploy freezes for gitlab-org/gitlab\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"project":{"description":"Numeric project ID, or the full path with namespace such as 'gitlab-org/gitlab' (slashes are encoded for you).","maxLength":200,"title":"Project","type":"string"},"per_page":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many results to return (1 to 100).","title":"Per Page"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"}},"required":["project"],"title":"list_freeze_periodsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_freeze_period":{"post":{"operationId":"get_freeze_period","summary":"Get one deploy freeze period by ID. Use for \"Show freeze period 1 of gitlab-org/gitlab\".","description":"Get one deploy freeze period by ID. Use for \"Show freeze period 1 of gitlab-org/gitlab\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"project":{"description":"Numeric project ID, or the full path with namespace such as 'gitlab-org/gitlab' (slashes are encoded for you).","maxLength":200,"title":"Project","type":"string"},"freeze_period_id":{"description":"Numeric ID of the freeze period (from list_freeze_periods).","title":"Freeze Period Id","type":"integer"}},"required":["project","freeze_period_id"],"title":"get_freeze_periodArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_pipeline_schedules":{"post":{"operationId":"list_pipeline_schedules","summary":"List a project's scheduled pipelines with cron expression, time zone, target ref, next run and active flag. Use for \"Whi","description":"List a project's scheduled pipelines with cron expression, time zone, target ref, next run and active flag. Use for \"Which scheduled pipelines does gitlab-org/gitlab have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"project":{"description":"Numeric project ID, or the full path with namespace such as 'gitlab-org/gitlab' (slashes are encoded for you).","maxLength":200,"title":"Project","type":"string"},"scope":{"anyOf":[{"enum":["active","inactive"],"type":"string"},{"type":"null"}],"default":null,"description":"Only active or inactive schedules.","title":"Scope"},"per_page":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many results to return (1 to 100).","title":"Per Page"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"}},"required":["project"],"title":"list_pipeline_schedulesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_pipeline_schedule":{"post":{"operationId":"get_pipeline_schedule","summary":"Get one pipeline schedule with its last pipeline. Use for \"Show pipeline schedule 13 of gitlab-org/gitlab\".","description":"Get one pipeline schedule with its last pipeline. Use for \"Show pipeline schedule 13 of gitlab-org/gitlab\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"project":{"description":"Numeric project ID, or the full path with namespace such as 'gitlab-org/gitlab' (slashes are encoded for you).","maxLength":200,"title":"Project","type":"string"},"pipeline_schedule_id":{"description":"Numeric ID of the pipeline schedule (from list_pipeline_schedules).","title":"Pipeline Schedule Id","type":"integer"}},"required":["project","pipeline_schedule_id"],"title":"get_pipeline_scheduleArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_schedule_pipelines":{"post":{"operationId":"list_schedule_pipelines","summary":"List the pipelines a pipeline schedule has triggered. Use for \"What pipelines did schedule 13 of gitlab-org/gitlab run\".","description":"List the pipelines a pipeline schedule has triggered. Use for \"What pipelines did schedule 13 of gitlab-org/gitlab run\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"project":{"description":"Numeric project ID, or the full path with namespace such as 'gitlab-org/gitlab' (slashes are encoded for you).","maxLength":200,"title":"Project","type":"string"},"pipeline_schedule_id":{"description":"Numeric ID of the pipeline schedule (from list_pipeline_schedules).","title":"Pipeline Schedule Id","type":"integer"},"status":{"anyOf":[{"enum":["created","pending","running","success","failed","canceled","skipped","manual","scheduled"],"type":"string"},{"type":"null"}],"default":null,"description":"Only pipelines with this status.","title":"Status"},"sort":{"anyOf":[{"enum":["asc","desc"],"type":"string"},{"type":"null"}],"default":"asc","description":"Sort direction.","title":"Sort"},"per_page":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many results to return (1 to 100).","title":"Per Page"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"}},"required":["project","pipeline_schedule_id"],"title":"list_schedule_pipelinesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}}}}