Snyk API — DeploymentCredentials

naftiko: 1.0.0-alpha2
info:
  label: Snyk API — DeploymentCredentials
  description: 'Snyk API — DeploymentCredentials. 5 operations. Lead operation: List Deployment credentials. Self-contained
    Naftiko capability covering one Snyk business surface.'
  tags:
  - Snyk
  - DeploymentCredentials
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    SNYK_API_KEY: SNYK_API_KEY
capability:
  consumes:
  - type: http
    namespace: rest-deploymentcredentials
    baseUri: https://api.snyk.io/rest
    description: Snyk API — DeploymentCredentials business capability. Self-contained, no shared references.
    resources:
    - name: tenants-tenant_id-brokers-installs-install_id-deployments-deployment_id-credenti
      path: /tenants/{tenant_id}/brokers/installs/{install_id}/deployments/{deployment_id}/credentials
      operations:
      - name: listdeploymentcredentials
        method: GET
        description: List Deployment credentials
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: limit
          in: query
          type: integer
          description: Number of results to return per page
        - name: version
          in: query
          type: string
          description: The requested version of the endpoint to process the request
          required: true
      - name: createdeploymentcredential
        method: POST
        description: Create deployment credential
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: version
          in: query
          type: string
          description: The requested version of the endpoint to process the request
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: tenants-tenant_id-brokers-installs-install_id-deployments-deployment_id-credenti
      path: /tenants/{tenant_id}/brokers/installs/{install_id}/deployments/{deployment_id}/credentials/{credential_id}
      operations:
      - name: deletedeploymentcredential
        method: DELETE
        description: Deletes Deployment credential
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: version
          in: query
          type: string
          description: The requested version of the endpoint to process the request
          required: true
      - name: getdeploymentcredential
        method: GET
        description: Get Deployment credential
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: version
          in: query
          type: string
          description: The requested version of the endpoint to process the request
          required: true
        - name: limit
          in: query
          type: integer
          description: Number of results to return per page
      - name: updatedeploymentcredential
        method: PATCH
        description: Updates Deployment credential
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: version
          in: query
          type: string
          description: The requested version of the endpoint to process the request
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    authentication:
      type: bearer
      token: '{{env.SNYK_API_KEY}}'
  exposes:
  - type: rest
    namespace: rest-deploymentcredentials-rest
    port: 8080
    description: REST adapter for Snyk API — DeploymentCredentials. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/tenants/{tenant-id}/brokers/installs/{install-id}/deployments/{deployment-id}/credentials
      name: tenants-tenant-id-brokers-installs-install-id-deployments-deployment-id-credenti
      description: REST surface for tenants-tenant_id-brokers-installs-install_id-deployments-deployment_id-credenti.
      operations:
      - method: GET
        name: listdeploymentcredentials
        description: List Deployment credentials
        call: rest-deploymentcredentials.listdeploymentcredentials
        with:
          limit: rest.limit
          version: rest.version
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createdeploymentcredential
        description: Create deployment credential
        call: rest-deploymentcredentials.createdeploymentcredential
        with:
          version: rest.version
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/tenants/{tenant-id}/brokers/installs/{install-id}/deployments/{deployment-id}/credentials/{credential-id}
      name: tenants-tenant-id-brokers-installs-install-id-deployments-deployment-id-credenti
      description: REST surface for tenants-tenant_id-brokers-installs-install_id-deployments-deployment_id-credenti.
      operations:
      - method: DELETE
        name: deletedeploymentcredential
        description: Deletes Deployment credential
        call: rest-deploymentcredentials.deletedeploymentcredential
        with:
          version: rest.version
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: getdeploymentcredential
        description: Get Deployment credential
        call: rest-deploymentcredentials.getdeploymentcredential
        with:
          version: rest.version
          limit: rest.limit
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: updatedeploymentcredential
        description: Updates Deployment credential
        call: rest-deploymentcredentials.updatedeploymentcredential
        with:
          version: rest.version
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: rest-deploymentcredentials-mcp
    port: 9090
    transport: http
    description: MCP adapter for Snyk API — DeploymentCredentials. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: list-deployment-credentials
      description: List Deployment credentials
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-deploymentcredentials.listdeploymentcredentials
      with:
        limit: tools.limit
        version: tools.version
      outputParameters:
      - type: object
        mapping: $.
    - name: create-deployment-credential
      description: Create deployment credential
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: rest-deploymentcredentials.createdeploymentcredential
      with:
        version: tools.version
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: deletes-deployment-credential
      description: Deletes Deployment credential
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: rest-deploymentcredentials.deletedeploymentcredential
      with:
        version: tools.version
      outputParameters:
      - type: object
        mapping: $.
    - name: get-deployment-credential
      description: Get Deployment credential
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-deploymentcredentials.getdeploymentcredential
      with:
        version: tools.version
        limit: tools.limit
      outputParameters:
      - type: object
        mapping: $.
    - name: updates-deployment-credential
      description: Updates Deployment credential
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: rest-deploymentcredentials.updatedeploymentcredential
      with:
        version: tools.version
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.