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

# Update an API Key

> Updates an existing API key. Only available for members or API keys of the organization.



## OpenAPI

````yaml put /api-key
openapi: 3.0.1
info:
  title: Plumaa ID API
  version: 1.0.0
  description: Generated by SOFA
servers:
  - url: https://api.plumaa.id/rest/v1
    description: Production
  - url: https://api.staging.plumaa.id/rest/v1
    description: Staging
security:
  - apiKey: []
tags:
  - name: ApiKey
    description: ApiKey related operations
  - name: Certificate
    description: Certificate related operations
  - name: Issuer
    description: Issuer related operations
  - name: Organization
    description: Organization related operations
  - name: OrganizationLink
    description: OrganizationLink related operations
  - name: OrganizationMember
    description: OrganizationMember related operations
  - name: SignatureRequestInvite
    description: SignatureRequestInvite related operations
  - name: SignatureRequest
    description: SignatureRequest related operations
  - name: Subject
    description: Subject related operations
  - name: Witness
    description: Witness related operations
  - name: Other
    description: Other operations
  - name: Timeseries
    description: Timeseries related operations
  - name: PriceOracle
    description: Aggregated indexed price data
  - name: Wallet
    description: Wallet related operations
  - name: Endorsable
    description: Endorsable related operations
  - name: EndorseEvent
    description: Endorsable transfer event related operations
paths:
  /api-key:
    put:
      tags:
        - ApiKey
      description: >-
        Updates an existing API key. Only available for members or API keys of
        the organization.
      parameters:
        - name: input
          in: query
          required: true
          schema:
            $ref: '#/components/schemas/UpdateApiKeyInput'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                input:
                  $ref: '#/components/schemas/UpdateApiKeyInput'
              required:
                - input
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiKey'
components:
  schemas:
    UpdateApiKeyInput:
      type: object
      required:
        - id
      properties:
        id:
          description: >-
            A field whose value conforms with the standard mongodb object ID as
            described here:
            https://docs.mongodb.com/manual/reference/method/ObjectId/#ObjectId.
            Example: 5e5677d71bdc2ae76344968c
        enabled:
          type: boolean
          description: >-
            Whether the API key is enabled or not. If disabled, it will not be
            possible to make calls through the API with this key.
        name:
          type: string
          description: The name of the API key. It is used to identify the key in the UI.
      description: Input to update an API key.
    ApiKey:
      type: object
      required:
        - id
        - enabled
        - name
        - secret
        - organization
        - createdAt
        - updatedAt
      properties:
        id:
          description: >-
            A field whose value conforms with the standard mongodb object ID as
            described here:
            https://docs.mongodb.com/manual/reference/method/ObjectId/#ObjectId.
            Example: 5e5677d71bdc2ae76344968c
        enabled:
          type: boolean
          description: >-
            Whether the API key is enabled or not. If disabled, it will not be
            possible to make calls through the API with this key.
        name:
          type: string
          description: The name of the API key. It is used to identify the key in the UI.
        secret:
          description: >-
            The secret of the API key. It is used to authenticate the key when
            making calls through the API.
        organization:
          $ref: '#/components/schemas/Organization'
          description: The organization that owns the API key.
        createdAt:
          description: >-
            A date-time string at UTC, such as 2007-12-03T10:15:30Z, compliant
            with the `date-time` format outlined in section 5.6 of the RFC 3339
            profile of the ISO 8601 standard for representation of dates and
            times using the Gregorian calendar.
        updatedAt:
          description: >-
            A date-time string at UTC, such as 2007-12-03T10:15:30Z, compliant
            with the `date-time` format outlined in section 5.6 of the RFC 3339
            profile of the ISO 8601 standard for representation of dates and
            times using the Gregorian calendar.
      description: >-
        An API key allows to make calls through the API. It is linked to an
        organization.
    Organization:
      type: object
      required:
        - id
        - name
        - logo
        - emailAddress
        - createdAt
        - updatedAt
      properties:
        id:
          description: >-
            A field whose value conforms with the standard mongodb object ID as
            described here:
            https://docs.mongodb.com/manual/reference/method/ObjectId/#ObjectId.
            Example: 5e5677d71bdc2ae76344968c
        name:
          type: string
          description: >-
            The name of the Organization. This is the name that will be
            displayed to

            users when interacting with signature requests from this
            organization.
        logo:
          description: >-
            The logo of the Organization. This is the logo that will be
            displayed to

            users when interacting with signature requests from this
            organization.
        emailAddress:
          description: >-
            Email address of the organization. Updates and notifications will be
            sent to this address, as well as the billing information.
        quota:
          $ref: '#/components/schemas/Quota'
          description: Quotas of the Organization.
        policies:
          $ref: '#/components/schemas/Policies'
          description: Policies of the Organization.
        createdAt:
          description: >-
            A date-time string at UTC, such as 2007-12-03T10:15:30Z, compliant
            with the `date-time` format outlined in section 5.6 of the RFC 3339
            profile of the ISO 8601 standard for representation of dates and
            times using the Gregorian calendar.
        updatedAt:
          description: >-
            A date-time string at UTC, such as 2007-12-03T10:15:30Z, compliant
            with the `date-time` format outlined in section 5.6 of the RFC 3339
            profile of the ISO 8601 standard for representation of dates and
            times using the Gregorian calendar.
      description: >-
        An Organization represents an tenant in the Plumaa infrastructure. All
        paid

        resources are associated with an Organization. Organizations can have
        multiple

        certificate members.
    Quota:
      type: object
      required:
        - id
        - API
        - groupedNOM151
        - nom151
      properties:
        id:
          description: >-
            A field whose value conforms with the standard mongodb object ID as
            described here:
            https://docs.mongodb.com/manual/reference/method/ObjectId/#ObjectId.
            Example: 5e5677d71bdc2ae76344968c
        API:
          type: boolean
          description: API is enabled for the organization.
        groupedNOM151:
          type: integer
          format: int32
          description: >-
            The amount of grouped NOM151 certificates available to the
            organization.
        nom151:
          type: integer
          format: int32
          description: The amount of NOM151 certificates available to the organization.
      description: Quota defines the resource limits for an organization.
    Policies:
      type: object
      required:
        - signatureRequest
      properties:
        signatureRequest:
          $ref: '#/components/schemas/SignatureRequestPolicies'
          description: Defines the policies for signatureRequests.
      description: Policies define the behavior of the resources in the organization.
    SignatureRequestPolicies:
      type: object
      required:
        - conservation
      properties:
        conservation:
          type: string
          enum:
            - NOM151
            - MERKLEIZED
            - WITNESS_CO
          description: >-
            Type of conservation strategy to use by default at signature request
            readiness (ie. when draft is false).
      description: SignatureRequestPolicies defines the policies for signatureRequests.
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer

````