Netlify Deploy API
The Deploy API from Netlify — 8 operation(s) for deploy.
Netlify Deploy API is one of 35 APIs that Netlify publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.
Tagged areas include Deploy. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an AsyncAPI specification, and a getting-started guide.
This API exposes 12 operations across 8 paths, and defines 10 schemas. It is described by OpenAPI 3.0.1, at version 2.33.1.
Requests are made against a single base URL, https://api.netlify.com/api/v1.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Netlify Deploy API declares
1 security scheme
for authenticating requests.
It supports OAuth 2.0 (netlifyAuth) using the implicit flow.
By default, every request must be authenticated.
Paths & Operations 12
Across 8 paths, the API surfaces 12 operations — 2 DELETE, 3 GET, 5 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.
Schemas 10
The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are deploy (30 properties), deployFiles (9 properties), functionConfig (7 properties), functionRoute (5 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Netlify 12
Other APIs Netlify publishes across the network.