Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Netlify devServer API

The devServer API from Netlify — 3 operation(s) for devserver.

Netlify devServer 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 devServer. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an AsyncAPI specification, and a getting-started guide.

This API exposes 5 operations across 3 paths, and defines 2 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.

5 operations 3 paths 2 schemas 1 DELETE2 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
2.33.1
Base URL
https://api.netlify.com/api/v1/
Authentication
OAuth 2.0
Terms of Service
Resource Areas
1

Authentication & Security 1

Netlify devServer 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 5

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

devServer 5
GET
/sites/{site_id}/dev_servers
listSiteDevServers 3 params → 200default
POST
/sites/{site_id}/dev_servers
createSiteDevServer 2 params → 200default
DELETE
/sites/{site_id}/dev_servers
deleteSiteDevServers 2 params → 202default
GET
/sites/{site_id}/dev_servers/{dev_server_id}
getSiteDevServer 2 params → 200
POST
/sites/{site_id}/dev_servers/{dev_server_id}/activity
markDevServerActivity 2 params → 200

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are devServer (12 properties), error (2 properties). Each schema is shown below with its type and property counts.

devServer
object
12 properties
error
object
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

netlify-devserver-api-openapi.yml Raw ↑

Other APIs Netlify publishes across the network.

Netlify accessToken API
Netlify accountMembership API
Netlify accountType API
Netlify Asset API
Netlify assetPublicSignature API
Netlify auditLog API
Netlify Build API
Netlify buildHook API
Netlify buildLogMsg API
Netlify Deploy API
Netlify deployedBranch API
Netlify deployKey API