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

# Get Project Key

> Get Project Key detail including Kafka ACLs and whitelist IPs for edit modal hydration.



## OpenAPI

````yaml /openapi/openapi.json get /project-keys/{project_key_id}
openapi: 3.1.0
info:
  title: Streamkap REST API
  description: >-
    The Streamkap REST API allows you to programmatically manage your CDC
    pipelines, sources, destinations, transforms, and more.


    Authenticate using a bearer token obtained from the [Access
    Token](/api-reference/auth/access-token) endpoint with your API client
    credentials.
  contact:
    name: Streamkap Support
    url: https://streamkap.com/
    email: support@streamkap.com
  license:
    name: Proprietary
  version: 2.0.0
servers:
  - url: https://api.streamkap.com
    description: Production
security: []
tags:
  - name: Alerts
    description: Manage alert subscribers, preferences, and notification credentials.
  - name: Authentication
    description: Obtain and refresh access tokens, manage client credentials and roles.
  - name: Billing
    description: Retrieve usage metrics, summaries, and export billing data.
  - name: Consumer Groups
    description: List, inspect, and reset Kafka consumer group offsets.
  - name: Dashboard
    description: Retrieve organisation-level statistics and overview data.
  - name: Destinations
    description: Create, configure, and manage data destinations and their lifecycle.
  - name: Kafka Access
    description: Manage Kafka users and their access permissions.
  - name: Logs
    description: Query and summarise system logs.
  - name: Pipelines
    description: Create, configure, and manage CDC pipelines and their lifecycle.
  - name: Project Keys
    description: Manage project keys that bundle API credentials and optional Kafka access.
  - name: Schema Registry
    description: Browse schema subjects, versions, and retrieve schema definitions.
  - name: Services
    description: View and switch service metadata.
  - name: Sources
    description: >-
      Create, configure, and manage data sources, snapshots, and their
      lifecycle.
  - name: Tags
    description: Create, update, and manage resource tags for organisation.
  - name: Topics
    description: Browse topic details, statistics, configurations, metrics, and messages.
  - name: Transforms
    description: >-
      Create, deploy, and manage data transforms, unit tests, and implementation
      details.
paths:
  /project-keys/{project_key_id}:
    get:
      tags:
        - Project Keys
      summary: Get Project Key
      description: >-
        Get Project Key detail including Kafka ACLs and whitelist IPs for edit
        modal hydration.
      operationId: getProjectKey
      parameters:
        - name: project_key_id
          in: path
          required: true
          schema:
            type: string
            title: Project Key Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProjectKeyDetail'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - FronteggHTTPAuthentication: []
components:
  schemas:
    ProjectKeyDetail:
      properties:
        id:
          type: string
          title: Id
        name:
          type: string
          title: Name
        description:
          anyOf:
            - type: string
            - type: 'null'
          title: Description
        created_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Created At
        created_by_user:
          anyOf:
            - $ref: '#/components/schemas/User'
            - type: 'null'
        api_client_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Api Client Id
        api_client_id_masked_secret:
          anyOf:
            - type: string
            - type: 'null'
          title: Api Client Id Masked Secret
        kafka_username:
          anyOf:
            - type: string
            - type: 'null'
          title: Kafka Username
        service_id:
          type: string
          title: Service Id
        roles:
          items:
            $ref: '#/components/schemas/Role'
          type: array
          title: Roles
        status:
          type: string
          title: Status
        last_used_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Last Used At
        tool_profile:
          anyOf:
            - $ref: '#/components/schemas/ToolProfile'
            - type: 'null'
        allowed_tools:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Allowed Tools
        blocked_tools:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Blocked Tools
        kafka_acls:
          items:
            additionalProperties: true
            type: object
          type: array
          title: Kafka Acls
        whitelist_ips:
          anyOf:
            - type: string
            - type: 'null'
          title: Whitelist Ips
        kafka_proxy_endpoint:
          anyOf:
            - type: string
            - type: 'null'
          title: Kafka Proxy Endpoint
          description: Kafka proxy endpoint (e.g. host:32400)
        schema_proxy_endpoint:
          anyOf:
            - type: string
            - type: 'null'
          title: Schema Proxy Endpoint
          description: Schema Registry proxy endpoint
        token_ttl_seconds:
          type: integer
          title: Token Ttl Seconds
          description: >-
            Frontegg JWT token TTL in seconds (dynamic — reflects the current
            tenant-level authentication token expiration setting in Frontegg).
            Frontend uses this to display 'role changes take effect within X
            hours' on role updates.
      additionalProperties: true
      type: object
      required:
        - id
        - name
        - service_id
        - status
      title: ProjectKeyDetail
      description: >-
        Detail response for GET /project-keys/{id} — includes Kafka ACLs,
        whitelist IPs, and proxy endpoints.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    User:
      properties:
        id:
          type: string
          title: Id
        email:
          type: string
          title: Email
        name:
          type: string
          title: Name
        profile_picture_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Profile Picture Url
        phone_number:
          anyOf:
            - type: string
            - type: 'null'
          title: Phone Number
        tenant_id:
          type: string
          title: Tenant Id
        created_at:
          anyOf:
            - type: string
            - type: string
              format: date-time
            - type: 'null'
          title: Created At
        last_login:
          anyOf:
            - type: string
            - type: string
              format: date-time
            - type: 'null'
          title: Last Login
      type: object
      required:
        - id
        - email
        - name
        - tenant_id
      title: User
    Role:
      properties:
        id:
          type: string
          title: Id
        key:
          type: string
          title: Key
        name:
          type: string
          title: Name
        description:
          anyOf:
            - type: string
            - type: 'null'
          title: Description
        created_at:
          anyOf:
            - type: string
            - type: string
              format: date-time
            - type: 'null'
          title: Created At
        updated_at:
          anyOf:
            - type: string
            - type: string
              format: date-time
            - type: 'null'
          title: Updated At
        permissions:
          items:
            type: string
          type: array
          title: Permissions
      type: object
      required:
        - id
        - key
        - name
        - description
      title: Role
    ToolProfile:
      type: string
      enum:
        - full
        - read-only
        - agent-operator
        - infra-admin
      title: ToolProfile
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    FronteggHTTPAuthentication:
      type: http
      scheme: bearer

````