Instaclustr Valkey User V2 API

openapi: 3.2.0
info:
  title: Instaclustr Valkey User V2 API
  version: Current
  x-logo:
    altText: Instaclustr Logo
    backgroundColor: '#FFFFFF'
    url: https://console2.instaclustr.com/assets/logos/instaclustr_logo_for_redocly.svg
  description: 'Operations tagged Valkey User V2 across 2 of this provider''s published API definitions: instaclustr-current-openapi.json, instaclustr-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.instaclustr.com
  description: Instaclustr API
security:
- Basic Authentication: []
tags:
- name: Valkey User V2
  description: ''
  x-insta-tag-group: Cluster Management V2
paths:
  /cluster-management/v2/data-sources/valkey_cluster/{clusterId}/users/v2/:
    parameters:
    - name: clusterId
      in: path
      description: ID of the cluster.
      required: true
      style: simple
      explode: false
      schema:
        type: string
        format: uuid
    x-terraform-resource-name: users_v2
    get:
      tags:
      - Valkey User V2
      summary: List all Valkey users
      responses:
        '200':
          description: Successfully retrieved application users of Valkey.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ValkeyUserSummariesV2'
      operationId: getClusterManagementV2DataSourcesValkeyClusterByClusterIdUsersV2
      x-operation-id-source: derived
    servers:
    - url: https://api.instaclustr.com
      description: Instaclustr API
  /cluster-management/v2/resources/applications/valkey/users/v2/:
    x-terraform-resource-name: valkey_user_v2
    post:
      tags:
      - Valkey User V2
      summary: Create a Valkey User
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ValkeyUserV2'
        required: true
      responses:
        '202':
          description: Valkey user provisioning requested.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValkeyUserV2'
              example:
                clusterId: c1af59c6-ba0e-4cc2-a0f3-65cee17a5f37
                id: c1af59c6-ba0e-4cc2-a0f3-65cee17a5f37_myValkeyUser
                initialPermissions: standard
                password: myPassword0.
                username: myValkeyUser
      x-codegen-request-body-name: body
      operationId: postClusterManagementV2ResourcesApplicationsValkeyUsersV2
      x-operation-id-source: derived
    servers:
    - url: https://api.instaclustr.com
      description: Instaclustr API
  /cluster-management/v2/resources/applications/valkey/users/v2/{valkeyUserId}/:
    parameters:
    - name: valkeyUserId
      in: path
      description: ID of the Valkey user.
      required: true
      style: simple
      explode: false
      schema:
        type: string
    get:
      tags:
      - Valkey User V2
      summary: Get Valkey User details
      responses:
        '200':
          description: Valkey user details retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValkeyUserV2'
              example:
                clusterId: c1af59c6-ba0e-4cc2-a0f3-65cee17a5f37
                id: c1af59c6-ba0e-4cc2-a0f3-65cee17a5f37_myValkeyUser
                initialPermissions: standard
                password: myPassword0.
                username: myValkeyUser
      operationId: getClusterManagementV2ResourcesApplicationsValkeyUsersV2ByValkeyUserId
      x-operation-id-source: derived
    put:
      tags:
      - Valkey User V2
      summary: Update Valkey user password
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ValkeyUserPasswordV2'
        required: true
      responses:
        '202':
          description: Requested Valkey user's password update.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValkeyUserPasswordV2'
        '404':
          description: Valkey cluster not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseV2'
        '503':
          description: Service Unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseV2'
        '504':
          description: Gateway Timeout
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseV2'
      x-codegen-request-body-name: body
      operationId: putClusterManagementV2ResourcesApplicationsValkeyUsersV2ByValkeyUserId
      x-operation-id-source: derived
    delete:
      tags:
      - Valkey User V2
      summary: Delete a Valkey user
      responses:
        '204':
          description: Valkey user delete requested.
          content: {}
      operationId: deleteClusterManagementV2ResourcesApplicationsValkeyUsersV2ByValkeyUserId
      x-operation-id-source: derived
    servers:
    - url: https://api.instaclustr.com
      description: Instaclustr API
components:
  schemas:
    ValkeyUserSummaryV2:
      required:
      - clusterId
      - username
      type: object
      properties:
        clusterId:
          type: string
          description: ID of the Valkey cluster.
          format: uuid
          x-terraform-force-new: true
        id:
          type: string
          description: 'Instaclustr identifier for the Valkey user. The value of this property has the form: [cluster-id]_[valkey-username]'
          readOnly: true
        username:
          pattern: ^(?![zZ][oO][oO][kK][eE][eE][pP][eE][rR]$)[a-zA-Z0-9][a-zA-Z0-9_-]*$
          type: string
          description: Username of the Valkey user.
          x-terraform-force-new: true
      description: Summary of a Valkey User to be applied to a Valkey cluster.
      example:
        clusterId: c1af59c6-ba0e-4cc2-a0f3-65cee17a5f37
        id: c1af59c6-ba0e-4cc2-a0f3-65cee17a5f37_myValkeyUser
        username: myValkeyUser
    ValkeyUserPasswordV2:
      required:
      - password
      type: object
      properties:
        password:
          type: string
          description: Password for the Valkey user.
          format: password
          example: my1password!
          x-terraform-sensitive: true
          x-terraform-write-only: true
      description: Definition of a Valkey User Password Update to be applied to a Valkey user.
      example:
        password: my1password!
    ValkeyUserSummariesV2:
      type: object
      properties:
        valkeyUsers:
          type: array
          description: List of all Valkey users in the cluster.
          items:
            $ref: '#/components/schemas/ValkeyUserSummaryV2'
        clusterId:
          type: string
          description: ID of the valkey cluster
          x-terraform-id: true
      description: A listable data source of all Valkey users within a Valkey Cluster.
    ValkeyUserV2:
      required:
      - clusterId
      - initialPermissions
      - password
      - username
      type: object
      properties:
        password:
          type: string
          description: Password for the Valkey user.
          format: password
          x-terraform-sensitive: true
          x-terraform-write-only: true
        clusterId:
          type: string
          description: ID of the Valkey cluster.
          format: uuid
          x-terraform-force-new: true
        id:
          type: string
          description: 'Instaclustr identifier for the Valkey user. The value of this property has the form: [cluster-id]_[valkey-username]'
          readOnly: true
        initialPermissions:
          type: string
          description: Permissions initially granted to Valkey user upon creation.
          enum:
          - standard
          - read-only
          - none
          x-terraform-force-new: true
          x-terraform-write-only: true
        username:
          pattern: ^(?![zZ][oO][oO][kK][eE][eE][pP][eE][rR]$)[a-zA-Z0-9][a-zA-Z0-9_-]*$
          type: string
          description: Username of the Valkey user.
          x-terraform-force-new: true
      description: Definition of a Valkey User to be applied to a Valkey cluster.
      example:
        clusterId: c1af59c6-ba0e-4cc2-a0f3-65cee17a5f37
        initialPermissions: standard
        password: myPassword0.
        username: myValkeyUser
    ErrorResponseV2:
      title: Root Type for ErrorResponse
      type: object
      properties:
        name:
          type: string
        message:
          type: string
      description: ''
  securitySchemes:
    Basic_Authentication:
      type: http
      description: Most requests to the API must use Basic Authentication and contain a valid username and appropriate API key for the endpoint.<br><br>API keys can be retrieved any time from the <a href='https://console2.instaclustr.com/' target='_blank'>console</a>. To find the API key relevant to the endpoint, refer to the Authentication & Rate Limit section for the endpoint or the group of the endpoint.
      scheme: basic
    No_Authentication:
      type: http
      description: Certain endpoints are publicly available and does not need any authentication to access.
      scheme: none
x-refined-from:
- instaclustr-current-openapi.json
- instaclustr-openapi.yml
x-tagGroups:
- name: Cluster Management V2
  tags:
  - Cluster Management V2 - Trait
  - Account Cluster List V2
  - AWS Encryption Key V2
  - AWS Endpoint DNS Names V2
  - AWS Endpoint Service Names V2
  - AWS Endpoint Service Principals V2
  - AWS FSx ONTAP File Systems
  - AWS FSx ONTAP Filesystem Credentials V2
  - AWS Prefix List Firewall Rule V1
  - AWS Prefix List Firewall Rules V1
  - AWS Security Group Firewall Rule V2
  - AWS Security Group Firewall Rules V2
  - AWS VPC Peer V2
  - Apache Cassandra Provisioning V2
  - Apache Kafka ACL V2
  - Apache Kafka ACL V3
  - Apache Kafka Connect Mirror V2
  - Apache Kafka Connect Provisioning V2
  - Apache Kafka Provisioning V2
  - Apache Kafka Provisioning V3
  - Apache Kafka Rest Proxy User
  - Apache Kafka Schema Registry User
  - Apache Kafka Tiered Storage
  - Apache Kafka Topic V2
  - Apache Kafka Topic V3
  - Apache Kafka User
  - Apache Zookeeper Provisioning V2
  - Azure Private Link Service Subscriptions
  - Azure Vnet Peer V2
  - BYOC AWS CloudFormation
  - BYOC AWS Provider Account Setup V1
  - Cadence Domain Rate Limits V2
  - Cadence Global Domain Rate Limits V2
  - Cadence Provisioning V2
  - ClickHouse Configurations
  - ClickHouse Integrations
  - ClickHouse Provisioning
  - Cloud Provider Details V2
  - Cluster Exclusion Window V2
  - Cluster Maintenance Events V2
  - Cluster Network Firewall Rule V2
  - Cluster Network Firewall Rules V2
  - Cluster Non Recurring Exclusion Window V2
  - Cluster Settings V2
  - Cluster Suspend Resume V2
  - Custom Tags V2
  - GCP PSC Service Attachments Accept List V2
  - GCP VPC Peer V2
  - Horizontal Scaling Operations
  - Karapace Rest Proxy User
  - Karapace Schema Registry User
  - MCP Gateway Backend V1
  - MCP Gateway Persona Access Control V1
  - MCP Gateway Provisioning V1
  - MCP Gateway Tool V1
  - MCP Gateway Virtual Server V1
  - Management Units Usage
  - OpenSearch Egress Rules V2
  - OpenSearch External S3 Bucket V2
  - OpenSearch Provisioning V2
  - PostgreSQL Configuration V2
  - PostgreSQL Operations
  - PostgreSQL Provisioning V2
  - Private Link Private Service Connect Endpoint Addresses V2
  - Redis Provisioning V2
  - Redis User V2
  - Resize Operations V2
  - Terraform Import V2
  - User Actions V3
  - Valkey Provisioning V2
  - Valkey User V2
- name: Monitoring
  tags:
  - Monitoring - Trait
  - Monitoring API
  - Monitoring API - Cluster
  - Monitoring API - Data Centre
  - Monitoring API - Node
- name: User Management
  tags:
  - User Management and SCIM 2.0 API - Trait
  - Service User Management API
  - User Management and SCIM 2.0 API
- name: Other
  tags:
  - Organization Management API
  - Pricing information - Node sizes