> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ankra.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Get credential details



## OpenAPI

````yaml https://platform.ankra.app/openapi.json get /api/v1/org/credentials/{credential_id}
openapi: 3.1.0
info:
  title: FastAPI
  version: 0.1.0
servers:
  - url: https://platform.ankra.app
security: []
tags:
  - name: Clusters
    description: Create, inspect and manage clusters, and the stacks deployed on them.
  - name: Managed Clusters
    description: Provider-managed control planes, driven through one common surface.
  - name: Imported Clusters
    description: Clusters that already existed and were connected to Ankra.
  - name: Cluster Access
    description: Kubeconfigs, service-account tokens and per-cluster access grants.
  - name: Kubernetes
    description: Read and act on the Kubernetes objects inside a cluster.
  - name: DigitalOcean Clusters
    description: Provision and manage DigitalOcean Kubernetes clusters.
  - name: Hetzner Clusters
    description: Provision and manage Hetzner Kubernetes clusters.
  - name: OVH Clusters
    description: Provision and manage OVH Kubernetes clusters.
  - name: Scaleway Clusters
    description: Provision and manage Scaleway Kapsule clusters.
  - name: UpCloud Clusters
    description: Provision and manage UpCloud Kubernetes clusters.
  - name: Applications
    description: Deploy, configure and observe applications across the fleet.
  - name: Stack Profiles
    description: Reusable stack definitions, their versions and sharing.
  - name: Charts
    description: Browse the chart catalogue behind stacks and addons.
  - name: Helm
    description: Helm registries, credentials and the charts they expose.
  - name: Executions
    description: Long-running platform executions and their jobs.
  - name: Operations
    description: Cancel in-flight cluster operations and their jobs.
  - name: Chat
    description: Conversational sessions, plans and confirmable actions.
  - name: AI Agent Runs
    description: Autonomous agent runs and their outcomes.
  - name: AI Tickets
    description: The AI ticket board, its sync connections and settings.
  - name: AI Playbooks
    description: Reusable playbooks the AI lanes execute.
  - name: AI Conditions
    description: Conditions that gate AI autonomy.
  - name: AI Engineering Handoffs
    description: Work the AI lanes escalate to a human engineer.
  - name: AI Environment
    description: The environment and base stacks AI demos deploy into.
  - name: Security
    description: Findings, advisories, SBOMs, compliance and posture.
  - name: Cost
    description: Cluster and fleet cost, rate cards and cost settings.
  - name: Billing
    description: Subscription and spend caps.
  - name: Organisation
    description: Members, invitations, audit logs and organisation settings.
  - name: Account Tokens
    description: Personal access tokens for the API and CLI.
  - name: Credentials
    description: The shared credential store.
  - name: Azure Credentials
    description: Azure credentials and SSH keys.
  - name: DigitalOcean Credentials
    description: DigitalOcean credentials and SSH keys.
  - name: Hetzner Credentials
    description: Hetzner credentials and SSH keys.
  - name: OVH Credentials
    description: OVH credentials and SSH keys.
  - name: Scaleway Credentials
    description: Scaleway credentials.
  - name: UpCloud Credentials
    description: UpCloud credentials and SSH keys.
  - name: Data Source Credentials
    description: Credentials for metrics and log sources.
  - name: DNS Credentials
    description: Credentials for DNS providers.
  - name: DNS
    description: DNS zones and records, including custom organisation zones.
  - name: Cloudflare
    description: Cloudflare domains and the credentials behind them.
  - name: Variables
    description: Organisation- and cluster-scoped variables.
  - name: SOPS
    description: Encrypt and decrypt values with the organisation SOPS config.
  - name: Alerts
    description: Alert integrations and ingest credentials.
  - name: Notifications
    description: Notification routes and their delivery targets.
  - name: Support
    description: Support tickets.
paths:
  /api/v1/org/credentials/{credential_id}:
    get:
      tags:
        - Credentials
      summary: Get credential details
      operationId: get_credential_endpoint_api_v1_org_credentials__credential_id__get
      parameters:
        - in: path
          name: credential_id
          required: true
          schema:
            format: uuid4
            title: Credential Id
            type: string
        - in: header
          name: authorization
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Authorization
        - in: header
          name: x-ankra-organisation-id
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: X-Ankra-Organisation-Id
      responses:
        '200':
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/GetPlatformCredentialResult'
                  - $ref: '#/components/schemas/GetCredentialResult'
                title: >-
                  Response Get Credential Endpoint Api V1 Org Credentials 
                  Credential Id  Get
          description: Credential retrieved successfully
        '401':
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContractDetailError'
          description: Permission or CSRF check failed
        '404':
          description: Credential not found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
components:
  schemas:
    GetPlatformCredentialResult:
      properties:
        access_key:
          anyOf:
            - type: string
            - type: 'null'
          title: Access Key
        access_key_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Access Key Id
        access_token:
          anyOf:
            - type: string
            - type: 'null'
          title: Access Token
        api_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Api Url
        application_key:
          anyOf:
            - type: string
            - type: 'null'
          title: Application Key
        application_secret:
          anyOf:
            - type: string
            - type: 'null'
          title: Application Secret
        available:
          default: true
          title: Available
          type: boolean
        clusters:
          default: []
          items: {}
          title: Clusters
          type: array
        consumer_key:
          anyOf:
            - type: string
            - type: 'null'
          title: Consumer Key
        created_at:
          type: string
          title: Created At
        gitlab_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Gitlab Url
        id:
          format: uuid
          type: string
          title: Id
        name:
          title: Name
          type: string
        display_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Display Name
        operations:
          default: []
          items: {}
          title: Operations
          type: array
        organisation_id:
          format: uuid
          title: Organisation Id
          type: string
        project_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Project Id
        provider:
          title: Provider
          type: string
        role_arn:
          anyOf:
            - type: string
            - type: 'null'
          title: Role Arn
        secret_access_key:
          anyOf:
            - type: string
            - type: 'null'
          title: Secret Access Key
        ssh_public_key:
          anyOf:
            - type: string
            - type: 'null'
          title: Ssh Public Key
        system:
          default: false
          title: System
          type: boolean
        tls_insecure:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Tls Insecure
        token:
          anyOf:
            - type: string
            - type: 'null'
          title: Token
        token_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Token Id
        updated_at:
          title: Updated At
          type: string
        username:
          anyOf:
            - type: string
            - type: 'null'
          title: Username
      required:
        - id
        - name
        - provider
        - organisation_id
        - created_at
        - updated_at
      title: GetPlatformCredentialResult
      type: object
    GetCredentialResult:
      properties:
        access_key_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Access Key Id
        access_token:
          anyOf:
            - type: string
            - type: 'null'
          title: Access Token
        available:
          title: Available
          type: boolean
        clusters:
          items:
            $ref: '#/components/schemas/GetCredentialClusterInfoResult'
          title: Clusters
          type: array
        created_at:
          format: date-time
          type: string
          title: Created At
        gitlab_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Gitlab Url
        id:
          format: uuid
          type: string
          title: Id
        name:
          title: Name
          type: string
        display_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Display Name
        operations:
          items:
            $ref: '#/components/schemas/GetCredentialOperationInfoResult'
          title: Operations
          type: array
        organisation_id:
          format: uuid
          title: Organisation Id
          type: string
        project_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Project Id
        provider:
          title: Provider
          type: string
        role_arn:
          anyOf:
            - type: string
            - type: 'null'
          title: Role Arn
        secret_access_key:
          anyOf:
            - type: string
            - type: 'null'
          title: Secret Access Key
        system:
          title: System
          type: boolean
        token:
          anyOf:
            - type: string
            - type: 'null'
          title: Token
        updated_at:
          format: date-time
          type: string
          title: Updated At
        username:
          anyOf:
            - type: string
            - type: 'null'
          title: Username
      required:
        - id
        - name
        - provider
        - organisation_id
        - system
        - available
        - clusters
        - operations
        - created_at
        - updated_at
      title: GetCredentialResult
      type: object
    ContractDetailError:
      example:
        detail: Cluster not found
      properties:
        detail:
          oneOf:
            - type: string
            - additionalProperties: true
              properties: {}
              type: object
      required:
        - detail
      type: object
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          title: Detail
          type: array
      title: HTTPValidationError
      type: object
    GetCredentialClusterInfoResult:
      properties:
        created_at:
          format: date-time
          type: string
          title: Created At
        id:
          format: uuid
          type: string
          title: Id
        kind:
          $ref: '#/components/schemas/ClusterKind'
        name:
          title: Name
          type: string
      required:
        - id
        - name
        - kind
        - created_at
      title: GetCredentialClusterInfoResult
      type: object
    GetCredentialOperationInfoResult:
      properties:
        cluster_id:
          format: uuid
          title: Cluster Id
          type: string
        cluster_kind:
          $ref: '#/components/schemas/ClusterKind'
        cluster_name:
          type: string
          title: Cluster Name
        id:
          format: uuid
          type: string
          title: Id
        name:
          title: Name
          type: string
        status:
          type: string
          title: Status
      required:
        - id
        - name
        - status
        - cluster_kind
        - cluster_id
        - cluster_name
      title: GetCredentialOperationInfoResult
      type: object
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          title: Location
          type: array
        msg:
          title: Message
          type: string
        type:
          title: Error Type
          type: string
      required:
        - loc
        - msg
        - type
      title: ValidationError
      type: object
    ClusterKind:
      enum:
        - imported
        - managed
        - ankra
        - sandbox
        - hetzner
        - ovh
        - upcloud
        - digitalocean
        - doks
        - uks
      title: ClusterKind
      type: string

````