openapi: 3.2.0 info: version: 2.57.0 title: Netlify's API documentation Dev Server API description: Netlify is a hosting service for the programmable web. termsOfService: https://www.netlify.com/legal/terms-of-use/ x-logo: url: netlify-logo.png href: https://www.netlify.com/docs/ altText: Netlify servers: - url: https://api.netlify.com/api/v1 security: - netlifyAuth: [] tags: - name: Dev Server x-displayName: Dev server paths: /sites/{site_id}/dev_servers: parameters: - name: site_id in: path required: true schema: type: string get: operationId: listSiteDevServers tags: - Dev Server parameters: - name: page required: false in: query schema: type: integer format: int32 - name: per_page required: false in: query schema: type: integer format: int32 responses: '200': description: OK content: application/json: schema: type: array items: type: object properties: id: type: string site_id: type: string branch: type: string url: type: string state: type: string created_at: type: string format: dateTime updated_at: type: string format: dateTime starting_at: type: string format: dateTime error_at: type: string format: dateTime live_at: type: string format: dateTime done_at: type: string format: dateTime title: type: string default: description: error content: application/json: schema: type: object required: - message properties: code: type: integer format: int64 message: type: string summary: List site dev servers x-summary-source: derived post: operationId: createSiteDevServer tags: - Dev Server parameters: - name: branch in: query schema: type: string responses: '200': description: OK content: application/json: schema: type: array items: type: object properties: id: type: string site_id: type: string branch: type: string url: type: string state: type: string created_at: type: string format: dateTime updated_at: type: string format: dateTime starting_at: type: string format: dateTime error_at: type: string format: dateTime live_at: type: string format: dateTime done_at: type: string format: dateTime title: type: string default: description: error content: application/json: schema: type: object required: - message properties: code: type: integer format: int64 message: type: string summary: Create site dev server x-summary-source: derived delete: operationId: deleteSiteDevServers tags: - Dev Server parameters: - name: branch in: query schema: type: string responses: '202': description: OK default: description: error content: application/json: schema: type: object required: - message properties: code: type: integer format: int64 message: type: string summary: Delete site dev servers x-summary-source: derived /sites/{site_id}/dev_servers/{dev_server_id}: parameters: - name: site_id in: path required: true schema: type: string - name: dev_server_id in: path required: true schema: type: string get: operationId: getSiteDevServer tags: - Dev Server responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string site_id: type: string branch: type: string url: type: string state: type: string created_at: type: string format: dateTime updated_at: type: string format: dateTime starting_at: type: string format: dateTime error_at: type: string format: dateTime live_at: type: string format: dateTime done_at: type: string format: dateTime title: type: string summary: Get site dev server x-summary-source: derived /sites/{site_id}/dev_servers/{dev_server_id}/activity: parameters: - name: site_id in: path required: true schema: type: string - name: dev_server_id in: path required: true schema: type: string post: x-internal: true operationId: markDevServerActivity tags: - Dev Server responses: '200': description: OK summary: Mark dev server activity x-summary-source: derived /sites/{site_id}/dev_servers/{dev_server_id}/state: parameters: - name: site_id in: path required: true schema: type: string - name: dev_server_id in: path required: true schema: type: string post: operationId: updateDevServerState tags: - Dev Server responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string site_id: type: string branch: type: string url: type: string state: type: string created_at: type: string format: dateTime updated_at: type: string format: dateTime starting_at: type: string format: dateTime error_at: type: string format: dateTime live_at: type: string format: dateTime done_at: type: string format: dateTime title: type: string '409': description: Conflict requestBody: content: application/json: schema: type: object required: - state properties: state: type: string enum: - starting - live - error - done task_id: type: string error: type: string required: true summary: Update dev server state x-summary-source: derived components: securitySchemes: netlifyAuth: type: oauth2 flows: implicit: scopes: {} authorizationUrl: https://app.netlify.com/authorize externalDocs: url: https://www.netlify.com/docs/api/ description: Online documentation x-tagGroups: - name: OAuth tags: - ticket - accessToken - name: User accounts tags: - user - accountMembership - member - accountType - paymentMethod - auditLog - name: Site tags: - site - environmentVariables - file - metadata - purge - snippet - name: Domain names tags: - dnsZone - sniCertificate - name: Deploys tags: - deploy - deployedBranch - deployKey - name: Builds tags: - build - buildLogMsg - name: Dev servers tags: - devServer - name: Webhooks and notifications tags: - hook - hookType - buildHook - devServerHook - name: Services tags: - service - serviceInstance - name: Functions tags: - function - name: Database tags: - database - name: Forms tags: - form - submission - name: Split tests tags: - splitTest - name: Large media tags: - asset - assetPublicSignature