Netlify Netlify's API documentation — serviceInstance

naftiko: 1.0.0-alpha2
info:
  label: Netlify Netlify's API documentation — serviceInstance
  description: 'Netlify Netlify''s API documentation — serviceInstance. 5 operations. Lead operation: serviceInstance. Self-contained
    Naftiko capability covering one Netlify business surface.'
  tags:
  - Netlify
  - serviceInstance
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    NETLIFY_API_KEY: NETLIFY_API_KEY
capability:
  consumes:
  - type: http
    namespace: netlify-serviceinstance
    baseUri: https://api.netlify.com/api/v1
    description: Netlify Netlify's API documentation — serviceInstance business capability. Self-contained, no shared references.
    resources:
    - name: sites-site_id-service-instances
      path: /sites/{site_id}/service-instances
      operations:
      - name: listserviceinstancesforsite
        method: GET
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: site_id
          in: path
          type: string
          required: true
    - name: sites-site_id-services-addon-instances
      path: /sites/{site_id}/services/{addon}/instances
      operations:
      - name: createserviceinstance
        method: POST
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: site_id
          in: path
          type: string
          required: true
        - name: addon
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: sites-site_id-services-addon-instances-instance_id
      path: /sites/{site_id}/services/{addon}/instances/{instance_id}
      operations:
      - name: showserviceinstance
        method: GET
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: site_id
          in: path
          type: string
          required: true
        - name: addon
          in: path
          type: string
          required: true
        - name: instance_id
          in: path
          type: string
          required: true
      - name: updateserviceinstance
        method: PUT
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: site_id
          in: path
          type: string
          required: true
        - name: addon
          in: path
          type: string
          required: true
        - name: instance_id
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deleteserviceinstance
        method: DELETE
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: site_id
          in: path
          type: string
          required: true
        - name: addon
          in: path
          type: string
          required: true
        - name: instance_id
          in: path
          type: string
          required: true
    authentication:
      type: bearer
      token: '{{env.NETLIFY_API_KEY}}'
  exposes:
  - type: rest
    namespace: netlify-serviceinstance-rest
    port: 8080
    description: REST adapter for Netlify Netlify's API documentation — serviceInstance. One Spectral-compliant resource per
      consumed operation, prefixed with /v1.
    resources:
    - path: /v1/sites/{site-id}/service-instances
      name: sites-site-id-service-instances
      description: REST surface for sites-site_id-service-instances.
      operations:
      - method: GET
        name: listserviceinstancesforsite
        description: listserviceinstancesforsite
        call: netlify-serviceinstance.listserviceinstancesforsite
        with:
          site_id: rest.site_id
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/sites/{site-id}/services/{addon}/instances
      name: sites-site-id-services-addon-instances
      description: REST surface for sites-site_id-services-addon-instances.
      operations:
      - method: POST
        name: createserviceinstance
        description: createserviceinstance
        call: netlify-serviceinstance.createserviceinstance
        with:
          site_id: rest.site_id
          addon: rest.addon
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/sites/{site-id}/services/{addon}/instances/{instance-id}
      name: sites-site-id-services-addon-instances-instance-id
      description: REST surface for sites-site_id-services-addon-instances-instance_id.
      operations:
      - method: GET
        name: showserviceinstance
        description: showserviceinstance
        call: netlify-serviceinstance.showserviceinstance
        with:
          site_id: rest.site_id
          addon: rest.addon
          instance_id: rest.instance_id
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updateserviceinstance
        description: updateserviceinstance
        call: netlify-serviceinstance.updateserviceinstance
        with:
          site_id: rest.site_id
          addon: rest.addon
          instance_id: rest.instance_id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteserviceinstance
        description: deleteserviceinstance
        call: netlify-serviceinstance.deleteserviceinstance
        with:
          site_id: rest.site_id
          addon: rest.addon
          instance_id: rest.instance_id
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: netlify-serviceinstance-mcp
    port: 9090
    transport: http
    description: MCP adapter for Netlify Netlify's API documentation — serviceInstance. One tool per consumed operation, routed
      inline through this capability's consumes block.
    tools:
    - name: listserviceinstancesforsite
      description: listserviceinstancesforsite
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: netlify-serviceinstance.listserviceinstancesforsite
      with:
        site_id: tools.site_id
      outputParameters:
      - type: object
        mapping: $.
    - name: createserviceinstance
      description: createserviceinstance
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: netlify-serviceinstance.createserviceinstance
      with:
        site_id: tools.site_id
        addon: tools.addon
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: showserviceinstance
      description: showserviceinstance
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: netlify-serviceinstance.showserviceinstance
      with:
        site_id: tools.site_id
        addon: tools.addon
        instance_id: tools.instance_id
      outputParameters:
      - type: object
        mapping: $.
    - name: updateserviceinstance
      description: updateserviceinstance
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: netlify-serviceinstance.updateserviceinstance
      with:
        site_id: tools.site_id
        addon: tools.addon
        instance_id: tools.instance_id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: deleteserviceinstance
      description: deleteserviceinstance
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: netlify-serviceinstance.deleteserviceinstance
      with:
        site_id: tools.site_id
        addon: tools.addon
        instance_id: tools.instance_id
      outputParameters:
      - type: object
        mapping: $.