Fastly Service API

The Service API from Fastly — 4 operation(s) for service.

Operations 7

GET /service List services #
POST /service Create a service #
GET /service/{service_id} Get a service #
PUT /service/{service_id} Update a service #
DELETE /service/{service_id} Delete a service #
GET /service/{service_id}/details Get service details #
GET /service/search Search for a service by name #

Documentation

📖
Documentation
https://www.fastly.com/documentation/reference/api/services/
📖
Documentation
https://www.fastly.com/documentation/reference/api/purging/
📖
Documentation
https://www.fastly.com/documentation/reference/api/logging/
📖
Documentation
https://www.fastly.com/documentation/reference/api/metrics-stats/
📖
Documentation
https://www.fastly.com/documentation/reference/api/tls/
📖
Documentation
https://www.fastly.com/documentation/reference/api/vcl-services/
📖
Documentation
https://www.fastly.com/documentation/reference/api/account/
📖
Documentation
https://www.fastly.com/documentation/reference/api/auth-tokens/
📖
Documentation
https://www.fastly.com/documentation/reference/api/acls/
📖
Documentation
https://www.fastly.com/documentation/reference/api/dictionaries/
📖
Documentation
https://www.fastly.com/documentation/guides/compute/
📖
Documentation
https://www.fastly.com/documentation/reference/api/ngwaf/
📖
Documentation
https://www.fastly.com/documentation/reference/api/domain-management/
📖
Documentation
https://www.fastly.com/documentation/reference/api/products/
📖
Documentation
https://www.fastly.com/documentation/reference/api/observability/
📖
Documentation
https://www.fastly.com/documentation/reference/api/api-security/
📖
Documentation
https://www.fastly.com/documentation/reference/api/ddos-protection/
📖
Documentation
https://www.fastly.com/documentation/reference/api/client-side-protection/
📖
Documentation
https://www.fastly.com/documentation/reference/api/publishing/
📖
Documentation
https://www.fastly.com/documentation/reference/api/load-balancing/
📖
Documentation
https://www.fastly.com/documentation/reference/api/utils/
📖
Documentation
https://www.fastly.com/products/ai
📖
Documentation
https://www.fastly.com/products/object-storage

Specifications

Other Resources

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/fastly-service-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

fastly-service-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Fastly Services Service API
  description: The Fastly Services API allows developers to create, configure, and manage Fastly CDN services and their versions programmatically. Services are the primary organizational unit in Fastly, representing a configuration that maps domains to backends. The API supports creating service versions, activating and deactivating configurations, cloning versions, and managing the complete lifecycle of a CDN service deployment.
  version: '1.0'
  contact:
    name: Fastly Support
    url: https://support.fastly.com
  termsOfService: https://www.fastly.com/terms
servers:
- url: https://api.fastly.com
  description: Fastly API Production Server
security:
- apiKeyAuth: []
tags:
- name: Service
paths:
  /service:
    get:
      operationId: listServices
      summary: List services
      description: Retrieves a list of all services associated with the authenticated account. Returns basic information about each service including its name, ID, and current active version.
      tags:
      - Service
      parameters:
      - $ref: '#/components/parameters/pageNumber'
      - $ref: '#/components/parameters/perPage'
      - name: sort
        in: query
        description: The field to sort results by.
        schema:
          type: string
          enum:
          - created
          - name
          - updated
      - name: direction
        in: query
        description: The direction to sort results in.
        schema:
          type: string
          enum:
          - ascend
          - descend
      responses:
        '200':
          description: Successfully retrieved list of services.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Service'
        '401':
          description: Unauthorized. The API token is missing or invalid.
        '403':
          description: Forbidden. The API token does not have the required permissions.
    post:
      operationId: createService
      summary: Create a service
      description: Creates a new Fastly service. A service represents the configuration for a website, application, API, or other resource to be served through Fastly's edge network.
      tags:
      - Service
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              required:
              - name
              properties:
                name:
                  type: string
                  description: The name of the service.
                comment:
                  type: string
                  description: An optional comment about the service.
                type:
                  type: string
                  description: The type of service, either vcl or wasm.
                  enum:
                  - vcl
                  - wasm
      responses:
        '200':
          description: Successfully created the service.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Service'
        '400':
          description: Bad request. Missing or invalid parameters.
        '401':
          description: Unauthorized. The API token is missing or invalid.
        '403':
          description: Forbidden. The API token does not have the required permissions.
  /service/{service_id}:
    get:
      operationId: getService
      summary: Get a service
      description: Retrieves detailed information about a specific Fastly service identified by its service ID.
      tags:
      - Service
      parameters:
      - $ref: '#/components/parameters/serviceId'
      responses:
        '200':
          description: Successfully retrieved the service details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Service'
        '401':
          description: Unauthorized. The API token is missing or invalid.
        '404':
          description: Service not found.
    put:
      operationId: updateService
      summary: Update a service
      description: Updates the details of a specific Fastly service, such as its name or comment.
      tags:
      - Service
      parameters:
      - $ref: '#/components/parameters/serviceId'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: The name of the service.
                comment:
                  type: string
                  description: An optional comment about the service.
      responses:
        '200':
          description: Successfully updated the service.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Service'
        '400':
          description: Bad request. Missing or invalid parameters.
        '401':
          description: Unauthorized. The API token is missing or invalid.
        '404':
          description: Service not found.
    delete:
      operationId: deleteService
      summary: Delete a service
      description: Permanently deletes a specific Fastly service. This action cannot be undone and the service must be deactivated before deletion.
      tags:
      - Service
      parameters:
      - $ref: '#/components/parameters/serviceId'
      responses:
        '200':
          description: Successfully deleted the service.
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    description: Confirmation status of the deletion.
        '401':
          description: Unauthorized. The API token is missing or invalid.
        '404':
          description: Service not found.
  /service/{service_id}/details:
    get:
      operationId: getServiceDetails
      summary: Get service details
      description: Retrieves detailed information about a specific service including all of its versions and their associated settings.
      tags:
      - Service
      parameters:
      - $ref: '#/components/parameters/serviceId'
      responses:
        '200':
          description: Successfully retrieved detailed service information.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceDetail'
        '401':
          description: Unauthorized. The API token is missing or invalid.
        '404':
          description: Service not found.
  /service/search:
    get:
      operationId: searchService
      summary: Search for a service by name
      description: Searches for a service by its name and returns the matching service details.
      tags:
      - Service
      parameters:
      - name: name
        in: query
        required: true
        description: The name of the service to search for.
        schema:
          type: string
      responses:
        '200':
          description: Successfully found the service.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Service'
        '401':
          description: Unauthorized. The API token is missing or invalid.
        '404':
          description: Service not found.
components:
  schemas:
    ServiceVersion:
      type: object
      description: A version of a Fastly service. Versions represent distinct configurations that can be activated or deactivated independently.
      properties:
        number:
          type: integer
          description: The version number.
        service_id:
          type: string
          description: The alphanumeric string identifying the service.
        active:
          type: boolean
          description: Whether this version is currently active.
        locked:
          type: boolean
          description: Whether this version is locked and cannot be modified.
        deployed:
          type: boolean
          description: Whether this version has been deployed.
        staging:
          type: boolean
          description: Whether this version is in the staging environment.
        testing:
          type: boolean
          description: Whether this version is in the testing environment.
        comment:
          type: string
          description: A freeform descriptive note about the version.
        created_at:
          type: string
          format: date-time
          description: The date and time in ISO 8601 format when the version was created.
        updated_at:
          type: string
          format: date-time
          description: The date and time in ISO 8601 format when the version was last updated.
        deleted_at:
          type: string
          format: date-time
          nullable: true
          description: The date and time in ISO 8601 format when the version was deleted.
    Service:
      type: object
      description: A Fastly service represents the configuration for a website, app, API, or anything else to be served through Fastly.
      properties:
        id:
          type: string
          description: The alphanumeric string identifying the service.
        name:
          type: string
          description: The name of the service.
        customer_id:
          type: string
          description: The alphanumeric string identifying the customer.
        comment:
          type: string
          description: A freeform descriptive note about the service.
        type:
          type: string
          description: The type of this service, either vcl or wasm.
          enum:
          - vcl
          - wasm
        created_at:
          type: string
          format: date-time
          description: The date and time in ISO 8601 format when the service was created.
        updated_at:
          type: string
          format: date-time
          description: The date and time in ISO 8601 format when the service was last updated.
        deleted_at:
          type: string
          format: date-time
          nullable: true
          description: The date and time in ISO 8601 format when the service was deleted.
        active_version:
          type: integer
          nullable: true
          description: The currently active version number for the service.
        versions:
          type: array
          description: A list of version objects associated with the service.
          items:
            $ref: '#/components/schemas/ServiceVersion'
    ServiceDetail:
      allOf:
      - $ref: '#/components/schemas/Service'
      - type: object
        description: Extended service information including all associated versions and their configuration details.
        properties:
          active_version:
            type: object
            description: The full version object for the currently active version.
            nullable: true
  parameters:
    serviceId:
      name: service_id
      in: path
      required: true
      description: The alphanumeric string identifying the Fastly service.
      schema:
        type: string
    pageNumber:
      name: page
      in: query
      description: The page number to return.
      schema:
        type: integer
        minimum: 1
    perPage:
      name: per_page
      in: query
      description: The number of items to return per page.
      schema:
        type: integer
        minimum: 1
        maximum: 100
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: Fastly-Key
      description: API token used to authenticate requests to the Fastly API. Tokens can be created in the Fastly web interface or via the API.
externalDocs:
  description: Fastly Services API Documentation
  url: https://www.fastly.com/documentation/reference/api/services/