Netlify X-Internal API
The X-Internal API from Netlify — 3 operation(s) for x-internal.
Netlify X-Internal 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 X-Internal. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an AsyncAPI specification, and a getting-started guide.
This API exposes 3 operations across 3 paths, and defines 5 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 X-Internal 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 3
Across 3 paths, the API surfaces 3 operations — 1 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
Schemas 5
The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are pluginRunData (7 properties), plugin (2 properties), error (2 properties), pluginParams (1 property). 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.