How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

GitHub Environments API

The Environments API from GitHub — 7 operation(s) for environments.

GitHub Environments API is one of 350 APIs that GitHub publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Environments. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an AsyncAPI specification, and an API reference.

This API exposes 14 operations across 7 paths, and defines 12 schemas. It is described by OpenAPI 3.2.0, at version 1.1.4.

Requests are made against a single base URL, {protocol}://{hostname}.

14 operations 7 paths 12 schemas 3 DELETE7 GET1 PATCH1 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.1.4
Base URL
https://api.github.com
Authentication
HTTP Bearer
Contact
License
Terms of Service
Resource Areas
1

Authentication & Security 1

GitHub Environments API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerHttpAuthentication).

  • bearerHttpAuthentication — Bearer Token

Paths & Operations 14

Across 7 paths, the API surfaces 14 operations — 3 DELETE, 7 GET, 1 PATCH, 1 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Environments 14
GET
/repos/{owner}/{repo}/environments
GitHub List Environments
listEnvironments 7 params → 200
GET
/repos/{owner}/{repo}/environments/{environment_name}
GitHub Get an Environment
getAnEnvironment 6 params → 200
PUT
/repos/{owner}/{repo}/environments/{environment_name}
GitHub Create or Update an Environment
createOrUpdateAnEnvironment 6 params body → 200422
DELETE
/repos/{owner}/{repo}/environments/{environment_name}
GitHub Delete an Environment
deleteAnEnvironment 6 params → 204
GET
/repos/{owner}/{repo}/environments/{environment_name}/secrets
GitHub List Environment Secrets
listEnvironmentSecrets 8 params → 200
GET
/repos/{owner}/{repo}/environments/{environment_name}/secrets/public-key
GitHub Get an Environment Public Key
getAnEnvironmentPublicKey 6 params → 200
GET
/repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name}
GitHub Get an Environment Secret
getAnEnvironmentSecret 7 params → 200
PUT
/repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name}
GitHub Create or Update an Environment Secret
createOrUpdateAnEnvironmentSecret 7 params body → 201204
DELETE
/repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name}
GitHub Delete an Environment Secret
deleteAnEnvironmentSecret 7 params → 204
GET
/repos/{owner}/{repo}/environments/{environment_name}/variables
GitHub List Environment Variables
listEnvironmentVariables 8 params → 200
POST
/repos/{owner}/{repo}/environments/{environment_name}/variables
GitHub Create an Environment Variable
createAnEnvironmentVariable 6 params body → 201
GET
/repos/{owner}/{repo}/environments/{environment_name}/variables/{name}
GitHub Get an Environment Variable
getAnEnvironmentVariable 7 params → 200
PATCH
/repos/{owner}/{repo}/environments/{environment_name}/variables/{name}
GitHub Update an Environment Variable
updateAnEnvironmentVariable 7 params body → 204
DELETE
/repos/{owner}/{repo}/environments/{environment_name}/variables/{name}
GitHub Delete an Environment Variable
deleteAnEnvironmentVariable 7 params → 204

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are simple-user (21 properties), team (13 properties), nullable-team-simple (12 properties), environment (9 properties). Each schema is shown below with its type and property counts.

actions-public-key
object
The public key used for setting Actions Secrets.
6 properties 2 required
team
object
Groups of organization members that gives permissions on specified repositories.
13 properties 11 required
wait-timer
integer
The amount of time to delay a job after the job is initially triggered. The time (in minutes) must be an integer between 0 and 43,200 (30 days).
simple-user
object
GitHub user.
21 properties 18 required
deployment-reviewer-type
string
The type of reviewer.
actions-secret
object
Set secrets for GitHub Actions.
3 properties 3 required
basic-error
object
Basic Error
4 properties
actions-variable
object
4 properties 4 required
nullable-team-simple
object
Groups of organization members that gives permissions on specified repositories.
12 properties 10 required
empty-object
object
An object without any properties.
environment
object
Details of a deployment environment
9 properties 7 required
deployment-branch-policy-settings
object
The type of deployment branch policy for this environment. To allow all branches to deploy, set to null.
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

github-environments-api-openapi.yml Raw ↑

Other APIs GitHub publishes across the network.

GitHub Events API
GitHub Feeds API
GitHub Gists API
GitHub Issues API
GitHub Licenses API
GitHub Markdown API
GitHub Meta API
GitHub Notifications API
GitHub Octocat API
GitHub Projects API
GitHub Repos API
GitHub Search API
Where this information came from

This is an independent, third-party profile of GitHub Environments API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.