Instance API — User Data

naftiko: 1.0.0-alpha2
info:
  label: Instance API — User Data
  description: 'Instance API — User Data. 4 operations. Lead operation: List user data. Self-contained Naftiko capability
    covering one Scaleway business surface.'
  tags:
  - Scaleway
  - User Data
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    SCALEWAY_API_KEY: SCALEWAY_API_KEY
capability:
  consumes:
  - type: http
    namespace: instance-user-data
    baseUri: https://api.scaleway.com
    description: Instance API — User Data business capability. Self-contained, no shared references.
    resources:
    - name: instance-v1-zones-zone-servers-server_id-user_data
      path: /instance/v1/zones/{zone}/servers/{server_id}/user_data
      operations:
      - name: listserveruserdata
        method: GET
        description: List user data
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: zone
          in: path
          type: string
          description: The zone you want to target
          required: true
        - name: server_id
          in: path
          type: string
          description: UUID of the Instance.
          required: true
    - name: instance-v1-zones-zone-servers-server_id-user_data-key
      path: /instance/v1/zones/{zone}/servers/{server_id}/user_data/{key}
      operations:
      - name: getserveruserdata
        method: GET
        description: Get user data
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: zone
          in: path
          type: string
          description: The zone you want to target
          required: true
        - name: server_id
          in: path
          type: string
          description: UUID of the Instance.
          required: true
        - name: key
          in: path
          type: string
          description: Key of the user data to get.
          required: true
      - name: setserveruserdata
        method: PATCH
        description: Add/set user data
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: zone
          in: path
          type: string
          description: The zone you want to target
          required: true
        - name: server_id
          in: path
          type: string
          description: UUID of the Instance.
          required: true
        - name: key
          in: path
          type: string
          description: Key of the user data to set.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deleteserveruserdata
        method: DELETE
        description: Delete user data
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: zone
          in: path
          type: string
          description: The zone you want to target
          required: true
        - name: server_id
          in: path
          type: string
          description: UUID of the Instance.
          required: true
        - name: key
          in: path
          type: string
          description: Key of the user data to delete.
          required: true
    authentication:
      type: apikey
      key: X-Auth-Token
      value: '{{env.SCALEWAY_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: instance-user-data-rest
    port: 8080
    description: REST adapter for Instance API — User Data. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/instance/v1/zones/{zone}/servers/{server-id}/user-data
      name: instance-v1-zones-zone-servers-server-id-user-data
      description: REST surface for instance-v1-zones-zone-servers-server_id-user_data.
      operations:
      - method: GET
        name: listserveruserdata
        description: List user data
        call: instance-user-data.listserveruserdata
        with:
          zone: rest.zone
          server_id: rest.server_id
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/instance/v1/zones/{zone}/servers/{server-id}/user-data/{key}
      name: instance-v1-zones-zone-servers-server-id-user-data-key
      description: REST surface for instance-v1-zones-zone-servers-server_id-user_data-key.
      operations:
      - method: GET
        name: getserveruserdata
        description: Get user data
        call: instance-user-data.getserveruserdata
        with:
          zone: rest.zone
          server_id: rest.server_id
          key: rest.key
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: setserveruserdata
        description: Add/set user data
        call: instance-user-data.setserveruserdata
        with:
          zone: rest.zone
          server_id: rest.server_id
          key: rest.key
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteserveruserdata
        description: Delete user data
        call: instance-user-data.deleteserveruserdata
        with:
          zone: rest.zone
          server_id: rest.server_id
          key: rest.key
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: instance-user-data-mcp
    port: 9090
    transport: http
    description: MCP adapter for Instance API — User Data. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: list-user-data
      description: List user data
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: instance-user-data.listserveruserdata
      with:
        zone: tools.zone
        server_id: tools.server_id
      outputParameters:
      - type: object
        mapping: $.
    - name: get-user-data
      description: Get user data
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: instance-user-data.getserveruserdata
      with:
        zone: tools.zone
        server_id: tools.server_id
        key: tools.key
      outputParameters:
      - type: object
        mapping: $.
    - name: add-set-user-data
      description: Add/set user data
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: instance-user-data.setserveruserdata
      with:
        zone: tools.zone
        server_id: tools.server_id
        key: tools.key
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-user-data
      description: Delete user data
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: instance-user-data.deleteserveruserdata
      with:
        zone: tools.zone
        server_id: tools.server_id
        key: tools.key
      outputParameters:
      - type: object
        mapping: $.