openapi: 3.0.1
info:
  contact:
    email: support@aiven.io
    name: Aiven support team
    url: https://aiven.io/support-services
  title: Aiven API Documentation Account Project API
  version: v1
  x-logo:
    altText: Aiven logo
    backgroundColor: '#fafafa'
    href: https://api.aiven.io/doc
    url: https://aiven.io/assets/img/aiven-logo.png
  description: "# Introduction\n\n[Direct link to openapi.json](https://api.aiven.io/doc/openapi.json) for use with external tools\n\n[Aiven](https://aiven.io) is a modern fully-managed open source data platform for streaming, storing, and analyzing data on any public cloud. On Aiven Platform, you can operate your data infrastructure with a few devops tools: [Aiven Console](https://console.aiven.io/), [Aiven Terraform Provider](https://aiven.io/docs/tools/terraform), [Aiven CLI](https://github.com/aiven/aiven-client), and [Aiven Operator for Kubernetes](https://github.com/aiven/aiven-operator). All of them are built on an open secure powerful REST API for integration with custom tooling.\n\nThe Aiven [REST](http://en.wikipedia.org/wiki/Representational_State_Transfer) API\nprovides programmatic access to Aiven.io services. To call the Aiven API, you can use either CLI tools (for example, `cURL` or [Aiven CLI client](https://aiven.io/docs/tools/cli)) or GUI tools, such as the [Aiven public API Postman collection](https://www.postman.com/aiven-apis).\n\nThis Aiven API documentation will help you operate your Aiven organization, projects, or services programmatically by integrating your applications and processes with Aiven.\n\n# Description\n\nAiven's APIs ([Application Programming Interfaces](https://en.wikipedia.org/wiki/API)) power its platform for data management. Aiven has a number of REST APIs that can help you build strong and robust data infrastructure for your applications.\n\nThe Aiven API is organized around core resources. Each core resource has multiple endpoints, which can be interacted with using different HTTP methods.\n\n## Core resources\n\n### Platform APIs\n\n<dl>\n  <dt>Account</dt>\n  <dd>Operations on the organization level related to accounts, projects, teams, users, invites, billing groups, payment methods, credit cards, authentication methods, and more </dd>\n  <dt>User</dt>\n  <dd>Operations related to users and users' profiles, access, authentication, authorization, user management, and more</dd>\n  <dt>Project</dt>\n  <dd>General operations on projects related to users, VPCs, invitations, alerts, peering connections, and more</dd>\n  <dt>BillingGroup</dt>\n  <dd>Operation on invoices, billing groups' credits and events </dd>\n  <dt>Support ticket</dt>\n  <dd>Operations on support tickets: listing, creating, looping users in</dd>\n</dl>\n\n### Services APIs\n\n<dl>\n  <dt>Service</dt>\n  <dd>All general (non-service-specific) operations on the service level: service creation, termination, configuration, updates, information retrieval, reset, and more</dd>\n  <dt>Service Integrations</dt>\n  <dd>Operations related to integrating services and managing service integrations</dd>\n  <dt>Service: ClickHouse</dt>\n  <dd>ClickHouse-specific operations on queries and databases </dd>\n  <dt>Service: Flink</dt>\n  <dd>Operations on Flink queries, jobs, and applications</dd>\n  <dt>Service: Kafka</dt>\n  <dd>Kafka and Kafka Connect specific operations on connectors, ACL entries, quotas, topics, topic messages, schema registry, and more</dd>\n  <dt>Service: Kafka MirrorMaker</dt>\n  <dd>Operations on replication flows</dd>\n  <dt>Service: MySQL</dt>\n  <dd>Fetching service query statistics</dd>\n  <dt>Service: OpenSearch</dt>\n  <dd>Operations on ACL configuration, security administration and configuration</dd>\n  <dt>Service: PostgreSQL</dt>\n  <dd>Operations on extensions, service query statistics, and connection pools</dd>\n</dl>\n\n# Requests\n\nThere are multiple ways you can interact with the Aiven API over HTTP. You can access it by sending requests from a client (for example, a web browser) to the Aiven's server. In this API reference, you'll find code examples of how to do that using `cURL` and a few different client libraries (programming languages).\n\nTo send an API request, you need to specify the following:\n\n* HTTP method\n* Path\n* Request headers\n\n  Typically, `content-type` needs to be set to `application/json`: `content-type: application/json`. There are a few exceptions though.\n\n* Path, query, or body parameters (either required or optional).\n\n```bash\ncurl --request POST \\\n  --url https://api.aiven.io/v1/project/{project}/vpcs \\\n  --header 'Authorization: aivenv1 REPLACE_BEARER_TOKEN' \\\n  --header 'content-type: application/json' \\\n  --data\n     '{\n        \"cloud_name\": \"string\",\n        \"network_cidr\": \"string\",\n        \"peering_connections\": [\n          {\n            \"peer_azure_app_id\": \"string\",\n            \"peer_azure_tenant_id\": \"string\",\n            \"peer_cloud_account\": \"string\",\n            \"peer_region\": \"string\",\n            \"peer_resource_group\": \"string\",\n            \"peer_vpc\": \"string\",\n            \"user_peer_network_cidrs\": [\n              \"string\"\n            ]\n          }\n        ]\n      }'\n```\n\n# Responses\n\nUpon receiving and processing a request, the Aiven API returns the response status code, response headers, and a response body in the `JSON` format. Response bodies include different properties, which can be either required or optional, for example, the ``message`` property, which is an optional human-readable information on the result of the action (deleted, created, or updated).\n\n```json\n{\n    \"cloud_name\": \"string\",\n    \"create_time\": \"string\",\n    \"message\": \"string\",\n    \"network_cidr\": \"string\",\n    \"peering_connections\": [\n        { ... }\n    ],\n    \"pending_build_only_peering_connections\": \"string\",\n    \"project_vpc_id\": \"string\",\n    \"state\": \"ACTIVE\",\n    \"update_time\": \"string\"\n}\n```\n\n## Successful responses\n\nA successful API response returns an HTTP result code between 200 and 299.\n\nExample of the ``created`` response\n\n```json\n  {\n      \"service\": {\n          \"service_name\": \"foobar\",\n          ...\n      }\n  }\n```\n\n## Failed responses\n\nA failed API response returns a HTTP code greater or equal to 400. Additionally, the response may return a list of errors in the response body as JSON, for example\n\n```json\n{\n  \"errors\": [\n    {\n      \"error_code\": \"authentication_failed\",\n      \"message\": \"Authentication failed\",\n      \"status\": 403,\n      \"metadata\": {\n        ...\n      }\n    }\n  ],\n  \"message\": \"Authentication failed\"\n}\n```\n\n> For information on errors' properties and error codes, check [Errors](/doc/openapi/openapi-description#errors).\n\n# Get started\n\nCheck out how to start using the Aiven API either in [API quick start](https://aiven.io/docs/tools/api#api-quickstart) or [Your first API call](https://aiven.io/blog/your-first-aiven-api-call).\n\n## Authentication\n\n<!-- ReDoc-Inject: <security-definitions> -->\n\n# Errors\n\nWhen working with the Aiven API, you may encounter different error responses when you attempt to perform operations that can fail. For example, trying to enable writes for a database that has been powered off would lead to the following error response:\n\n```json\n{\n  \"errors\": [\n    {\n      \"error_code\": \"not_powered\",\n      \"message\": \"Database not powered on\",\n      \"status\": 409\n    }\n  ],\n  \"message\": \"Database not powered on\"\n}\n```\n\n## Check a response for errors\n\nIf a request fails with a HTTP code greater or equal to 400, it returns a list of errors in the response body as JSON. `errors` objects are embedded in the failed API responses.\n\n```json\n{\n  \"errors\": [\n    {\n      \"error_code\": \"account_not_found\",\n      \"message\": \"Account does not exist\",\n      \"status\": 404\n    }\n  ],\n  \"message\": \"Account does not exist\"\n}\n```\n\n## Errors' properties\n\nIn an API response, one or more errors may be included in the ``errors`` array of objects. Each error object may contain a few properties:\n\n* ``status`` (required) is an HTTP error code, which can be used to programmatically identify the error type.\n\n  * ``200`` <= ``status``< ``300`` means a successful request.\n  * ``300`` <= ``status`` <= ``500`` means a failed request.\n\n  ``errors`` can have the following HTTPS status codes:\n\n  * 200 - OK\n  * 201 - Created\n  * 400 - Bad Request\n  * 401 - Unauthorized\n  * 403 - Forbidden\n  * 404 - Not found\n  * 405 - Method Not Allowed\n  * 409 - Conflict\n  * 500 - Internal Server Error\n\n* ``message`` (required) is human-readable information on the error.\n* ``error_code`` is a machine-readable information on the error (see [Error codes](/doc/openapi/openapi-description#error-codes)).\n\n## Error codes\n\nMachine-readable ``error_code`` fields are progressively added to Aiven endpoints to allow you to identify different failure cases programmatically. Currently, the supported values are the following:\n\n- `account_already_exists`\n- `account_already_has_organization`\n- `account_and_project_do_not_match`\n- `account_and_project_must_belong_same_tenant`\n- `account_cannot_be_own_ancestor`\n- `account_must_have_enabled_authentication_method`\n- `account_not_found`\n- `account_team_not_found`\n- `account_unit_cannot_create_for_personal_tier`\n- `account_unit_cannot_have_billing_group`\n- `account_with_child_accounts_cannot_be_deleted`\n- `account_with_projects_cannot_be_deleted`\n- `action_forbidden_for_application_users`\n- `action_forbidden_for_managed_users`\n- `action_forbidden_for_marketplace_users`\n- `action_forbidden_for_scim_users`\n- `action_forbidden_for_timescale_users`\n- `action_forbidden_missing_governance_usergroup`\n- `action_forbidden_on_application_users`\n- `action_forbidden_on_topic_request`\n- `action_forbidden_on_unmanaged_users`\n- `acu_billing_not_allowed`\n- `address_already_belongs_to_organization`\n- `address_in_use`\n- `address_not_found`\n- `api_client_ip_allowlist_blocks_caller`\n- `approval_forbidden_on_topic_request`\n- `approval_missing_on_request`\n- `auth_token_max_age_too_low`\n- `authentication_method_disable_current_not_allowed`\n- `authentication_method_does_not_allow_auto_join_user_group`\n- `authentication_method_limit_reached`\n- `authentication_method_not_found`\n- `backup_failed`\n- `bad_request`\n- `billing_address_not_found`\n- `billing_customer_id_not_found`\n- `billing_group_not_found`\n- `billing_group_organization_active_trial`\n- `billing_group_owning_account_must_be_organization`\n- `billing_metronome_support_contract_not_found`\n- `ca_version_not_in_sequence`\n- `cannot_delete_active_managed_users`\n- `cannot_delete_users_with_organizations_memberships`\n- `cannot_move_project_not_assigned_to_organization`\n- `cannot_remove_managed_users_from_organization`\n- `cannot_set_groups_managed_by_scim_as_auto_join_group`\n- `client_ip_address_policy_violation`\n- `credit_card_not_found`\n- `credit_memo_not_found`\n- `custom_cloud_environment_cloud_not_supported`\n- `custom_cloud_environment_internal`\n- `custom_cloud_environment_invalid_iam_role_arn`\n- `custom_cloud_environment_missing_configuration`\n- `custom_cloud_environment_not_found`\n- `custom_cloud_environment_region_not_supported`\n- `database_not_found`\n- `decline_forbidden_on_topic_request`\n- `deleting_forbidden_on_governance_request`\n- `deleting_forbidden_on_topic_request`\n- `discount_not_found`\n- `feature_not_enabled`\n- `free_plans_in_high_demand_and_unavailable`\n- `free_tier_restricted`\n- `free_trial_extensions_not_available`\n- `free_trial_max_extended`\n- `free_trial_not_active`\n- `free_trial_not_available`\n- `governance_access_no_permission_on_project`\n- `governance_access_not_found`\n- `governance_configuration_already_exists`\n- `governance_configuration_not_found`\n- `governance_group_not_found`\n- `governance_invalid_service_type`\n- `governance_request_already_in_progress`\n- `governance_request_deleted`\n- `idp_no_domains_linked`\n- `index_close_failed`\n- `index_not_found`\n- `internal_server_error`\n- `invalid_backup_configuration`\n- `invalid_cmk_id`\n- `invalid_currency_code`\n- `invalid_date_format`\n- `invalid_email_format`\n- `invalid_governance_group_provided`\n- `invalid_kafka_topic_request_type`\n- `invalid_os_migration_command`\n- `invalid_owner_user_group`\n- `invalid_private_access_settings`\n- `invalid_scim_user_state_update`\n- `invalid_service_type`\n- `invalid_vcs_type`\n- `invitation_expired`\n- `invitation_not_found`\n- `invoice_lines_not_supported`\n- `invoice_not_found`\n- `ip_address_not_present`\n- `ip_address_not_valid`\n- `kafka_acl_not_supported`\n- `kafka_console_governance_enabled`\n- `kafka_governance_not_available`\n- `kafka_governance_not_enabled`\n- `kafka_governance_policy_incomplete`\n- `kafka_partition_reassignment_in_progress`\n- `kafka_policy_violation`\n- `kafka_service_unavailable`\n- `kafka_terraform_governance_enabled`\n- `kafka_topic_already_exists`\n- `kafka_topic_invalid_config`\n- `kafka_topic_not_found`\n- `kafka_topic_not_synchronized`\n- `kafka_topic_queued_for_deletion`\n- `kafka_topic_reserved`\n- `marketplace_aws_customer_or_product_details_not_found`\n- `marketplace_subscription_already_linked_to_organization`\n- `marketplace_subscription_link_expired`\n- `marketplace_subscription_no_access`\n- `metadata_validation_failed`\n- `mfa_required_by_organization`\n- `mp_account_with_active_subscription_deleted`\n- `mp_account_with_commitment_deleted`\n- `mp_account_with_support_contract_deleted`\n- `mp_subscription_not_found`\n- `nested_account_cannot_have_authentication_method`\n- `nested_account_cannot_have_user_groups`\n- `new_subnet_id_required`\n- `no_failed_os_migration`\n- `node_prune_version_not_updated`\n- `not_powered`\n- `opensearch_delete_system_index`\n- `opensearch_internal_server_error`\n- `opensearch_service_unavailable`\n- `opensearch_too_many_requests`\n- `optimization_failed`\n- `optimization_not_found`\n- `organization_aiven_enterprise_contract_denied`\n- `organization_aiven_enterprise_contract_feature_denied`\n- `organization_aiven_enterprise_denied`\n- `organization_aiven_enterprise_organization_required`\n- `organization_cannot_exist_without_root_account`\n- `organization_domain_already_linked`\n- `organization_domain_not_found`\n- `organization_domain_not_root`\n- `organization_domain_verification_failed`\n- `organization_has_active_addresses`\n- `organization_has_active_payment_methods`\n- `organization_kafka_topics_invalid_filters`\n- `organization_mismatch`\n- `organization_must_have_one_super_admin`\n- `organization_not_found`\n- `organization_pending_support_contract_already_exists`\n- `organization_support_contract_tier_not_supported`\n- `organization_tier_downgrade_not_allowed`\n- `organization_user_not_found`\n- `orphaned_project_not_allowed`\n- `parent_account_cannot_be_own_ancestor`\n- `parent_account_not_found`\n- `parent_account_tenant_invalid`\n- `parent_account_too_deep`\n- `payment_method_not_found`\n- `permission_denied`\n- `pg_editor_readonly_violation`\n- `pg_pool_already_exists`\n- `pg_pool_invalid_database`\n- `pg_pool_invalid_name`\n- `pg_pool_not_found`\n- `pg_pool_not_supported`\n- `pg_pool_pinned_pools_not_enabled`\n- `pg_pool_requires_pinned_pools`\n- `pg_pool_too_big`\n- `pg_pool_too_many`\n- `pg_publication_not_found`\n- `pg_replication_slot_not_found`\n- `pg_scram_not_allowed`\n- `project_account_not_active`\n- `project_already_exists`\n- `project_belongs_to_account_billing_group_must_use_api`\n- `project_does_not_exist`\n- `project_has_no_such_user`\n- `project_limitation_not_found`\n- `project_move_invalid`\n- `project_move_organizations_internal_config_not_match`\n- `project_not_found`\n- `project_without_billing_group_must_be_assigned_from_account`\n- `query_validation_failed`\n- `replication_already_exists`\n- `replication_config_invalid`\n- `replication_not_found`\n- `replication_service_not_found`\n- `repository_not_found`\n- `request_already_exists`\n- `request_forbidden`\n- `request_not_found`\n- `request_operation_already_exists`\n- `request_operation_not_found`\n- `resource_managed_by_governance`\n- `resource_managed_by_scim`\n- `resource_not_managed_by_scim`\n- `retired_api_endpoint`\n- `root_account_required`\n- `same_organization_required`\n- `schema_insights_failed`\n- `service_acl_not_found`\n- `service_acl_too_many`\n- `service_does_not_exist`\n- `service_governance_not_enabled`\n- `service_integration_endpoint_not_found`\n- `service_integration_not_found`\n- `service_integration_project_mismatch_source_destination`\n- `service_is_upgrade_pipeline_source`\n- `service_logs_backend_timeout`\n- `service_logs_backend_unavailable`\n- `service_maintenance_required`\n- `service_not_found`\n- `service_type_not_allowed`\n- `service_type_version_pin_locked`\n- `shipping_address_not_found`\n- `signup_welcome_invalid_key`\n- `snapshot_creation_failed`\n- `snapshot_deletion_failed`\n- `snapshot_not_found`\n- `snapshot_restoration_failed`\n- `stripe_customer_owning_account_must_be_organization`\n- `support_contract_and_account_must_be_in_same_organization`\n- `support_contract_earliest_cancellation_date_later_than_end_date`\n- `support_contract_must_have_billing_group`\n- `support_contract_null_tier`\n- `team_limit_exceeded`\n- `team_names_must_be_unique`\n- `tenant_mismatch`\n- `topic_not_found`\n- `unable_to_parse_query`\n- `unit_cannot_be_moved_out_of_organization`\n- `unknown_user_sso_login_attempt`\n- `unsupported_resource_type`\n- `upgrade_pipeline_no_nodes`\n- `upgrade_pipeline_no_validation`\n- `upgrade_pipeline_not_enabled_for_project`\n- `upgrade_pipeline_service_not_destination`\n- `upgrade_pipeline_service_not_found`\n- `upgrade_step_destination_already_has_source`\n- `upgrade_step_destination_service_not_found`\n- `upgrade_step_exceeds_max_chain_length`\n- `upgrade_step_not_found`\n- `upgrade_step_service_type_mismatch`\n- `upgrade_step_source_service_not_found`\n- `upgrade_step_unsupported_service_type`\n- `upgrade_step_validation_not_possible_due_to_service_state`\n- `upgrade_step_would_create_cycle`\n- `upgrade_validation_already_exists`\n- `user_already_in_organization`\n- `user_already_invited_to_organization`\n- `user_cant_login`\n- `user_config_2fa_otp_verification_failed`\n- `user_deactivated`\n- `user_domain_does_not_belong_to_organization_or_no_linked_auth_method`\n- `user_group_names_must_be_unique`\n- `user_group_not_found`\n- `user_groups_belong_to_different_accounts`\n- `user_groups_must_be_from_same_account`\n- `user_has_no_access_to_billing_info`\n- `user_has_no_access_to_project_with_current_authentication_method`\n- `user_has_to_sign_in_with_non_account_authentication_method`\n- `user_has_too_many_disk_addition_requests`\n- `user_is_internal_user`\n- `user_not_account_owner`\n- `user_not_account_owner_of_billing_group`\n- `user_not_account_owner_of_parent_account`\n- `user_not_admin_of_account_billing_group`\n- `user_not_application_user`\n- `user_not_found`\n- `user_not_managed_by_organization`\n- `user_not_organization_admin`\n- `user_not_signed_in_with_account_authentication_method`\n- `user_oauth_authentication_method_not_allowed`\n- `user_password_authentication_method_not_allowed`\n- `user_password_compromised`\n- `user_password_not_found`\n- `user_personal_token_allowed_authentication_methods_cannot_be_disabled`\n- `user_personal_token_not_allowed`\n- `user_personal_tokens_cannot_be_disabled`\n- `user_role_not_allowed_to_perform_operation`\n- `user_saml_authentication_method_not_allowed`\n- `user_weblink_action_expired`\n- `username_is_invalid`\n- `username_is_reserved`\n- `users_belong_to_different_tenant_from_user_group_account`\n- `vcs_integration_installation_not_found_or_not_accessible`\n- `vcs_integration_not_found`\n- `vpc_id_and_subnet_id_required`\n- `webhook_invalid_event_data`\n- `webhook_unauthorized`\n"
servers:
- url: https://api.aiven.io/v1
tags:
- name: Project
  x-displayName: Project
paths:
  /project/{project}/vpc-peering-connection-types:
    get:
      summary: List VPC peering connection types for a project
      tags:
      - Project
      operationId: ListProjectVpcPeeringConnectionTypes
      parameters:
      - $ref: '#/components/parameters/project'
      responses:
        '200':
          description: Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListProjectVpcPeeringConnectionTypesResponse'
      security:
      - tokenAuth: []
        oauth2:
        - projects:read
  /project/{project}/alerts:
    get:
      summary: List active alerts for a project
      tags:
      - Project
      operationId: ProjectAlertsList
      parameters:
      - $ref: '#/components/parameters/project'
      responses:
        '200':
          description: Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProjectAlertsListResponse'
      security:
      - tokenAuth: []
        oauth2:
        - projects:read
  /project:
    post:
      summary: Create a project
      tags:
      - Project
      operationId: ProjectCreate
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProjectCreateRequestBody'
            example:
              account_id: a22ba494e096
              add_account_owners_admin_access: true
              address_lines:
              - Main Street 1
              base_port: 10000
              billing_address: 'DEPRECATED: use split address fields like `company`, `address_lines`, `zip_code`, `city` and `state` instead'
              billing_currency: USD
              billing_emails:
              - email: jane@example.com
              billing_extra_text: 'Purchase order: PO100018'
              billing_group_id: ffb3f0cd-5532-4eb9-8867-f2cac5823492
              card_id: 9330c086-8781-11e5-89ff-5404a64abfef
              city: Helsinki
              cloud: aws-eu-central-1
              company: My Company
              copy_from_project: myexistingproject
              copy_tags: true
              country_code: FI
              project: myproject
              state: ''
              tags: {}
              tech_emails:
              - email: jane@example.com
              use_source_project_billing_group: false
              vat_id: FI27957435
              zip_code: '01234'
      responses:
        '200':
          description: Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProjectCreateResponse'
        '409':
          description: Request conflict
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    title: Human readable error message
                  errors:
                    type: array
                    title: List of error details. Typically there is only one element
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          title: Human readable error message
                        error_code:
                          type: string
                          enum:
                          - project_already_exists
                          title: Machine processable error code. Clients must be prepared to handle new codes.
                          description: 'project_already_exists: Project already exists'
      security:
      - tokenAuth: []
        oauth2:
        - projects:write
    get:
      summary: List projects
      tags:
      - Project
      operationId: ProjectList
      deprecated: true
      description: '<p>DEPRECATED: Use the organization projects API to list projects within each organization</p>'
      responses:
        '200':
          description: Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProjectListResponse'
      security:
      - tokenAuth: []
        oauth2:
        - projects:read
  /project/{project}:
    delete:
      summary: Delete project
      tags:
      - Project
      operationId: ProjectDelete
      deprecated: true
      description: '<p>DEPRECATED: Use the per-organization project DELETE API</p>'
      parameters:
      - $ref: '#/components/parameters/project'
      responses:
        '200':
          description: Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProjectDeleteResponse'
      security:
      - tokenAuth: []
        oauth2:
        - projects:write
    get:
      summary: Get project details
      tags:
      - Project
      operationId: ProjectGet
      deprecated: true
      description: '<p>DEPRECATED: Use the organization project API to retrieve project details</p>'
      parameters:
      - $ref: '#/components/parameters/project'
      responses:
        '200':
          description: Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProjectGetResponse'
      security:
      - tokenAuth: []
        oauth2:
        - projects:read
    put:
      summary: Update project
      tags:
      - Project
      operationId: ProjectUpdate
      deprecated: true
      description: '<p>DEPRECATED: Use the organization project PATCH API for partial updates</p>'
      parameters:
      - $ref: '#/components/parameters/project'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProjectUpdateRequestBody'
            example:
              account_id: a22ba494e096
              add_account_owners_admin_access: true
              address_lines:
              - Main Street 1
              billing_address: 'DEPRECATED: use split address fields like `company`, `address_lines`, `zip_code`, `city` and `state` instead'
              billing_currency: USD
              billing_emails:
              - email: jane@example.com
              billing_extra_text: 'Purchase order: PO100018'
              billing_group_id: ffb3f0cd-5532-4eb9-8867-f2cac5823492
              card_id: 9330c086-8781-11e5-89ff-5404a64abfef
              city: Helsinki
              cloud: aws-eu-central-1
              company: My Company
              country_code: FI
              project_name: myproject
              state: ''
              tags: {}
              tech_emails:
              - email: jane@example.com
              vat_id: FI27957435
              zip_code: '01234'
      responses:
        '200':
          description: Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProjectUpdateResponse'
      security:
      - tokenAuth: []
        oauth2:
        - projects:write
  /project/{project}/download-sbom/{file_format}/{download_cookie}:
    get:
      summary: Download SBOM report
      tags:
      - Project
      operationId: ProjectDownloadSBOMReport
      parameters:
      - $ref: '#/components/parameters/project'
      - $ref: '#/components/parameters/file_format'
      - $ref: '#/components/parameters/download_cookie'
      responses:
        '200':
          description: Returns a SBOM report
          content:
            text/csv:
              schema:
                type: string
                format: binary
            text/json:
              schema:
                type: string
                format: binary
  /project/{project}/generate-sbom-download-url/{file_format}:
    get:
      summary: Generate SBOM for project
      tags:
      - Project
      operationId: ProjectGenerateSbomDownloadUrl
      parameters:
      - $ref: '#/components/parameters/project'
      - $ref: '#/components/parameters/file_format'
      responses:
        '200':
          description: Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProjectGenerateSbomDownloadUrlResponse'
      security:
      - tokenAuth: []
        oauth2:
        - projects:read
  /project/{project}/events:
    get:
      summary: Get project event log entries
      tags:
      - Project
      operationId: ProjectGetEventLogs
      parameters:
      - $ref: '#/components/parameters/project'
      responses:
        '200':
          description: Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProjectGetEventLogsResponse'
      security:
      - tokenAuth: []
        oauth2:
        - projects:read
  /project/{project}/invite:
    post:
      summary: Send project membership invitation
      tags:
      - Project
      operationId: ProjectInvite
      deprecated: true
      description: '<p>DEPRECATED: Use the Organizations APIs to invite users and the Permissions API to manage access</p>'
      parameters:
      - $ref: '#/components/parameters/project'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProjectInviteRequestBody'
            example:
              member_type: admin
              user_email: jane@example.com
      responses:
        '200':
          description: Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProjectInviteResponse'
      security:
      - tokenAuth: []
        oauth2:
        - projects:write
  /project/{project}/invite/{invite_verification_code}:
    post:
      summary: Confirm project invite
      tags:
      - Project
      operationId: ProjectInviteAccept
      deprecated: true
      description: '<p>DEPRECATED: Use the Organizations APIs to invite users and the Permissions API to manage access</p>'
      parameters:
      - $ref: '#/components/parameters/project'
      - $ref: '#/components/parameters/invite_verification_code'
      responses:
        '200':
          description: Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProjectInviteAcceptResponse'
  /project/{project}/invite/{invited_email}:
    delete:
      summary: Delete an invitation to a project
      tags:
      - Project
      operationId: ProjectInviteDelete
      deprecated: true
      description: '<p>DEPRECATED: Use the Organizations APIs to invite users and the Permissions API to manage access</p>'
      parameters:
      - $ref: '#/components/parameters/project'
      - $ref: '#/components/parameters/invited_email'
      responses:
        '200':
          description: Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProjectInviteDeleteResponse'
      security:
      - tokenAuth: []
        oauth2:
        - projects:write
  /project/{project}/privatelink-availability:
    get:
      summary: List Privatelink cloud availability and prices for a project
      tags:
      - Project
      operationId: ProjectPrivatelinkAvailabilityList
      parameters:
      - $ref: '#/components/parameters/project'
      responses:
        '200':
          description: Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProjectPrivatelinkAvailabilityListResponse'
      security:
      - tokenAuth: []
        oauth2:
        - privatelink:read
  /project/{project}/service-types/{service_type}/plans:
    get:
      summary: List service plans
      tags:
      - Project
      operationId: ProjectServicePlanList
      description: <p>Returns a list of the plans available for a service type.</p>
      parameters:
      - $ref: '#/components/parameters/project'
      - $ref: '#/components/parameters/service_type'
      responses:
        '200':
          description: Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProjectServicePlanListResponse'
      security:
      - tokenAuth: []
        oauth2:
        - projects:read
  /project/{project}/pricing/service-types/{service_type}/plans/{service_plan}/clouds/{cloud}:
    get:
      summary: Get plan pricing
      tags:
      - Project
      operationId: ProjectServicePlanPriceGet
      description: <p>Returns pricing information for a service plan.</p>
      parameters:
      - $ref: '#/components/parameters/project'
      - $ref: '#/components/parameters/service_type'
      - $ref: '#/components/parameters/service_plan'
      - $ref: '#/components/parameters/cloud'
      responses:
        '200':
          description: Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProjectServicePlanPriceGetResponse'
      security:
      - tokenAuth: []
        oauth2:
        - projects:read
  /project/{project}/service-types/{service_type}/plans/{service_plan}:
    get:
      summary: Get service plan details
      tags:
      - Project
      operationId: ProjectServicePlanSpecsGet
      description: <p>Returns information about a plan for a service type such as the disk storage and backup configuration.</p>
      parameters:
      - $ref: '#/components/parameters/project'
      - $ref: '#/components/parameters/service_type'
      - $ref: '#/components/parameters/service_plan'
      responses:
        '200':
          description: Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProjectServicePlanSpecsGetResponse'
      security:
      - tokenAuth: []
        oauth2:
        - projects:read
  /project/{project}/service-types/{service_type}:
    get:
      summary: Get service type details
      tags:
      - Project
      operationId: ProjectServiceTypesGet
      description: <p>Returns the configuration options for a service type.</p>
      parameters:
      - $ref: '#/components/parameters/project'
      - $ref: '#/components/parameters/service_type'
      responses:
        '200':
          description: Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProjectServiceTypesGetResponse'
      security:
      - tokenAuth: []
        oauth2:
        - projects:read
  /project/{project}/service-types:
    get:
      summary: List service types
      tags:
      - Project
      operationId: ProjectServiceTypesList
      description: <p>Returns a list of all available service types and their configuration options.</p>
      parameters:
      - $ref: '#/components/parameters/project'
      responses:
        '200':
          description: Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProjectServiceTypesListResponse'
      security:
      - tokenAuth: []
        oauth2:
        - projects:read
  /project/{project}/tags:
    get:
      summary: List all tags attached to this project
      tags:
      - Project
      operationId: ProjectTagsList
      parameters:
      - $ref: '#/components/parameters/project'
      responses:
        '200':
          description: Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProjectTagsListResponse'
      security:
      - tokenAuth: []
        oauth2:
        - projects:read
    put:
      summary: Replace all project tags with a new set of tags, deleting old ones
      tags:
      - Project
      operationId: ProjectTagsReplace
      parameters:
      - $ref: '#/components/parameters/project'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProjectTagsReplaceRequestBody'
            example:
              tags: {}
      responses:
        '200':
          description: Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProjectTagsReplaceResponse'
      security:
      - tokenAuth: []
        oauth2:
        - projects:write
    patch:
      summary: Update one or more tags, creating ones that don't exist, and deleting ones given NULL value
      tags:
      - Project
      operationId: ProjectTagsUpdate
      parameters:
      - $ref: '#/components/parameters/project'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProjectTagsUpdateRequestBody'
            example:
              tags: {}
      responses:
        '200':
          description: Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProjectTagsUpdateResponse'
      security:
      - tokenAuth: []
        oauth2:
        - projects:write
  /project/{project}/users:
    get:
      summary: List users with access to the project. May contain same user multiple times if they belong to multiple teams associated to the project
      tags:
      - Project
      operationId: ProjectUserList
      deprecated: true
      description: '<p>DEPRECATED: Use the Organizations APIs to manage users and the Permissions API to manage access</p>'
      parameters:
      - $ref: '#/components/parameters/project'
      responses:
        '200':
          description: Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProjectUserListResponse'
      security:
      - tokenAuth: []
        oauth2:
        - projects:read
  /project/{project}/user/{user_email}:
    delete:
      summary: Remove user from the project
      tags:
      - Project
      operationId: ProjectUserRemove
      deprecated: true
      description: '<p>DEPRECATED: Use the Organizations APIs to update users and the Permissions API to manage access</p>'
      parameters:
      - $ref: '#/components/parameters/project'
      - $ref: '#/components/parameters/user_email'
      responses:
        '200':
          description: Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProjectUserRemoveResponse'
      security:
      - tokenAuth: []
        oauth2:
        - projects:write
    put:
      summary: Update a project user
      tags:
      - Project
      operationId: ProjectUserUpdate
      deprecated: true
      description: '<p>DEPRECATED: Use the Organizations APIs to update users and the Permissions API to manage access</p>'
      parameters:
      - $ref: '#/components/parameters/project'
      - $ref: '#/components/parameters/user_email'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProjectUserUpdateRequestBody'
            example:
              member_type: admin
      responses:
        '200':
          description: Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProjectUserUpdateResponse'
      security:
      - tokenAuth: []
        oauth2:
        - projects:write
  /project/{project}/vpcs:
    post:
      summary: Create a VPC in a cloud for the project
      tags:
      - Project
      operationId: VpcCreate
      parameters:
      - $ref: '#/components/parameters/project'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VpcCreateRequestBody'
            example:
              cloud_name: aws-eu-central-1
              network_cidr: 192.168.6.0/24
              peering_connections:
              - peer_azure_app_id: adcf7194-d877-4505-a47a-91fefd96e3b8
                peer_azure_tenant_id: adcf7194-d877-4505-a47a-91fefd96e3b8
                peer_cloud_account: '123456789012'
                peer_region: us-east-1
                peer_resource_group: my-peered-rg
                peer_vpc: vpc-2f09a348
                user_peer_network_cidrs:
                - 192.168.6.0/24
      responses:
        '200':
          description: Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VpcCreateResponse'
      security:
      - tokenAuth: []
        oauth2:
        - projects:write
    get:
      summary: List VPCs for a project
      tags:
      - Project
      operationId: VpcList
      parameters:
      - $ref: '#/components/parameters/project'
      responses:
        '200':
          description: Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VpcListResponse'
      security:
      - tokenAuth: []
        oauth2:
        - projects:read
  /project/{project}/vpcs/{project_vpc_id}:
    delete:
      summary: Delete a project VPC
      tags:
      - Project
      operationId: VpcDelete
      parameters:
      - $ref: '#/components/parameters/project'
      - $ref: '#/components/parameters/project_vpc_id'
      responses:
        '200':
          description: Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VpcDeleteResponse'
      security:
      - tokenAuth: []
        oauth2:
        - projects:write
    get:
      summary: Get VPC information
      tags:
      - Project
      operationId: VpcGet
      parameters:
      - $ref: '#/components/parameters/project'
      - $ref: '#/components/parameters/project_vpc_id'
      responses:
        '200':
          description: Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VpcGetResponse'
      security:
      - tokenAuth: []
        oauth2:
        - projects:read
  /project/{project}/vpcs/{project_vpc_id}/peering-connections:
    post:
      summary: Create a peering connection for a project VPC
      tags:
      - Project
      operationId: VpcPeeringConnectionCreate
      parameters:
      - $ref: '#/components/parameters/project'
      - $ref: '#/components/parameters/project_vpc_id'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VpcPeeringConnectionCreateRequestBody'
            example:
              peer_azure_app_id: adcf7194-d877-4505-a47a-91fefd96e3b8
              peer_azure_tenant_id: adcf7194-d877-4505-a47a-91fefd96e3b8
              peer_cloud_account: '123456789012'
              peer_region: us-east-1
              peer_resource_group: my-peered-rg
              peer_vpc: vpc-2f09a348
              user_peer_network_cidrs:
              - 192.168.6.0/24
      responses:
        '200':
          description: Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VpcPeeringConnectionCreateResponse'
      security:
      - tokenAuth: []
        oauth2:
        - projects:write
  /project/{project}/vpcs/{project_vpc_id}/peering-connections/peer-accounts/{peer_cloud_account}/peer-vpcs/{peer_vpc}:
    delete:
      summary: Delete a peering connection for a project VPC
      tags:
      - Project
      operationId: VpcPeeringConnectionDelete
      parameters:
      - $ref: '#/components/parameters/project'
      - $ref: '#/components/parameters/project_vpc_id'
      - $ref: '#/components/parameters/peer_cloud_account'
      - $ref: '#/components/parameters/peer_vpc'
      responses:
        '200':
          description: Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VpcPeeringConnectionDeleteResponse'
      security:
      - tokenAuth: []
        oauth2:
        - projects:write
  /project/{project}/vpcs/{project_vpc_id}/user-peer-network-cidrs:
    put:
      summary: Update user-defined peer network CIDRs for a project VPC
      tags:
      - Project
      operationId: VpcPeeringConnectionUpdate
      parameters:
      - $ref: '#/components/parameters/project'
      - $ref: '#/components/parameters/project_vpc_id'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VpcPeeringConnectionUpdateRequestBody'
            example:
              add:
              - cidr: 192.168.6.0/24
                peer_cloud_account: '123456789012'
                peer_resource_group: my-peered-rg
                peer_vpc: vpc-2f09a348
              delete:
              - 192.168.6.0/24
      responses:
        '200':
          description: Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VpcPeeringConnectionUpdateResponse'
      security:
      - tokenAuth: []
        oauth2:
        - projects:write
  ? /project/{project}/vpcs/{project_vpc_id}/peering-connections/peer-accounts/{peer_cloud_account}/peer-vpcs/{peer_vpc}/peer-regions/{peer_region}
  : delete:
      summary: Delete a peering connection for a project VPC
      tags:
      - Project
      operationId: VpcPeeringConnectionWithRegionDelete
      parameters:
      - $ref: '#/components/parameters/project'
      - $ref: '#/components/parameters/project_vpc_id'
      - $ref: '#/components/parameters/peer_cloud_account'
      - $ref: '#/components/parameters/peer_vpc'
      - $ref: '#/components/parameters/peer_region'
      responses:
        '200':
          description: Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VpcPeeringConnectionWithRegionDeleteResponse'
      security:
      - tokenAuth: []
        oauth2:
        - projects:write
  ? /project/{project}/vpcs/{project_vpc_id}/peering-connections/peer-accounts/{peer_cloud_account}/peer-resource-groups/{peer_resource_group}/peer-vpcs/{peer_vpc}
  : delete:
      summary: Delete a peering connection for a project VPC
      tags:
      - Project
      operationId: VpcPeeringConnectionWithResourceGroupDelete
      parameters:
      - $ref: '#/components/parameters/project'
      - $ref: '#/components/parameters/project_vpc_id'
      - $ref: '#/components/parameters/peer_cloud_account'
      - $ref: '#/components/parameters/peer_resource_group'
      - $ref: '#/components/parameters/peer_vpc'
      responses:
        '200':
          description: Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VpcPeeringConnectionWithResourceGroupDeleteResponse'
      security:
      - tokenAuth: []
        oauth2:
        - projects:write
  /project/{project}/vpcs/{project_vpc_id}/peering-connections/refresh:
    post:
      summary: Check if the state of peering connections in the cloud has changed
      tags:
      - Project
      operationId: VpcPeeringConnectionsRefresh
      description: '<p><blockquote>This endpoint <b>may be changed or removed at any time</b>. Don''t use it in production environments.</blockquote><p>


        <p>Triggers an asynchronous refresh of the peering connection states for a project VPC. Checks the state of the peering connections in the cloud provider and updates them in Aiven. To confirm the refresh has completed, retrieve the project VPC using <code>GET /project/{project}/vpcs/{project_vpc_id}</code> and check that the <code>pending_build_only_peering_connections</code> field has returned to <code>null</code>.</p>'
      x-badges:
      - name: Experimental
        position: after
        color: '#787885'
      x-experimental: true
      parameters:
      - $ref: '#/components/parameters/project'
      - $ref: '#/components/parameters/project_vpc_id'
      responses:
        '200':
          description: Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VpcPeeringConnectionsRefreshResponse'
      security:
      - tokenAuth: []
        oauth2:
        - projects:write
components:
  schemas:
    VpcPeeringConnectionUpdateResponse:
      type: object
      description: VpcPeeringConnectionUpdateResponse
      properties:
        cloud_name:
          type: string
          maxLength: 256
          description: Target cloud
        create_time:
          type: string
          maxLength: 36
          description: VPC creation timestamp
        errors:
          type: array
          description: List of errors occurred during request processing
          items:
            type: object
            properties:
              message:
                type: string
                description: Printable error message
              more_info:
                type: string
                description: URL to the documentation of the error
              status:
                type: integer
                description: HTTP error status code
            required:
            - message
            - status
        message:
          type: string
          description: Printable result of the request
        network_cidr:
          type: string
          maxLength: 18
          description: IPv4 network range CIDR
        peering_connections:
          type: array
          description: List of peering connections
          items:
            type: object
            properties:
              create_time:
                type: string
                maxLength: 36
                description: VPC peering connection creation timestamp
              peer_azure_app_id:
                type: string
                maxLength: 1024
                description: Azure app registration id in UUID4 form that is allowed to create a peering to the peer vnet
              peer_azure_tenant_id:
                type: string
                maxLength: 1024
                description: Azure tenant id in UUID4 form
              peer_cloud_account:
                type: string
                maxLength: 1024
                description: AWS account ID, GCP project ID, Azure subscription ID of the peered VPC, or string &quot;upcloud&quot; for UpCloud peering connections
              peer_region:
                type: string
                maxLength: 1024
                description: The peer VPC's region in AWS clouds. Always null in GCP, Azure, or UpCloud clouds
              peer_resource_group:
                type: string
                maxLength: 1024
                description: Azure resource group name of the peered VPC
              peer_vpc:
                type: string
                maxLength: 1024
                description: AWS VPC ID, GCP VPC network name, Azure Virtual network name of the peered VPC, or UpCloud VPC ID
              peering_connection_id:
                type: string
                minLength: 36
                maxLength: 36
                description: VPC peering connection ID
              state:
                type: string
                description: Project VPC peering connection state
                enum:
                - ACTIVE
                - APPROVED
                - APPROVED_PEER_REQUESTED
                - DELETED
                - DELETED_BY_PEER
                - DELETING
                - ERROR
                - INVALID_SPECIFICATION
                - PENDING_PEER
                - REJECTED_BY_PEER
              state_info:
                type: object
                description: State-specific help or error information
                properties:
                  message:
                    type: string
                    description: Human-readable information message
                  type:
                    type: string
                    description: Type of state information
                  warnings:
                    type: array
                    description: List of warnings if any
                    items:
                      type: object
                      properties:
                        conflicting_aws_account_id:
                          type: string
                          description: AWS account id of conflicting VPC
                        conflicting_aws_vpc_id:
                          type: string
                          description: VPC id which is conflicting with the current one
                        conflicting_aws_vpc_peering_connection_id:
                          type: string
                          description: AWS VPC connection id which is conflicting with current VPC
                        message:
                          type: string
                          description: Warning message to be shown to the user
                        type:
                          type: string
                          description: Type of warning
                          enum:
                          - overlapping-peer-vpc-ip-ranges
                          - upcloud-peering-in-error
                      required:
                      - message
                      - type
                required:
                - message
                - type
              update_time:
                type: string
                maxLength: 36
                description: Timestamp of last change to the VPC peering connection
              user_peer_network_cidrs:
                type: array
                maxItems: 128
                description: List of private IPv4 ranges to route through the peering connection
                items:
                  type: string
              vpc_peering_connection_type:
                type: string
                description: Type of network connection from the VPC
                enum:
                - aws-tgw-vpc-attachment
                - aws-vpc-peering-connection
                - azure-vnet-peering
                - do-vpc-peering
                - google-vpc-peering
                - upcloud-vpc-peering
            required:
            - create_time
            - peer_azure_app_id
            - peer_azure_tenant_id
            - peer_cloud_account
            - peer_resource_group
            - peer_vpc
            - state
            - state_info
            - update_time
            - user_peer_network_cidrs
            - vpc_peering_connection_type
        pending_build_only_peering_connections:
          type: string
          maxLength: 36
          description: VPC rebuild is scheduled
        project_vpc_id:
          type: string
          minLength: 36
          maxLength: 36
          description: Project VPC ID
        state:
          type: string
          description: Project VPC state
          enum:
          - ACTIVE
          - APPROVED
          - DELETED
          - DELETING
        update_time:
          type: string
          maxLength: 36
          description: Timestamp of last change to VPC
      required:
      - cloud_name
      - create_time
      - network_cidr
      - peering_connections
      - project_vpc_id
      - state
      - update_time
    VpcGetResponse:
      type: object
      description: VpcGetResponse
      properties:
        cloud_name:
          type: string
          maxLength: 256
          description: Target cloud
        create_time:
          type: string
          maxLength: 36
          description: VPC creation timestamp
        errors:
          type: array
          description: List of errors occurred during request processing
          items:
            type: object
            properties:
              message:
                type: string
                description: Printable error message
              more_info:
                type: string
                description: URL to the documentation of the error
              status:
                type: integer
                description: HTTP error status code
            required:
            - message
            - status
        message:
          type: string
          description: Printable result of the request
        network_cidr:
          type: string
          maxLength: 18
          description: IPv4 network range CIDR
        peering_connections:
          type: array
          description: List of peering connections
          items:
            type: object
            properties:
              create_time:
                type: string
                maxLength: 36
                description: VPC peering connection creation timestamp
              peer_azure_app_id:
                type: string
                maxLength: 1024
                description: Azure app registration id in UUID4 form that is allowed to create a peering to the peer vnet
              peer_azure_tenant_id:
                type: string
                maxLength: 1024
                description: Azure tenant id in UUID4 form
              peer_cloud_account:
                type: string
                maxLength: 1024
                description: AWS account ID, GCP project ID, Azure subscription ID of the peered VPC, or string &quot;upcloud&quot; for UpCloud peering connections
              peer_region:
                type: string
                maxLength: 1024
                description: The peer VPC's region in AWS clouds. Always null in GCP, Azure, or UpCloud clouds
              peer_resource_group:
                type: string
                maxLength: 1024
                description: Azure resource group name of the peered VPC
              peer_vpc:
                type: string
                maxLength: 1024
                description: AWS VPC ID, GCP VPC network name, Azure Virtual network name of the peered VPC, or UpCloud VPC ID
              peering_connection_id:
                type: string
                minLength: 36
                maxLength: 36
                description: VPC peering connection ID
              state:
                type: string
                description: Project VPC peering connection state
                enum:
                - ACTIVE
                - APPROVED
                - APPROVED_PEER_REQUESTED
                - DELETED
                - DELETED_BY_PEER
                - DELETING
                - ERROR
                - INVALID_SPECIFICATION
                - PENDING_PEER
                - REJECTED_BY_PEER
              state_info:
                type: object
                description: State-specific help or error information
                properties:
                  message:
                    type: string
                    description: Human-readable information message
                  type:
                    type: string
                    description: Type of state information
                  warnings:
                    type: array
                    description: List of warnings if any
                    items:
                      type: object
                      properties:
                        conflicting_aws_account_id:
                          type: string
                          description: AWS account id of conflicting VPC
                        conflicting_aws_vpc_id:
                          type: string
                          description: VPC id which is conflicting with the current one
                        conflicting_aws_vpc_peering_connection_id:
                          type: string
                          description: AWS VPC connection id which is conflicting with current VPC
                        message:
                          type: string
                          description: Warning message to be shown to the user
                        type:
                          type: string
                          description: Type of warning
                          enum:
                          - overlapping-peer-vpc-ip-ranges
                          - upcloud-peering-in-error
                      required:
                      - message
                      - type
                required:
                - message
                - type
              update_time:
                type: string
                maxLength: 36
                description: Timestamp of last change to the VPC peering connection
              user_peer_network_cidrs:
                type: array
                maxItems: 128
                description: List of private IPv4 ranges to route through the peering connection
                items:
                  type: string
              vpc_peering_connection_type:
                type: string
                description: Type of network connection from the VPC
                enum:
                - aws-tgw-vpc-attachment
                - aws-vpc-peering-connection
                - azure-vnet-peering
                - do-vpc-peering
                - google-vpc-peering
                - upcloud-vpc-peering
            required:
            - create_time
            - peer_azure_app_id
            - peer_azure_tenant_id
            - peer_cloud_account
            - peer_resource_group
            - peer_vpc
            - state
            - state_info
            - update_time
            - user_peer_network_cidrs
            - vpc_peering_connection_type
        pending_build_only_peering_connections:
          type: string
          maxLength: 36
          description: VPC rebuild is scheduled
        project_vpc_id:
          type: string
          minLength: 36
          maxLength: 36
          description: Project VPC ID
        state:
          type: string
          description: Project VPC state
          enum:
          - ACTIVE
          - APPROVED
          - DELETED
          - DELETING
        update_time:
          type: string
          maxLength: 36
          description: Timestamp of last change to VPC
      required:
      - cloud_name
      - create_time
      - network_cidr
      - peering_connections
      - project_vpc_id
      - state
      - update_time
    ProjectTagsReplaceResponse:
      type: object
      description: ProjectTagsReplaceResponse
      properties:
        errors:
          type: array
          description: List of errors occurred during request processing
          items:
            type: object
            properties:
              message:
                type: string
                description: Printable error message
              more_info:
                type: string
                description: URL to the documentation of the error
              status:
                type: integer
                description: HTTP error status code
            required:
            - message
            - status
        message:
          type: string
          description: Printable result of the request
    ProjectCreateRequestBody:
      type: object
      description: ProjectCreateRequestBody
      properties:
        account_id:
          type: string
          maxLength: 36
          description: Account ID
        add_account_owners_admin_access:
          type: boolean
          description: '[DEPRECATED] If account_id is set, grant account owner team admin access to the new project. This flag is ignored, and assumed true.'
        address_lines:
          type: array
          maxItems: 3
          description: '[DEPRECATED] Address lines'
          items:
            type: string
        base_port:
          type: integer
          minimum: 10000
          maximum: 29000
          description: New services in this project will use this value as a base when deriving their service port numbers. This allows new services to allocate predictable and specific service ports. If not provided during project creation a random base port is used.
          title: Base value that new services in this project will use to derive their port numbers.
        billing_address:
          type: string
          maxLength: 1000
          description: 'DEPRECATED: use split address fields like company, address_lines, zip_code, city and state instead'
        billing_currency:
          type: string
          description: '[DEPRECATED] Billing currency'
          enum:
          - AUD
          - CAD
          - CHF
          - DKK
          - EUR
          - GBP
          - JPY
          - NOK
          - NZD
          - SEK
          - SGD
          - USD
        billing_emails:
          type: array
          maxItems: 10
          description: '[DEPRECATED] Billing emails'
          items:
            type: object
            properties:
              email:
                type: string
                maxLength: 254
                description: User email address
            required:
            - email
        billing_extra_text:
          type: string
          maxLength: 1000
          description: '[DEPRECATED] Extra text to be included in all project invoices'
        billing_group_id:
          type: string
          minLength: 36
          maxLength: 36
          description: Billing group ID
        card_id:
          type: string
          maxLength: 64
          description: '[DEPRECATED] Credit card ID'
        city:
          type: string
          maxLength: 50
          description: '[DEPRECATED] Address city'
        cloud:
          type: string
          maxLength: 256
          description: Target cloud
        company:
          type: string
          maxLength: 83
          description: '[DEPRECATED] Name of company'
        copy_from_project:
          type: string
          maxLength: 63
          description: Project name from which to copy settings to the new project
        copy_tags:
          type: boolean
          description: Copy tags from the source project. If request contains additional tags, the tags copied from source are updated with them.
          default: false
        country_code:
          type: string
          maxLength: 2
          description: '[DEPRECATED] Two letter country code for billing country'
        project:
          type: string
          maxLength: 63
          description: Project name
        state:
          type: string
          maxLength: 30
          description: '[DEPRECATED] Address state'
        tags:
          type: object
          description: Set of resource tags
          properties: {}
        tech_emails:
          type: array
          maxItems: 10
          description: List of project tech email addresses
          items:
            type: object
            properties:
              email:
                type: string
                maxLength: 254
                description: User email address
            required:
            - email
        use_source_project_billing_group:
          type: boolean
          description: If set to true, use the same billing group that is used in source project. If set to false, create a copy of the billing group used in the source project with the same information. If new project is not being copied from existing one this option has no effect
          title: Use the same billing group that is used in source project.
          default: false
        vat_id:
          type: string
          maxLength: 64
          description: '[DEPRECATED] EU VAT identification'
        zip_code:
          type: string
          maxLength: 36
          description: '[DEPRECATED] Address zip code'
      required:
      - project
    ProjectTagsUpdateResponse:
      type: object
      description: ProjectTagsUpdateResponse
      properties:
        errors:
          type: array
          description: List of errors occurred during request processing
          items:
            type: object
            properties:
              message:
                type: string
                description: Printable error message
              more_info:
                type: string
                description: URL to the documentation of the error
              status:
                type: integer
                description: HTTP error status code
            required:
            - message
            - status
        message:
          type: string
          description: Printable result of the request
    ProjectListResponse:
      type: object
      description: ProjectListResponse
      properties:
        errors:
          type: array
          description: List of errors occurred during request processing
          items:
            type: object
            properties:
              message:
                type: string
                description: Printable error message
              more_info:
                type: string
                description: URL to the documentation of the error
              status:
                type: integer
                description: HTTP error status code
            required:
            - message
            - status
        message:
          type: string
          description: Printable result of the request
        project_membership:
          type: object
          description: Project membership and type of membership
          properties:
            ANY:
              type: string
              description: Project member type
              enum:
              - admin
              - developer
              - operator
              - organization:app_users:write
              - organization:audit_logs:read
              - organization:billing:read
              - organization:billing:write
              - organization:domains:write
              - organization:groups:write
              - organization:networking:read
              - organization:networking:write
              - organization:projects:write
              - organization:users:write
              - project:audit_logs:read
              - project:integrations:read
              - project:integrations:write
              - project:networking:read
              - project:networking:write
              - project:permissions:read
              - project:services:read
              - project:services:write
              - read_only
              - role:organization:admin
              - role:project:admin
              - role:services:maintenance
              - role:services:recover
              - service:configuration:write
              - service:data:write
              - service:logs:read
              - service:metrics:read
              - service:secrets:read
              - service:users:write
        project_memberships:
          type: object
          description: List of project membership and type of membership
          properties:
            ANY:
              type: array
              description: List of project member type
              items:
                type: string
        projects:
          type: array
          description: List of projects
          items:
            type: object
            properties:
              account_id:
                type: string
                maxLength: 36
                description: Account ID
              account_name:
                type: string
                maxLength: 83
                description: Account name
              address_lines:
                type: array
                maxItems: 3
                description: Address lines
                items:
                  type: string
              available_credits:
                type: string
                description: 'DEPRECATED: Available credits, in USD. Always 0.00, use billing group credits instead'
              billing_address:
                type: string
                maxLength: 1000
                description: 'DEPRECATED: use split address fields like company, address_lines, zip_code, city and state instead'
              billing_currency:
                type: string
                description: Billing currency
                enum:
                - AUD
                - CAD
                - CHF
                - DKK
                - EUR
                - GBP
                - JPY
                - NOK
                - NZD
                - SEK
                - SGD
                - USD
              billing_emails:
                type: array
                maxItems: 10
                description: List of project billing email addresses
                items:
                  type: object
                  properties:
                    email:
                      type: string
                      maxLength: 254
                      description: User email address
                  required:
                  - email
              billing_extra_text:
                type: string
                maxLength: 1000
                description: Extra text to be included in all project invoices, e.g. purchase order or cost center number
              billing_group_id:
                type: string
                minLength: 36
                maxLength: 36
                description: Billing group ID
              billing_group_name:
                type: string
                maxLength: 128
                description: Billing group name
              card_info:
                type: object
                description: Credit card assigned to the project
                properties:
                  brand:
                    type: string
                    description: Brand
                  card_id:
                    type: string
                    maxLength: 64
                    description: Credit card ID
                  country:
                    type: string
                    maxLength: 128
                    description: Country
                  country_code:
                    type: string
                    maxLength: 2
                    description: Two letter ISO country code
                  exp_month:
                    type: integer
                    minimum: 1
                    maximum: 12
                    description: Expiration month
                  exp_year:
                    type: integer
                    minimum: 2015
                    maximum: 2100
                    description: Expiration year
                  last4:
                    type: string
                    description: Credit card last four digits
                  name:
                    type: string
                    maxLength: 256
                    description: Name on the credit card
                  user_email:
                    type: string
                    maxLength: 254
                    description: User email address
                required:
                - brand
                - card_id
                - country
                - country_code
                - exp_month
                - exp_year
                - last4
                - name
                - user_email
              city:
                type: string
                maxLength: 50
                description: Address city
              company:
                type: string
                maxLength: 83
                description: Name of a company
              country:
                type: string
                maxLength: 128
                description: Billing country
              country_code:
                type: string
                maxLength: 2
                description: Two letter ISO country code
              default_cloud:
                type: string
                maxLength: 256
                description: Default cloud to use when launching services
              end_of_life_extension:
                type: object
                description: End of life extension information
                properties:
                  elasticsearch:
                    type: object
                    description: Service EOL extension
                    properties:
                      eol_date:
                        type: string
                        description: Extended EOL date
                      version:
                        type: string
                        description: Service version
                    required:
                    - eol_date
                    - version
              estimated_balance:
                type: string
                description: Estimated balance, in USD
              estimated_balance_local:
                type: string
                description: Estimated balance, in billing currency
              features:
                type: object
                description: Feature flags
                properties: {}
              organization_id:
                type: string
                maxLength: 36
                description: Organization ID
              payment_method:
                type: string
                description: Payment method
              project_name:
                type: string
                maxLength: 63
                description: Project name
              state:
                type: string
                maxLength: 30
                description: Address state or province
              tags:
                type: object
                description: Set of resource tags
                properties: {}
              tech_emails:
                type: array
                maxItems: 10
                description: List of project tech email addresses
                items:
                  type: object
                  properties:
                    email:
                      type: string
                      maxLength: 254
                      description: User email address
                  required:
                  - email
              tenant_id:
                type: string
                description: Tenant ID
              trial_expiration_time:
                type: string
                maxLength: 36
                description: Trial expiration time (ISO 8601)
              vat_id:
                type: string
                maxLength: 64
                description: EU VAT Identification Number
              zip_code:
                type: string
                maxLength: 36
                description: Address zip code
            required:
            - account_id
            - billing_address
            - billing_emails
            - billing_group_id
            - billing_group_name
            - country
            - country_code
            - default_cloud
            - estimated_balance
            - organization_id
            - payment_method
            - project_name
            - vat_id
      required:
      - project_membership
      - project_memberships
      - projects
    ProjectInviteRequestBody:
      type: object
      description: ProjectInviteRequestBody
      properties:
        member_type:
          type: string
          description: Project member type
          default: developer
          enum:
          - admin
          - developer
          - operator
          - organization:app_users:write
          - organization:audit_logs:read
          - organization:billing:read
          - organization:billing:write
          - organization:domains:write
          - organization:groups:write
          - organization:networking:read
          - organization:networking:write
          - organization:projects:write
          - organization:users:write
          - project:audit_logs:read
          - project:integrations:read
          - project:integrations:write
          - project:networking:read
          - project:networking:write
          - project:permissions:read
          - project:services:read
          - project:services:write
          - read_only
          - role:organization:admin
          - role:project:admin
          - role:services:maintenance
          - role:services:recover
          - service:configuration:write
          - service:data:write
          - service:logs:read
          - service:metrics:read
          - service:secrets:read
          - service:users:write
        user_email:
          type: string
          maxLength: 254
          description: User email address
      required:
      - user_email
    VpcPeeringConnectionCreateRequestBody:
      type: object
      description: VpcPeeringConnectionCreateRequestBody
      properties:
        peer_azure_app_id:
          type: string
          maxLength: 1024
          description: Azure app registration id in UUID4 form that is allowed to create a peering to the peer vnet
        peer_azure_tenant_id:
          type: string
          maxLength: 1024
          description: Azure tenant id in UUID4 form
        peer_cloud_account:
          type: string
          maxLength: 1024
          description: AWS account ID, GCP project ID, Azure subscription ID of the peered VPC, or string &quot;upcloud&quot; for UpCloud peering connections
        peer_region:
          type: string
          maxLength: 1024
          description: The peer VPC's region on AWS. May be omitted or set to null if the peer is in the same region as the Aiven project VPC. Omit or set to null on GCP, Azure, or UpCloud.
        peer_resource_group:
          type: string
          maxLength: 1024
          description: Azure resource group name of the peered VPC
        peer_vpc:
          type: string
          maxLength: 1024
          description: AWS VPC ID, GCP VPC network name, Azure Virtual network name of the peered VPC, or UpCloud VPC ID
        user_peer_network_cidrs:
          type: array
          maxItems: 128
          description: List of private IPv4 ranges to route through the peering connection
          items:
            type: string
      required:
      - peer_cloud_account
      - peer_vpc
    ProjectUserUpdateResponse:
      type: object
      description: ProjectUserUpdateResponse
      properties:
        errors:
          type: array
          description: List of errors occurred during request processing
          items:
            type: object
            properties:
              message:
                type: string
                description: Printable error message
              more_info:
                type: string
                description: URL to the documentation of the error
              status:
                type: integer
                description: HTTP error status code
            required:
            - message
            - status
        message:
          type: string
          description: Printable result of the request
    VpcPeeringConnectionWithResourceGroupDeleteResponse:
      type: object
      description: VpcPeeringConnectionWithResourceGroupDeleteResponse
      properties:
        create_time:
          type: string
          maxLength: 36
          description: VPC peering connection creation timestamp
        errors:
          type: array
          description: List of errors occurred during request processing
          items:
            type: object
            properties:
              message:
                type: string
                description: Printable error message
              more_info:
                type: string
                description: URL to the documentation of the error
              status:
                type: integer
                description: HTTP error status code
            required:
            - message
            - status
        message:
          type: string
          description: Printable result of the request
        peer_azure_app_id:
          type: string
          maxLength: 1024
          description: Azure app registration id in UUID4 form that is allowed to create a peering to the peer vnet
        peer_azure_tenant_id:
          type: string
          maxLength: 1024
          description: Azure tenant id in UUID4 form
        peer_cloud_account:
          type: string
          maxLength: 1024
          description: AWS account ID, GCP project ID, Azure subscription ID of the peered VPC, or string &quot;upcloud&quot; for UpCloud peering connections
        peer_region:
          type: string
          maxLength: 1024
          description: The peer VPC's region in AWS clouds. Always null in GCP, Azure, or UpCloud clouds
        peer_resource_group:
          type: string
          maxLength: 1024
          description: Azure resource group name of the peered VPC
        peer_vpc:
          type: string
          maxLength: 1024
          description: AWS VPC ID, GCP VPC network name, Azure Virtual network name of the peered VPC, or UpCloud VPC ID
        peering_connection_id:
          type: string
          minLength: 36
          maxLength: 36
          description: VPC peering connection ID
        state:
          type: string
          description: Project VPC peering connection state
          enum:
          - ACTIVE
          - APPROVED
          - APPROVED_PEER_REQUESTED
          - DELETED
          - DELETED_BY_PEER
          - DELETING
          - ERROR
          - INVALID_SPECIFICATION
          - PENDING_PEER
          - REJECTED_BY_PEER
        state_info:
          type: object
          description: State-specific help or error information
          properties:
            message:
              type: string
              description: Human-readable information message
            type:
              type: string
              description: Type of state information
            warnings:
              type: array
              description: List of warnings if any
              items:
                type: object
                properties:
                  conflicting_aws_account_id:
                    type: string
                    description: AWS account id of conflicting VPC
                  conflicting_aws_vpc_id:
                    type: string
                    description: VPC id which is conflicting with the current one
                  conflicting_aws_vpc_peering_connection_id:
                    type: string
                    description: AWS VPC connection id which is conflicting with current VPC
                  message:
                    type: string
                    description: Warning message to be shown to the user
                  type:
                    type: string
                    description: Type of warning
                    enum:
                    - overlapping-peer-vpc-ip-ranges
                    - upcloud-peering-in-error
                required:
                - message
                - type
          required:
          - message
          - type
        update_time:
          type: string
          maxLength: 36
          description: Timestamp of last change to the VPC peering connection
        user_peer_network_cidrs:
          type: array
          maxItems: 128
          description: List of private IPv4 ranges to route through the peering connection
          items:
            type: string
        vpc_peering_connection_type:
          type: string
          description: Type of network connection from the VPC
          enum:
          - aws-tgw-vpc-attachment
          - aws-vpc-peering-connection
          - azure-vnet-peering
          - do-vpc-peering
          - google-vpc-peering
          - upcloud-vpc-peering
      required:
      - create_time
      - peer_azure_app_id
      - peer_azure_tenant_id
      - peer_cloud_account
      - peer_resource_group
      - peer_vpc
      - state
      - state_info
      - update_time
      - user_peer_network_cidrs
      - vpc_peering_connection_type
    ProjectGetResponse:
      type: object
      description: ProjectGetResponse
      properties:
        errors:
          type: array
          description: List of errors occurred during request processing
          items:
            type: object
            properties:
              message:
                type: string
                description: Printable error message
              more_info:
                type: string
                description: URL to the documentation of the error
              status:
                type: integer
                description: HTTP error status code
            required:
            - message
            - status
        message:
          type: string
          description: Printable result of the request
        project:
          type: object
          description: Project information
          properties:
            account_id:
              type: string
              maxLength: 36
              description: Account ID
            account_name:
              type: string
              maxLength: 83
              description: Account name
            address_lines:
              type: array
              maxItems: 3
              description: Address lines
              items:
                type: string
            available_credits:
              type: string
              description: 'DEPRECATED: Available credits, in USD. Always 0.00, use billing group credits instead'
            billing_address:
              type: string
              maxLength: 1000
              description: 'DEPRECATED: use split address fields like company, address_lines, zip_code, city and state instead'
            billing_currency:
              type: string
              description: Billing currency
              enum:
              - AUD
              - CAD
              - CHF
              - DKK
              - EUR
              - GBP
              - JPY
              - NOK
              - NZD
              - SEK
              - SGD
              - USD
            billing_emails:
              type: array
              maxItems: 10
              description: List of project billing email addresses
              items:
                type: object
                properties:
                  email:
                    type: string
                    maxLength: 254
                    description: User email address
                required:
                - email
            billing_extra_text:
              type: string
              maxLength: 1000
              description: Extra text to be included in all project invoices, e.g. purchase order or cost center number
            billing_group_id:
              type: string
              minLength: 36
              maxLength: 36
              description: Billing group ID
            billing_group_name:
              type: string
              maxLength: 128
              description: Billing group name
            card_info:
              type: object
              description: Credit card assigned to the project
              properties:
                brand:
                  type: string
                  description: Brand
                card_id:
                  type: string
                  maxLength: 64
                  description: Credit card ID
                country:
                  type: string
                  maxLength: 128
                  description: Country
                country_code:
                  type: string
                  maxLength: 2
                  description: Two letter ISO country code
                exp_month:
                  type: integer
                  minimum: 1
                  maximum: 12
                  description: Expiration month
                exp_year:
                  type: integer
                  minimum: 2015
                  maximum: 2100
                  description: Expiration year
                last4:
                  type: string
                  description: Credit card last four digits
                name:
                  type: string
                  maxLength: 256
                  description: Name on the credit card
                user_email:
                  type: string
                  maxLength: 254
                  description: User email address
              required:
              - brand
              - card_id
              - country
              - country_code
              - exp_month
              - exp_year
              - last4
              - name
              - user_email
            city:
              type: string
              maxLength: 50
              description: Address city
            company:
              type: string
              maxLength: 83
              description: Name of a company
            country:
              type: string
              maxLength: 128
              description: Billing country
            country_code:
              type: string
              maxLength: 2
              description: Two letter ISO country code
            default_cloud:
              type: string
              maxLength: 256
              description: Default cloud to use when launching services
            end_of_life_extension:
              type: object
              description: End of life extension information
              properties:
                elasticsearch:
                  type: object
                  description: Service EOL extension
                  properties:
                    eol_date:
                      type: string
                      description: Extended EOL date
                    version:
                      type: string
                      description: Service version
                  required:
                  - eol_date
                  - version
            estimated_balance:
              type: string
              description: Estimated balance, in USD
            estimated_balance_local:
              type: string
              description: Estimated balance, in billing currency
            features:
              type: object
              description: Feature flags
              properties: {}
            organization_id:
              type: string
              maxLength: 36
              description: Organization ID
            payment_method:
              type: string
              description: Payment method
            project_name:
              type: string
              maxLength: 63
              description: Project name
            state:
              type: string
              maxLength: 30
              description: Address state or province
            tags:
              type: object
              description: Set of resource tags
              properties: {}
            tech_emails:
              type: array
              maxItems: 10
              description: List of project tech email addresses
              items:
                type: object
                properties:
                  email:
                    type: string
                    maxLength: 254
                    description: User email address
                required:
                - email
            tenant_id:
              type: string
              description: Tenant ID
            trial_expiration_time:
              type: string
              maxLength: 36
              description: Trial expiration time (ISO 8601)
            vat_id:
              type: string
              maxLength: 64
              description: EU VAT Identification Number
            zip_code:
              type: string
              maxLength: 36
              description: Address zip code
          required:
          - account_id
          - billing_address
          - billing_emails
          - billing_group_id
          - billing_group_name
          - country
          - country_code
          - default_cloud
          - estimated_balance
          - organization_id
          - payment_method
          - project_name
          - vat_id
      required:
      - project
    ProjectAlertsListResponse:
      type: object
      description: ProjectAlertsListResponse
      properties:
        alerts:
          type: array
          description: List of active alerts for the service
          items:
            type: object
            properties:
              create_time:
                type: string
                maxLength: 36
                description: Event creation timestamp (ISO 8601)
              event:
                type: string
                description: Name of the alerting event
              node_name:
                type: string
                description: Name of the service node
              project_name:
                type: string
                maxLength: 63
                description: Project name
              service_name:
                type: string
                minLength: 1
                maxLength: 64
                description: Service name
              service_type:
                type: string
                maxLength: 64
                description: Service type code
              severity:
                type: string
                description: Severity of the event
            required:
            - create_time
            - event
            - project_name
            - severity
        errors:
          type: array
          description: List of errors occurred during request processing
          items:
            type: object
            properties:
              message:
                type: string
                description: Printable error message
              more_info:
                type: string
                description: URL to the documentation of the error
              status:
                type: integer
                description: HTTP error status code
            required:
            - message
            - status
        message:
          type: string
          description: Printable result of the request
      required:
      - alerts
    ProjectUserListResponse:
      type: object
      description: ProjectUserListResponse
      properties:
        errors:
          type: array
          description: List of errors occurred during request processing
          items:
            type: object
            properties:
              message:
                type: string
                description: Printable error message
              more_info:
                type: string
                description: URL to the documentation of the error
              status:
                type: integer
                description: HTTP error status code
            required:
            - message
            - status
        group_users:
          type: array
          description: List of users in groups that have access to the project
          items:
            type: object
            properties:
              member_type:
                type: string
                description: Project member type
                enum:
                - admin
                - developer
                - operator
                - organization:app_users:write
                - organization:audit_logs:read
                - organization:billing:read
                - organization:billing:write
                - organization:domains:write
                - organization:groups:write
                - organization:networking:read
                - organization:networking:write
                - organization:projects:write
                - organization:users:write
                - project:audit_logs:read
                - project:integrations:read
                - project:integrations:write
                - project:networking:read
                - project:networking:write
                - project:permissions:read
                - project:services:read
                - project:services:write
                - read_only
                - role:organization:admin
                - role:project:admin
                - role:services:maintenance
                - role:services:recover
                - service:configuration:write
                - service:data:write
                - service:logs:read
                - service:metrics:read
                - service:secrets:read
                - service:users:write
              real_name:
                type: string
                maxLength: 256
                description: User real name
              user_email:
                type: string
                maxLength: 254
                description: User email address
              user_group_id:
                type: string
                description: User group ID
            required:
            - member_type
            - real_name
            - user_email
            - user_group_id
        invitations:
          type: array
          description: List of pending invitations
          items:
            type: object
            properties:
              invite_time:
                type: string
                maxLength: 36
                description: Timestamp in ISO 8601 format, always in UTC
              invited_user_email:
                type: string
                maxLength: 254
                description: User email address
              inviting_user_email:
                type: string
                maxLength: 254
                description: User email address
              member_type:
                type: string
                description: Project member type
                enum:
                - admin
                - developer
                - operator
                - organization:app_users:write
                - organization:audit_logs:read
                - organization:billing:read
                - organization:billing:write
                - organization:domains:write
                - organization:groups:write
                - organization:networking:read
                - organization:networking:write
                - organization:projects:write
                - organization:users:write
                - project:audit_logs:read
                - project:integrations:read
                - project:integrations:write
                - project:networking:read
                - project:networking:write
                - project:permissions:read
                - project:services:read
                - project:services:write
                - read_only
                - role:organization:admin
                - role:project:admin
                - role:services:maintenance
                - role:services:recover
                - service:configuration:write
                - service:data:write
                - service:logs:read
                - service:metrics:read
                - service:secrets:read
                - service:users:write
            required:
            - invite_time
            - invited_user_email
            - inviting_user_email
            - member_type
        message:
          type: string
          description: Printable result of the request
        users:
          type: array
          description: List of project's users
          items:
            type: object
            properties:
              auth:
                type: array
                description: List of user's required authentication methods
                items:
                  type: string
              billing_contact:
                type: boolean
                description: Set for project's billing contacts
              create_time:
                type: string
                maxLength: 36
                description: Timestamp in ISO 8601 format, always in UTC
              member_type:
                type: string
                description: Project member type
                enum:
                - admin
                - developer
                - operator
                - organization:app_users:write
                - organization:audit_logs:read
                - organization:billing:read
                - organization:billing:write
                - organization:domains:write
                - organization:groups:write
                - organization:networking:read
                - organization:networking:write
                - organization:projects:write
                - organization:users:write
                - project:audit_logs:read
                - project:integrations:read
                - project:integrations:write
                - project:networking:read
                - project:networking:write
                - project:permissions:read
                - project:services:read
                - project:services:write
                - read_only
                - role:organization:admin
                - role:project:admin
                - role:services:maintenance
                - role:services:recover
                - service:configuration:write
                - service:data:write
                - service:logs:read
                - service:metrics:read
                - service:secrets:read
                - service:users:write
              real_name:
                type: string
                maxLength: 256
                description: User real name
              team_id:
                type: string
                maxLength: 32
                description: Team ID
              team_name:
                type: string
                maxLength: 128
                description: Team name
              user_email:
                type: string
                maxLength: 254
                description: User email address
              user_id:
                type: string
                description: User ID
            required:
            - auth
            - billing_contact
            - create_time
            - member_type
            - team_id
            - team_name
            - user_email
            - user_id
      required:
      - group_users
      - invitations
      - users
    ProjectGetEventLogsResponse:
      type: object
      description: ProjectGetEventLogsResponse
      properties:
        errors:
          type: array
          description: List of errors occurred during request processing
          items:
            type: object
            properties:
              message:
                type: string
                description: Printable error message
              more_info:
                type: string
                description: URL to the documentation of the error
              status:
                type: integer
                description: HTTP error status code
            required:
            - message
            - status
        events:
          type: array
          description: List of project event log entries
          items:
            type: object
            properties:
              actor:
                type: string
                description: Initiator of the event
              event_desc:
                type: string
                description: Event description
              event_type:
                type: string
                description: Event type identifier
              id:
                type: string
                maxLength: 40
                description: Event identifier (unique across all projects)
              service_name:
                type: string
                minLength: 1
                maxLength: 64
                description: Service name
              time:
                type: string
                maxLength: 36
                description: Timestamp in ISO 8601 format, always in UTC
            required:
            - actor
            - event_desc
            - event_type
            - id
            - service_name
            - time
        message:
          type: string
          description: Printable result of the request
      required:
      - events
    VpcListResponse:
      type: object
      description: VpcListResponse
      properties:
        errors:
          type: array
          description: List of errors occurred during request processing
          items:
            type: object
            properties:
              message:
                type: string
                description: Printable error message
              more_info:
                type: string
                description: URL to the documentation of the error
              status:
                type: integer
                description: HTTP error status code
            required:
            - message
            - status
        message:
          type: string
          description: Printable result of the request
        vpcs:
          type: array
          description: List of VPCs
          items:
            type: object
            properties:
              cloud_name:
                type: string
                maxLength: 256
                description: Target cloud
              create_time:
                type: string
                maxLength: 36
                description: VPC creation timestamp
              network_cidr:
                type: string
                maxLength: 18
                description: IPv4 network range CIDR
              project_vpc_id:
                type: string
                minLength: 36
                maxLength: 36
                description: Project VPC ID
              state:
                type: string
                description: Project VPC state
                enum:
                - ACTIVE
                - APPROVED
                - DELETED
                - DELETING
              update_time:
                type: string
                maxLength: 36
                description: Timestamp of last change to VPC
            required:
            - cloud_name
            - create_time
            - network_cidr
            - project_vpc_id
            - state
            - update_time
      required:
      - vpcs
    VpcDeleteResponse:
      type: object
      description: VpcDeleteResponse
      properties:
        cloud_name:
          type: string
          maxLength: 256
          description: Target cloud
        create_time:
          type: string
          maxLength: 36
          description: VPC creation timestamp
        errors:
          type: array
          description: List of errors occurred during request processing
          items:
            type: object
            properties:
              message:
                type: string
                description: Printable error message
              more_info:
                type: string
                description: URL to the documentation of the error
              status:
                type: integer
                description: HTTP error status code
            required:
            - message
            - status
        message:
          type: string
          description: Printable result of the request
        network_cidr:
          type: string
          maxLength: 18
          description: IPv4 network range CIDR
        peering_connections:
          type: array
          description: List of peering connections
          items:
            type: object
            properties:
              create_time:
                type: string
                maxLength: 36
                description: VPC peering connection creation timestamp
              peer_azure_app_id:
                type: string
                maxLength: 1024
                description: Azure app registration id in UUID4 form that is allowed to create a peering to the peer vnet
              peer_azure_tenant_id:
                type: string
                maxLength: 1024
                description: Azure tenant id in UUID4 form
              peer_cloud_account:
                type: string
                maxLength: 1024
                description: AWS account ID, GCP project ID, Azure subscription ID of the peered VPC, or string &quot;upcloud&quot; for UpCloud peering connections
              peer_region:
                type: string
                maxLength: 1024
                description: The peer VPC's region in AWS clouds. Always null in GCP, Azure, or UpCloud clouds
              peer_resource_group:
                type: string
                maxLength: 1024
                description: Azure resource group name of the peered VPC
              peer_vpc:
                type: string
                maxLength: 1024
                description: AWS VPC ID, GCP VPC network name, Azure Virtual network name of the peered VPC, or UpCloud VPC ID
              peering_connection_id:
                type: string
                minLength: 36
                maxLength: 36
                description: VPC peering connection ID
              state:
                type: string
                description: Project VPC peering connection state
                enum:
                - ACTIVE
                - APPROVED
                - APPROVED_PEER_REQUESTED
                - DELETED
                - DELETED_BY_PEER
                - DELETING
                - ERROR
                - INVALID_SPECIFICATION
                - PENDING_PEER
                - REJECTED_BY_PEER
              state_info:
                type: object
                description: State-specific help or error information
                properties:
                  message:
                    type: string
                    description: Human-readable information message
                  type:
                    type: string
                    description: Type of state information
                  warnings:
                    type: array
                    description: List of warnings if any
                    items:
                      type: object
                      properties:
                        conflicting_aws_account_id:
                          type: string
                          description: AWS account id of conflicting VPC
                        conflicting_aws_vpc_id:
                          type: string
                          description: VPC id which is conflicting with the current one
                        conflicting_aws_vpc_peering_connection_id:
                          type: string
                          description: AWS VPC connection id which is conflicting with current VPC
                        message:
                          type: string
                          description: Warning message to be shown to the user
                        type:
                          type: string
                          description: Type of warning
                          enum:
                          - overlapping-peer-vpc-ip-ranges
                          - upcloud-peering-in-error
                      required:
                      - message
                      - type
                required:
                - message
                - type
              update_time:
                type: string
                maxLength: 36
                description: Timestamp of last change to the VPC peering connection
              user_peer_network_cidrs:
                type: array
                maxItems: 128
                description: List of private IPv4 ranges to route through the peering connection
                items:
                  type: string
              vpc_peering_connection_type:
                type: string
                description: Type of network connection from the VPC
                enum:
                - aws-tgw-vpc-attachment
                - aws-vpc-peering-connection
                - azure-vnet-peering
                - do-vpc-peering
                - google-vpc-peering
                - upcloud-vpc-peering
            required:
            - create_time
            - peer_azure_app_id
            - peer_azure_tenant_id
            - peer_cloud_account
            - peer_resource_group
            - peer_vpc
            - state
            - state_info
            - update_time
            - user_peer_network_cidrs
            - vpc_peering_connection_type
        pending_build_only_peering_connections:
          type: string
          maxLength: 36
          description: VPC rebuild is scheduled
        project_vpc_id:
          type: string
          minLength: 36
          maxLength: 36
          description: Project VPC ID
        state:
          type: string
          description: Project VPC state
          enum:
          - ACTIVE
          - APPROVED
          - DELETED
          - DELETING
        update_time:
          type: string
          maxLength: 36
          description: Timestamp of last change to VPC
      required:
      - cloud_name
      - create_time
      - network_cidr
      - peering_connections
      - project_vpc_id
      - state
      - update_time
    VpcCreateRequestBody:
      type: object
      description: VpcCreateRequestBody
      properties:
        cloud_name:
          type: string
          maxLength: 256
          description: Target cloud
        network_cidr:
          type: string
          maxLength: 18
          description: IPv4 network range CIDR
        peering_connections:
          type: array
          maxItems: 128
          description: List of peering connection requests for the VPC
          items:
            type: object
            properties:
              peer_azure_app_id:
                type: string
                maxLength: 1024
                description: Azure app registration id in UUID4 form that is allowed to create a peering to the peer vnet
              peer_azure_tenant_id:
                type: string
                maxLength: 1024
                description: Azure tenant id in UUID4 form
              peer_cloud_account:
                type: string
                maxLength: 1024
                description: AWS account ID, GCP project ID, Azure subscription ID of the peered VPC, or string &quot;upcloud&quot; for UpCloud peering connections
              peer_region:
                type: string
                maxLength: 1024
                description: The peer VPC's region on AWS. May be omitted or set to null if the peer is in the same region as the Aiven project VPC. Omit or set to null on GCP, Azure, or UpCloud.
              peer_resource_group:
                type: string
                maxLength: 1024
                description: Azure resource group name of the peered VPC
              peer_vpc:
                type: string
                maxLength: 1024
                description: AWS VPC ID, GCP VPC network name, Azure Virtual network name of the peered VPC, or UpCloud VPC ID
              user_peer_network_cidrs:
                type: array
                maxItems: 128
                description: List of private IPv4 ranges to route through the peering connection
                items:
                  type: string
            required:
            - peer_cloud_account
            - peer_vpc
      required:
      - cloud_name
      - network_cidr
      - peering_connections
    ProjectTagsReplaceRequestBody:
      type: object
      description: ProjectTagsReplaceRequestBody
      properties:
        tags:
          type: object
          description: Set of resource tags
          properties: {}
      required:
      - tags
    ProjectGenerateSbomDownloadUrlResponse:
      type: object
      description: ProjectGenerateSbomDownloadUrlResponse
      properties:
        download_url:
          type: string
          maxLength: 2048
          description: Relative signed URL for report download
        errors:
          type: array
          description: List of errors occurred during request processing
          items:
            type: object
            properties:
              message:
                type: string
                description: Printable error message
              more_info:
                type: string
                description: URL to the documentation of the error
              status:
                type: integer
                description: HTTP error status code
            required:
            - message
            - status
        message:
          type: string
          description: Printable result of the request
      required:
      - download_url
    ProjectUpdateResponse:
      type: object
      description: ProjectUpdateResponse
      properties:
        errors:
          type: array
          description: List of errors occurred during request processing
          items:
            type: object
            properties:
              message:
                type: string
                description: Printable error message
              more_info:
                type: string
                description: URL to the documentation of the error
              status:
                type: integer
                description: HTTP error status code
            required:
            - message
            - status
        message:
          type: string
          description: Printable result of the request
        project:
          type: object
          description: Project information
          properties:
            account_id:
              type: string
              maxLength: 36
              description: Account ID
            account_name:
              type: string
              maxLength: 83
              description: Account name
            address_lines:
              type: array
              maxItems: 3
              description: Address lines
              items:
                type: string
            available_credits:
              type: string
              description: 'DEPRECATED: Available credits, in USD. Always 0.00, use billing group credits instead'
            billing_address:
              type: string
              maxLength: 1000
              description: 'DEPRECATED: use split address fields like company, address_lines, zip_code, city and state instead'
            billing_currency:
              type: string
              description: Billing currency
              enum:
              - AUD
              - CAD
              - CHF
              - DKK
              - EUR
              - GBP
              - JPY
              - NOK
              - NZD
              - SEK
              - SGD
              - USD
            billing_emails:
              type: array
              maxItems: 10
              description: List of project billing email addresses
              items:
                type: object
                properties:
                  email:
                    type: string
                    maxLength: 254
                    description: User email address
                required:
                - email
            billing_extra_text:
              type: string
              maxLength: 1000
              description: Extra text to be included in all project invoices, e.g. purchase order or cost center number
            billing_group_id:
              type: string
              minLength: 36
              maxLength: 36
              description: Billing group ID
            billing_group_name:
              type: string
              maxLength: 128
              description: Billing group name
            card_info:
              type: object
              description: Credit card assigned to the project
              properties:
                brand:
                  type: string
                  description: Brand
                card_id:
                  type: string
                  maxLength: 64
                  description: Credit card ID
                country:
                  type: string
                  maxLength: 128
                  description: Country
                country_code:
                  type: string
                  maxLength: 2
                  description: Two letter ISO country code
                exp_month:
                  type: integer
                  minimum: 1
                  maximum: 12
                  description: Expiration month
                exp_year:
                  type: integer
                  minimum: 2015
                  maximum: 2100
                  description: Expiration year
                last4:
                  type: string
                  description: Credit card last four digits
                name:
                  type: string
                  maxLength: 256
                  description: Name on the credit card
                user_email:
                  type: string
                  maxLength: 254
                  description: User email address
              required:
              - brand
              - card_id
              - country
              - country_code
              - exp_month
              - exp_year
              - last4
              - name
              - user_email
            city:
              type: string
              maxLength: 50
              description: Address city
            company:
              type: string
              maxLength: 83
              description: Name of a company
            country:
              type: string
              maxLength: 128
              description: Billing country
            country_code:
              type: string
              maxLength: 2
              description: Two letter ISO country code
            default_cloud:
              type: string
              maxLength: 256
              description: Default cloud to use when launching services
            end_of_life_extension:
              type: object
              description: End of life extension information
              properties:
                elasticsearch:
                  type: object
                  description: Service EOL extension
                  properties:
                    eol_date:
                      type: string
                      description: Extended EOL date
                    version:
                      type: string
                      description: Service version
                  required:
                  - eol_date
                  - version
            estimated_balance:
              type: string
              description: Estimated balance, in USD
            estimated_balance_local:
              type: string
              description: Estimated balance, in billing currency
            features:
              type: object
              description: Feature flags
              properties: {}
            organization_id:
              type: string
              maxLength: 36
              description: Organization ID
            payment_method:
              type: string
              description: Payment method
            project_name:
              type: string
              maxLength: 63
              description: Project name
            state:
              type: string
              maxLength: 30
              description: Address state or province
            tags:
              type: object
              description: Set of resource tags
              properties: {}
            tech_emails:
              type: array
              maxItems: 10
              description: List of project tech email addresses
              items:
                type: object
                properties:
                  email:
                    type: string
                    maxLength: 254
                    description: User email address
                required:
                - email
            tenant_id:
              type: string
              description: Tenant ID
            trial_expiration_time:
              type: string
              maxLength: 36
              description: Trial expiration time (ISO 8601)
            vat_id:
              type: string
              maxLength: 64
              description: EU VAT Identification Number
            zip_code:
              type: string
              maxLength: 36
              description: Address zip code
          required:
          - account_id
          - billing_address
          - billing_emails
          - billing_group_id
          - billing_group_name
          - country
          - country_code
          - default_cloud
          - estimated_balance
          - organization_id
          - payment_method
          - project_name
          - vat_id
      required:
      - project
    ProjectDeleteResponse:
      type: object
      description: ProjectDeleteResponse
      properties:
        errors:
          type: array
          description: List of errors occurred during request processing
          items:
            type: object
            properties:
              message:
                type: string
                description: Printable error message
              more_info:
                type: string
                description: URL to the documentation of the error
              status:
                type: integer
                description: HTTP error status code
            required:
            - message
            - status
        message:
          type: string
          description: Printable result of the request
    ProjectPrivatelinkAvailabilityListResponse:
      type: object
      description: ProjectPrivatelinkAvailabilityListResponse
      properties:
        errors:
          type: array
          description: List of errors occurred during request processing
          items:
            type: object
            properties:
              message:
                type: string
                description: Printable error message
              more_info:
                type: string
                description: URL to the documentation of the error
              status:
                type: integer
                description: HTTP error status code
            required:
            - message
            - status
        message:
          type: string
          description: Printable result of the request
        privatelink_availability:
          type: array
          description: Privatelink pricing information for supported clouds
          items:
            type: object
            properties:
              cloud_name:
                type: string
                maxLength: 256
                description: Target cloud
              price_usd:
                type: string
                description: Hourly privatelink price in this cloud region
            required:
            - cloud_name
            - price_usd
      required:
      - privatelink_availability
    ProjectTagsListResponse:
      type: object
      description: ProjectTagsListResponse
      properties:
        errors:
          type: array
          description: List of errors occurred during request processing
          items:
            type: object
            properties:
              message:
                type: string
                description: Printable error message
              more_info:
                type: string
                description: URL to the documentation of the error
              status:
                type: integer
                description: HTTP error status code
            required:
            - message
            - status
        message:
          type: string
          description: Printable result of the request
        tags:
          type: object
          description: Set of resource tags
          properties: {}
    ProjectInviteResponse:
      type: object
      description: ProjectInviteResponse
      properties:
        errors:
          type: array
          description: List of errors occurred during request processing
          items:
            type: object
            properties:
              message:
                type: string
                description: Printable error message
              more_info:
                type: string
                description: URL to the documentation of the error
              status:
                type: integer
                description: HTTP error status code
            required:
            - message
            - status
        message:
          type: string
          description: Printable result of the request
    VpcPeeringConnectionWithRegionDeleteResponse:
      type: object
      description: VpcPeeringConnectionWithRegionDeleteResponse
      properties:
        create_time:
          type: string
          maxLength: 36
          description: VPC peering connection creation timestamp
        errors:
          type: array
          description: List of errors occurred during request processing
          items:
            type: object
            properties:
              message:
                type: string
                description: Printable error message
              more_info:
                type: string
                description: URL to the documentation of the error
              status:
                type: integer
                description: HTTP error status code
            required:
            - message
            - status
        message:
          type: string
          description: Printable result of the request
        peer_azure_app_id:
          type: string
          maxLength: 1024
          description: Azure app registration id in UUID4 form that is allowed to create a peering to the peer vnet
        peer_azure_tenant_id:
          type: string
          maxLength: 1024
          description: Azure tenant id in UUID4 form
        peer_cloud_account:
          type: string
          maxLength: 1024
          description: AWS account ID, GCP project ID, Azure subscription ID of the peered VPC, or string &quot;upcloud&quot; for UpCloud peering connections
        peer_region:
          type: string
          maxLength: 1024
          description: The peer VPC's region in AWS clouds. Always null in GCP, Azure, or UpCloud clouds
        peer_resource_group:
          type: string
          maxLength: 1024
          description: Azure resource group name of the peered VPC
        peer_vpc:
          type: string
          maxLength: 1024
          description: AWS VPC ID, GCP VPC network name, Azure Virtual network name of the peered VPC, or UpCloud VPC ID
        peering_connection_id:
          type: string
          minLength: 36
          maxLength: 36
          description: VPC peering connection ID
        state:
          type: string
          description: Project VPC peering connection state
          enum:
          - ACTIVE
          - APPROVED
          - APPROVED_PEER_REQUESTED
          - DELETED
          - DELETED_BY_PEER
          - DELETING
          - ERROR
          - INVALID_SPECIFICATION
          - PENDING_PEER
          - REJECTED_BY_PEER
        state_info:
          type: object
          description: State-specific help or error information
          properties:
            message:
              type: string
              description: Human-readable information message
            type:
              type: string
              description: Type of state information
            warnings:
              type: array
              description: List of warnings if any
              items:
                type: object
                properties:
                  conflicting_aws_account_id:
                    type: string
                    description: AWS account id of conflicting VPC
                  conflicting_aws_vpc_id:
                    type: string
                    description: VPC id which is conflicting with the current one
                  conflicting_aws_vpc_peering_connection_id:
                    type: string
                    description: AWS VPC connection id which is conflicting with current VPC
                  message:
                    type: string
                    description: Warning message to be shown to the user
                  type:
                    type: string
                    description: Type of warning
                    enum:
                    - overlapping-peer-vpc-ip-ranges
                    - upcloud-peering-in-error
                required:
                - message
                - type
          required:
          - message
          - type
        update_time:
          type: string
          maxLength: 36
          description: Timestamp of last change to the VPC peering connection
        user_peer_network_cidrs:
          type: array
          maxItems: 128
          description: List of private IPv4 ranges to route through the peering connection
          items:
            type: string
        vpc_peering_connection_type:
          type: string
          description: Type of network connection from the VPC
          enum:
          - aws-tgw-vpc-attachment
          - aws-vpc-peering-connection
          - azure-vnet-peering
          - do-vpc-peering
          - google-vpc-peering
          - upcloud-vpc-peering
      required:
      - create_time
      - peer_azure_app_id
      - peer_azure_tenant_id
      - peer_cloud_account
      - peer_resource_group
      - peer_vpc
      - state
      - state_info
      - update_time
      - user_peer_network_cidrs
      - vpc_peering_connection_type
    VpcPeeringConnectionUpdateRequestBody:
      type: object
      description: VpcPeeringConnectionUpdateRequestBody
      properties:
        add:
          type: array
          maxItems: 128
          description: CIDRs to add using a specific peering connection
          items:
            type: object
            properties:
              cidr:
                type: string
                maxLength: 18
                description: IPv4 network range CIDR
              peer_cloud_account:
                type: string
                maxLength: 1024
                description: AWS account ID, GCP project ID, Azure subscription ID of the peered VPC, or string &quot;upcloud&quot; for UpCloud peering connections
              peer_resource_group:
                type: string
                maxLength: 1024
                description: Azure resource group name of the peered VPC
              peer_vpc:
                type: string
                maxLength: 1024
                description: AWS VPC ID, GCP VPC network name, Azure Virtual network name of the peered VPC, or UpCloud VPC ID
            required:
            - cidr
            - peer_cloud_account
            - peer_vpc
        delete:
          type: array
          maxItems: 128
          description: Network CIDRs to remove from the VPC's peering connections' user_peer_network_cidrs
          items:
            type: string
    ProjectInviteAcceptResponse:
      type: object
      description: ProjectInviteAcceptResponse
      properties:
        errors:
          type: array
          description: List of errors occurred during request processing
          items:
            type: object
            properties:
              message:
                type: string
                description: Printable error message
              more_info:
                type: string
                description: URL to the documentation of the error
              status:
                type: integer
                description: HTTP error status code
            required:
            - message
            - status
        invite_details:
          type: object
          description: Details of verified invite
          properties:
            user_email:
              type: string
              maxLength: 254
              description: User email address
          required:
          - user_email
        message:
          type: string
          description: Printable result of the request
      required:
      - invite_details
    VpcPeeringConnectionDeleteResponse:
      type: object
      description: VpcPeeringConnectionDeleteResponse
      properties:
        create_time:
          type: string
          maxLength: 36
          description: VPC peering connection creation timestamp
        errors:
          type: array
          description: List of errors occurred during request processing
          items:
            type: object
            properties:
              message:
                type: string
                description: Printable error message
              more_info:
                type: string
                description: URL to the documentation of the error
              status:
                type: integer
                description: HTTP error status code
            required:
            - message
            - status
        message:
          type: string
          description: Printable result of the request
        peer_azure_app_id:
          type: string
          maxLength: 1024
          description: Azure app registration id in UUID4 form that is allowed to create a peering to the peer vnet
        peer_azure_tenant_id:
          type: string
          maxLength: 1024
          description: Azure tenant id in UUID4 form
        peer_cloud_account:
          type: string
          maxLength: 1024
          description: AWS account ID, GCP project ID, Azure subscription ID of the peered VPC, or string &quot;upcloud&quot; for UpCloud peering connections
        peer_region:
          type: string
          maxLength: 1024
          description: The peer VPC's region in AWS clouds. Always null in GCP, Azure, or UpCloud clouds
        peer_resource_group:
          type: string
          maxLength: 1024
          description: Azure resource group name of the peered VPC
        peer_vpc:
          type: string
          maxLength: 1024
          description: AWS VPC ID, GCP VPC network name, Azure Virtual network name of the peered VPC, or UpCloud VPC ID
        peering_connection_id:
          type: string
          minLength: 36
          maxLength: 36
          description: VPC peering connection ID
        state:
          type: string
          description: Project VPC peering connection state
          enum:
          - ACTIVE
          - APPROVED
          - APPROVED_PEER_REQUESTED
          - DELETED
          - DELETED_BY_PEER
          - DELETING
          - ERROR
          - INVALID_SPECIFICATION
          - PENDING_PEER
          - REJECTED_BY_PEER
        state_info:
          type: object
          description: State-specific help or error information
          properties:
            message:
              type: string
              description: Human-readable information message
            type:
              type: string
              description: Type of state information
            warnings:
              type: array
              description: List of warnings if any
              items:
                type: object
                properties:
                  conflicting_aws_account_id:
                    type: string
                    description: AWS account id of conflicting VPC
                  conflicting_aws_vpc_id:
                    type: string
                    description: VPC id which is conflicting with the current one
                  conflicting_aws_vpc_peering_connection_id:
                    type: string
                    description: AWS VPC connection id which is conflicting with current VPC
                  message:
                    type: string
                    description: Warning message to be shown to the user
                  type:
                    type: string
                    description: Type of warning
                    enum:
                    - overlapping-peer-vpc-ip-ranges
                    - upcloud-peering-in-error
                required:
                - message
                - type
          required:
          - message
          - type
        update_time:
          type: string
          maxLength: 36
          description: Timestamp of last change to the VPC peering connection
        user_peer_network_cidrs:
          type: array
          maxItems: 128
          description: List of private IPv4 ranges to route through the peering connection
          items:
            type: string
        vpc_peering_connection_type:
          type: string
          description: Type of network connection from the VPC
          enum:
          - aws-tgw-vpc-attachment
          - aws-vpc-peering-connection
          - azure-vnet-peering
          - do-vpc-peering
          - google-vpc-peering
          - upcloud-vpc-peering
      required:
      - create_time
      - peer_azure_app_id
      - peer_azure_tenant_id
      - peer_cloud_account
      - peer_resource_group
      - peer_vpc
      - state
      - state_info
      - update_time
      - user_peer_network_cidrs
      - vpc_peering_connection_type
    ListProjectVpcPeeringConnectionTypesResponse:
      type: object
      description: ListProjectVpcPeeringConnectionTypesResponse
      properties:
        errors:
          type: array
          description: List of errors occurred during request processing
          items:
            type: object
            properties:
              message:
                type: string
                description: Printable error message
              more_info:
                type: string
                description: URL to the documentation of the error
              status:
                type: integer
                description: HTTP error status code
            required:
            - message
            - status
        message:
          type: string
          description: Printable result of the request
        vpc_peering_connection_types:
          type: array
          description: Supported VPC peering connection types with pricing information for supported clouds
          items:
            type: object
            properties:
              cloud_name:
                type: string
                maxLength: 256
                description: Target cloud
              price_usd:
                type: string
                description: Hourly peering connection price in this cloud region
              vpc_peering_connection_type:
                type: string
                description: Type of network connection from the VPC
                enum:
                - aws-tgw-vpc-attachment
                - aws-vpc-peering-connection
                - azure-vnet-peering
                - do-vpc-peering
                - google-vpc-peering
                - upcloud-vpc-peering
            required:
            - cloud_name
            - price_usd
            - vpc_peering_connection_type
      required:
      - vpc_peering_connection_types
    ProjectUserRemoveResponse:
      type: object
      description: ProjectUserRemoveResponse
      properties:
        errors:
          type: array
          description: List of errors occurred during request processing
          items:
            type: object
            properties:
              message:
                type: string
                description: Printable error message
              more_info:
                type: string
                description: URL to the documentation of the error
              status:
                type: integer
                description: HTTP error status code
            required:
            - message
            - status
        message:
          type: string
          description: Printable result of the request
    VpcCreateResponse:
      type: object
      description: VpcCreateResponse
      properties:
        cloud_name:
          type: string
          maxLength: 256
          description: Target cloud
        create_time:
          type: string
          maxLength: 36
          description: VPC creation timestamp
        errors:
          type: array
          description: List of errors occurred during request processing
          items:
            type: object
            properties:
              message:
                type: string
                description: Printable error message
              more_info:
                type: string
                description: URL to the documentation of the error
              status:
                type: integer
                description: HTTP error status code
            required:
            - message
            - status
        message:
          type: string
          description: Printable result of the request
        network_cidr:
          type: string
          maxLength: 18
          description: IPv4 network range CIDR
        peering_connections:
          type: array
          description: List of peering connections
          items:
            type: object
            properties:
              create_time:
                type: string
                maxLength: 36
                description: VPC peering connection creation timestamp
              peer_azure_app_id:
                type: string
                maxLength: 1024
                description: Azure app registration id in UUID4 form that is allowed to create a peering to the peer vnet
              peer_azure_tenant_id:
                type: string
                maxLength: 1024
                description: Azure tenant id in UUID4 form
              peer_cloud_account:
                type: string
                maxLength: 1024
                description: AWS account ID, GCP project ID, Azure subscription ID of the peered VPC, or string &quot;upcloud&quot; for UpCloud peering connections
              peer_region:
                type: string
                maxLength: 1024
                description: The peer VPC's region in AWS clouds. Always null in GCP, Azure, or UpCloud clouds
              peer_resource_group:
                type: string
                maxLength: 1024
                description: Azure resource group name of the peered VPC
              peer_vpc:
                type: string
                maxLength: 1024
                description: AWS VPC ID, GCP VPC network name, Azure Virtual network name of the peered VPC, or UpCloud VPC ID
              peering_connection_id:
                type: string
                minLength: 36
                maxLength: 36
                description: VPC peering connection ID
              state:
                type: string
                description: Project VPC peering connection state
                enum:
                - ACTIVE
                - APPROVED
                - APPROVED_PEER_REQUESTED
                - DELETED
                - DELETED_BY_PEER
                - DELETING
                - ERROR
                - INVALID_SPECIFICATION
                - PENDING_PEER
                - REJECTED_BY_PEER
              state_info:
                type: object
                description: State-specific help or error information
                properties:
                  message:
                    type: string
                    description: Human-readable information message
                  type:
                    type: string
                    description: Type of state information
                  warnings:
                    type: array
                    description: List of warnings if any
                    items:
                      type: object
                      properties:
                        conflicting_aws_account_id:
                          type: string
                          description: AWS account id of conflicting VPC
                        conflicting_aws_vpc_id:
                          type: string
                          description: VPC id which is conflicting with the current one
                        conflicting_aws_vpc_peering_connection_id:
                          type: string
                          description: AWS VPC connection id which is conflicting with current VPC
                        message:
                          type: string
                          description: Warning message to be shown to the user
                        type:
                          type: string
                          description: Type of warning
                          enum:
                          - overlapping-peer-vpc-ip-ranges
                          - upcloud-peering-in-error
                      required:
                      - message
                      - type
                required:
                - message
                - type
              update_time:
                type: string
                maxLength: 36
                description: Timestamp of last change to the VPC peering connection
              user_peer_network_cidrs:
                type: array
                maxItems: 128
                description: List of private IPv4 ranges to route through the peering connection
                items:
                  type: string
              vpc_peering_connection_type:
                type: string
                description: Type of network connection from the VPC
                enum:
                - aws-tgw-vpc-attachment
                - aws-vpc-peering-connection
                - azure-vnet-peering
                - do-vpc-peering
                - google-vpc-peering
                - upcloud-vpc-peering
            required:
            - create_time
            - peer_azure_app_id
            - peer_azure_tenant_id
            - peer_cloud_account
            - peer_resource_group
            - peer_vpc
            - state
            - state_info
            - update_time
            - user_peer_network_cidrs
            - vpc_peering_connection_type
        pending_build_only_peering_connections:
          type: string
          maxLength: 36
          description: VPC rebuild is scheduled
        project_vpc_id:
          type: string
          minLength: 36
          maxLength: 36
          description: Project VPC ID
        state:
          type: string
          description: Project VPC state
          enum:
          - ACTIVE
          - APPROVED
          - DELETED
          - DELETING
        update_time:
          type: string
          maxLength: 36
          description: Timestamp of last change to VPC
      required:
      - cloud_name
      - create_time
      - network_cidr
      - peering_connections
      - project_vpc_id
      - state
      - update_time
    ProjectUpdateRequestBody:
      type: object
      description: ProjectUpdateRequestBody
      properties:
        account_id:
          type: string
          maxLength: 36
          description: Account ID
        add_account_owners_admin_access:
          type: boolean
          description: '[DEPRECATED] If account_id is set, grant account owner team admin access to this project. This flag is ignored and assumed true.'
        address_lines:
          type: array
          maxItems: 3
          description: '[DEPRECATED] Address lines'
          items:
            type: string
        billing_address:
          type: string
          maxLength: 1000
          description: 'DEPRECATED: use split address fields like company, address_lines, zip_code, city and state instead'
        billing_currency:
          type: string
          description: '[DEPRECATED] Billing currency'
          enum:
          - AUD
          - CAD
          - CHF
          - DKK
          - EUR
          - GBP
          - JPY
          - NOK
          - NZD
          - SEK
          - SGD
          - USD
        billing_emails:
          type: array
          maxItems: 10
          description: '[DEPRECATED] List of project billing email addresses'
          items:
            type: object
            properties:
              email:
                type: string
                maxLength: 254
                description: User email address
            required:
            - email
        billing_extra_text:
          type: string
          maxLength: 1000
          description: '[DEPRECATED] Extra text to be included in all project invoices, e.g. purchase order or cost center number'
        billing_group_id:
          type: string
          minLength: 36
          maxLength: 36
          description: Billing group ID
        card_id:
          type: string
          maxLength: 64
          description: '[DEPRECATED] Credit card ID'
        city:
          type: string
          maxLength: 50
          description: '[DEPRECATED] Address city'
        cloud:
          type: string
          maxLength: 256
          description: Target cloud
        company:
          type: string
          maxLength: 83
          description: '[DEPRECATED] Name of company'
        country_code:
          type: string
          maxLength: 2
          description: '[DEPRECATED] Two letter country code for billing country'
        project_name:
          type: string
          maxLength: 63
          description: Project name
        state:
          type: string
          maxLength: 30
          description: '[DEPRECATED] Address state'
        tags:
          type: object
          description: Set of resource tags
          properties: {}
        tech_emails:
          type: array
          maxItems: 10
          description: List of project tech email addresses
          items:
            type: object
            properties:
              email:
                type: string
                maxLength: 254
                description: User email address
            required:
            - email
        vat_id:
          type: string
          maxLength: 64
          description: '[DEPRECATED] EU VAT Identification Number'
        zip_code:
          type: string
          maxLength: 36
          description: '[DEPRECATED] Address zip code'
    ProjectCreateResponse:
      type: object
      description: ProjectCreateResponse
      properties:
        errors:
          type: array
          description: List of errors occurred during request processing
          items:
            type: object
            properties:
              message:
                type: string
                description: Printable error message
              more_info:
                type: string
                description: URL to the documentation of the error
              status:
                type: integer
                description: HTTP error status code
            required:
            - message
            - status
        message:
          type: string
          description: Printable result of the request
        project:
          type: object
          description: Project information
          properties:
            account_id:
              type: string
              maxLength: 36
              description: Account ID
            account_name:
              type: string
              maxLength: 83
              description: Account name
            address_lines:
              type: array
              maxItems: 3
              description: Address lines
              items:
                type: string
            available_credits:
              type: string
              description: 'DEPRECATED: Available credits, in USD. Always 0.00, use billing group credits instead'
            billing_address:
              type: string
              maxLength: 1000
              description: 'DEPRECATED: use split address fields like company, address_lines, zip_code, city and state instead'
            billing_currency:
              type: string
              description: Billing currency
              enum:
              - AUD
              - CAD
              - CHF
              - DKK
              - EUR
              - GBP
              - JPY
              - NOK
              - NZD
              - SEK
              - SGD
              - USD
            billing_emails:
              type: array
              maxItems: 10
              description: List of project billing email addresses
              items:
                type: object
                properties:
                  email:
                    type: string
                    maxLength: 254
                    description: User email address
                required:
                - email
            billing_extra_text:
              type: string
              maxLength: 1000
              description: Extra text to be included in all project invoices, e.g. purchase order or cost center number
            billing_group_id:
              type: string
              minLength: 36
              maxLength: 36
              description: Billing group ID
            billing_group_name:
              type: string
              maxLength: 128
              description: Billing group name
            card_info:
              type: object
              description: Credit card assigned to the project
              properties:
                brand:
                  type: string
                  description: Brand
                card_id:
                  type: string
                  maxLength: 64
                  description: Credit card ID
                country:
                  type: string
                  maxLength: 128
                  description: Country
                country_code:
                  type: string
                  maxLength: 2
                  description: Two letter ISO country code
                exp_month:
                  type: integer
                  minimum: 1
                  maximum: 12
                  description: Expiration month
                exp_year:
                  type: integer
                  minimum: 2015
                  maximum: 2100
                  description: Expiration year
                last4:
                  type: string
                  description: Credit card last four digits
                name:
                  type: string
                  maxLength: 256
                  description: Name on the credit card
                user_email:
                  type: string
                  maxLength: 254
                  description: User email address
              required:
              - brand
              - card_id
              - country
              - country_code
              - exp_month
              - exp_year
              - last4
              - name
              - user_email
            city:
              type: string
              maxLength: 50
              description: Address city
            company:
              type: string
              maxLength: 83
              description: Name of a company
            country:
              type: string
              maxLength: 128
              description: Billing country
            country_code:
              type: string
              maxLength: 2
              description: Two letter ISO country code
            default_cloud:
              type: string
              maxLength: 256
              description: Default cloud to use when launching services
            end_of_life_extension:
              type: object
              description: End of life extension information
              properties:
                elasticsearch:
                  type: object
                  description: Service EOL extension
                  properties:
                    eol_date:
                      type: string
                      description: Extended EOL date
                    version:
                      type: string
                      description: Service version
                  required:
                  - eol_date
                  - version
            estimated_balance:
              type: string
              description: Estimated balance, in USD
            estimated_balance_local:
              type: string
              description: Estimated balance, in billing currency
            features:
              type: object
              description: Feature flags
              properties: {}
            organization_id:
              type: string
              maxLength: 36
              description: Organization ID
            payment_method:
              type: string
              description: Payment method
            project_name:
              type: string
              maxLength: 63
              description: Project name
            state:
              type: string
              maxLength: 30
              description: Address state or province
            tags:
              type: object
              description: Set of resource tags
              properties: {}
            tech_emails:
              type: array
              maxItems: 10
              description: List of project tech email addresses
              items:
                type: object
                properties:
                  email:
                    type: string
                    maxLength: 254
                    description: User email address
                required:
                - email
            tenant_id:
              type: string
              description: Tenant ID
            trial_expiration_time:
              type: string
              maxLength: 36
              description: Trial expiration time (ISO 8601)
            vat_id:
              type: string
              maxLength: 64
              description: EU VAT Identification Number
            zip_code:
              type: string
              maxLength: 36
              description: Address zip code
          required:
          - account_id
          - billing_address
          - billing_emails
          - billing_group_id
          - billing_group_name
          - country
          - country_code
          - default_cloud
          - estimated_balance
          - organization_id
          - payment_method
          - project_name
          - vat_id
      required:
      - project
    ProjectServiceTypesGetResponse:
      type: object
      description: ProjectServiceTypesGetResponse
      properties:
        default_version:
          type: string
          description: Default version of the service if no explicit version is defined
        description:
          type: string
          description: Single line description of the service
        errors:
          type: array
          description: List of errors occurred during request processing
          items:
            type: object
            properties:
              message:
                type: string
                description: Printable error message
              more_info:
                type: string
                description: URL to the documentation of the error
              status:
                type: integer
                description: HTTP error status code
            required:
            - message
            - status
        latest_available_version:
          type: string
          description: Latest available version of the service
        message:
          type: string
          description: Printable result of the request
        user_config_schema:
          type: object
          description: JSON-Schema for the 'user_config' properties
          properties: {}
      required:
      - description
      - user_config_schema
    ProjectTagsUpdateRequestBody:
      type: object
      description: ProjectTagsUpdateRequestBody
      properties:
        tags:
          type: object
          description: Set of resource tags
          properties: {}
      required:
      - tags
    VpcPeeringConnectionsRefreshResponse:
      type: object
      description: VpcPeeringConnectionsRefreshResponse
      properties:
        cloud_name:
          type: string
          maxLength: 256
          description: Target cloud
        create_time:
          type: string
          maxLength: 36
          description: VPC creation timestamp
        errors:
          type: array
          description: List of errors occurred during request processing
          items:
            type: object
            properties:
              message:
                type: string
                description: Printable error message
              more_info:
                type: string
                description: URL to the documentation of the error
              status:
                type: integer
                description: HTTP error status code
            required:
            - message
            - status
        message:
          type: string
          description: Printable result of the request
        network_cidr:
          type: string
          maxLength: 18
          description: IPv4 network range CIDR
        peering_connections:
          type: array
          description: List of peering connections
          items:
            type: object
            properties:
              create_time:
                type: string
                maxLength: 36
                description: VPC peering connection creation timestamp
              peer_azure_app_id:
                type: string
                maxLength: 1024
                description: Azure app registration id in UUID4 form that is allowed to create a peering to the peer vnet
              peer_azure_tenant_id:
                type: string
                maxLength: 1024
                description: Azure tenant id in UUID4 form
              peer_cloud_account:
                type: string
                maxLength: 1024
                description: AWS account ID, GCP project ID, Azure subscription ID of the peered VPC, or string &quot;upcloud&quot; for UpCloud peering connections
              peer_region:
                type: string
                maxLength: 1024
                description: The peer VPC's region in AWS clouds. Always null in GCP, Azure, or UpCloud clouds
              peer_resource_group:
                type: string
                maxLength: 1024
                description: Azure resource group name of the peered VPC
              peer_vpc:
                type: string
                maxLength: 1024
                description: AWS VPC ID, GCP VPC network name, Azure Virtual network name of the peered VPC, or UpCloud VPC ID
              peering_connection_id:
                type: string
                minLength: 36
                maxLength: 36
                description: VPC peering connection ID
              state:
                type: string
                description: Project VPC peering connection state
                enum:
                - ACTIVE
                - APPROVED
                - APPROVED_PEER_REQUESTED
                - DELETED
                - DELETED_BY_PEER
                - DELETING
                - ERROR
                - INVALID_SPECIFICATION
                - PENDING_PEER
                - REJECTED_BY_PEER
              state_info:
                type: object
                description: State-specific help or error information
                properties:
                  message:
                    type: string
                    description: Human-readable information message
                  type:
                    type: string
                    description: Type of state information
                  warnings:
                    type: array
                    description: List of warnings if any
                    items:
                      type: object
                      properties:
                        conflicting_aws_account_id:
                          type: string
                          description: AWS account id of conflicting VPC
                        conflicting_aws_vpc_id:
                          type: string
                          description: VPC id which is conflicting with the current one
                        conflicting_aws_vpc_peering_connection_id:
                          type: string
                          description: AWS VPC connection id which is conflicting with current VPC
                        message:
                          type: string
                          description: Warning message to be shown to the user
                        type:
                          type: string
                          description: Type of warning
                          enum:
                          - overlapping-peer-vpc-ip-ranges
                          - upcloud-peering-in-error
                      required:
                      - message
                      - type
                required:
                - message
                - type
              update_time:
                type: string
                maxLength: 36
                description: Timestamp of last change to the VPC peering connection
              user_peer_network_cidrs:
                type: array
                maxItems: 128
                description: List of private IPv4 ranges to route through the peering connection
                items:
                  type: string
              vpc_peering_connection_type:
                type: string
                description: Type of network connection from the VPC
                enum:
                - aws-tgw-vpc-attachment
                - aws-vpc-peering-connection
                - azure-vnet-peering
                - do-vpc-peering
                - google-vpc-peering
                - upcloud-vpc-peering
            required:
            - create_time
            - peer_azure_app_id
            - peer_azure_tenant_id
            - peer_cloud_account
            - peer_resource_group
            - peer_vpc
            - state
            - state_info
            - update_time
            - user_peer_network_cidrs
            - vpc_peering_connection_type
        pending_build_only_peering_connections:
          type: string
          maxLength: 36
          description: VPC rebuild is scheduled
        project_vpc_id:
          type: string
          minLength: 36
          maxLength: 36
          description: Project VPC ID
        state:
          type: string
          description: Project VPC state
          enum:
          - ACTIVE
          - APPROVED
          - DELETED
          - DELETING
        update_time:
          type: string
          maxLength: 36
          description: Timestamp of last change to VPC
      required:
      - cloud_name
      - create_time
      - network_cidr
      - peering_connections
      - project_vpc_id
      - state
      - update_time
    ProjectUserUpdateRequestBody:
      type: object
      description: ProjectUserUpdateRequestBody
      properties:
        member_type:
          type: string
          description: Project member type
          enum:
          - admin
          - developer
          - operator
          - organization:app_users:write
          - organization:audit_logs:read
          - organization:billing:read
          - organization:billing:write
          - organization:domains:write
          - organization:groups:write
          - organization:networking:read
          - organization:networking:write
          - organization:projects:write
          - organization:users:write
          - project:audit_logs:read
          - project:integrations:read
          - project:integrations:write
          - project:networking:read
          - project:networking:write
          - project:permissions:read
          - project:services:read
          - project:services:write
          - read_only
          - role:organization:admin
          - role:project:admin
          - role:services:maintenance
          - role:services:recover
          - service:configuration:write
          - service:data:write
          - service:logs:read
          - service:metrics:read
          - service:secrets:read
          - service:users:write
      required:
      - member_type
    ProjectServicePlanSpecsGetResponse:
      type: object
      description: ProjectServicePlanSpecsGetResponse
      properties:
        backup_config:
          type: object
          description: Backup configuration for this service plan
          properties:
            frequent_interval_minutes:
              type: integer
              minimum: 0
              description: Interval of taking a frequent backup in service types supporting different backup schedules
            frequent_oldest_age_minutes:
              type: integer
              minimum: 0
              description: Maximum age of the oldest frequent backup in service types supporting different backup schedules
            infrequent_interval_minutes:
              type: integer
              minimum: 0
              description: Interval of taking an infrequent backup in service types supporting different backup schedules
            infrequent_oldest_age_minutes:
              type: integer
              minimum: 0
              description: Maximum age of the oldest infrequent backup in service types supporting different backup schedules
            interval:
              type: integer
              minimum: 0
              description: The interval, in hours, at which backups are generated. For some services, like PostgreSQL, this is the interval at which full snapshots are taken and continuous incremental backup stream is maintained in addition to that.
            max_count:
              type: integer
              minimum: 0
              description: Maximum number of backups to keep. Zero when no backups are created.
            recovery_mode:
              type: string
              description: Mechanism how backups can be restored. 'basic' means a backup is restored as is so that the system is restored to the state it was when the backup was generated. 'pitr' means point-in-time-recovery, which allows restoring the system to any state since the first available full snapshot.
              enum:
              - basic
              - pitr
          required:
          - interval
          - max_count
          - recovery_mode
        disk_space_cap_mb:
          type: integer
          minimum: 0
          description: Maximum amount of disk space possible for the plan in the given region
        disk_space_mb:
          type: integer
          minimum: 0
          description: Combined amount of service disk space of all service nodes in megabytes
        disk_space_step_mb:
          type: integer
          minimum: 1024
          description: Disk space change step size
        errors:
          type: array
          description: List of errors occurred during request processing
          items:
            type: object
            properties:
              message:
                type: string
                description: Printable error message
              more_info:
                type: string
                description: URL to the documentation of the error
              status:
                type: integer
                description: HTTP error status code
            required:
            - message
            - status
        max_memory_percent:
          type: integer
          minimum: 0
          maximum: 100
          description: Maximum amount of system memory as a percentage (0-100) the service can actually use after taking into account management overhead. This is relevant for memory bound services for which some service management operations require allocating proportional amount of memory on top the basic load.
        message:
          type: string
          description: Printable result of the request
        node_count:
          type: integer
          minimum: 1
          maximum: 100
          description: Number of nodes in this service plan
        primary_count:
          type: integer
          minimum: 1
          description: Number of primary nodes in this Valkey cluster service plan
        service_plan:
          type: string
          maxLength: 128
          description: Subscription plan
        service_type:
          type: string
          maxLength: 64
          description: Service type code
        shard_count:
          type: integer
          minimum: 1
          description: Number of shards in this service plan
      required:
      - backup_config
      - disk_space_mb
      - node_count
      - service_plan
      - service_type
    ProjectServicePlanListResponse:
      type: object
      description: ProjectServicePlanListResponse
      properties:
        errors:
          type: array
          description: List of errors occurred during request processing
          items:
            type: object
            properties:
              message:
                type: string
                description: Printable error message
              more_info:
                type: string
                description: URL to the documentation of the error
              status:
                type: integer
                description: HTTP error status code
            required:
            - message
            - status
        message:
          type: string
          description: Printable result of the request
        service_plans:
          type: array
          description: List of plans available for this type of service
          items:
            type: object
            properties:
              backup_config:
                type: object
                description: Backup configuration for this service plan
                properties:
                  frequent_interval_minutes:
                    type: integer
                    minimum: 0
                    description: Interval of taking a frequent backup in service types supporting different backup schedules
                  frequent_oldest_age_minutes:
                    type: integer
                    minimum: 0
                    description: Maximum age of the oldest frequent backup in service types supporting different backup schedules
                  infrequent_interval_minutes:
                    type: integer
                    minimum: 0
                    description: Interval of taking an infrequent backup in service types supporting different backup schedules
                  infrequent_oldest_age_minutes:
                    type: integer
                    minimum: 0
                    description: Maximum age of the oldest infrequent backup in service types supporting different backup schedules
                  interval:
                    type: integer
                    minimum: 0
                    description: The interval, in hours, at which backups are generated. For some services, like PostgreSQL, this is the interval at which full snapshots are taken and continuous incremental backup stream is maintained in addition to that.
                  max_count:
                    type: integer
                    minimum: 0
                    description: Maximum number of backups to keep. Zero when no backups are created.
                  recovery_mode:
                    type: string
                    description: Mechanism how backups can be restored. 'basic' means a backup is restored as is so that the system is restored to the state it was when the backup was generated. 'pitr' means point-in-time-recovery, which allows restoring the system to any state since the first available full snapshot.
                    enum:
                    - basic
                    - pitr
                required:
                - interval
                - max_count
                - recovery_mode
              is_cluster_plan:
                type: boolean
                description: True when the plan is a cluster plan with dedicated node groups
              max_memory_percent:
                type: integer
                minimum: 0
                maximum: 100
                description: Maximum amount of system memory as a percentage (0-100) the service can actually use after taking into account management overhead. This is relevant for memory bound services for which some service management operations require allocating proportional amount of memory on top the basic load.
              node_count:
                type: integer
                minimum: 1
                maximum: 100
                description: Number of nodes in this service plan
              primary_count:
                type: integer
                minimum: 1
                description: Number of primary nodes in this Valkey cluster service plan
              regions:
                type: object
                description: Service plan hourly price per cloud region
                properties: {}
              service_plan:
                type: string
                maxLength: 128
                description: Subscription plan
              service_type:
                type: string
                maxLength: 64
                description: Service type code
              shard_count:
                type: integer
                minimum: 1
                description: Number of shards in this service plan
            required:
            - backup_config
            - service_plan
            - service_type
      required:
      - service_plans
    ProjectServicePlanPriceGetResponse:
      type: object
      description: ProjectServicePlanPriceGetResponse
      properties:
        base_price_usd:
          type: string
          description: Hourly service price in this region
        cloud_name:
          type: string
          maxLength: 256
          description: Target cloud
        errors:
          type: array
          description: List of errors occurred during request processing
          items:
            type: object
            properties:
              message:
                type: string
                description: Printable error message
              more_info:
                type: string
                description: URL to the documentation of the error
              status:
                type: integer
                description: HTTP error status code
            required:
            - message
            - status
        extra_disk_price_per_gb_usd:
          type: string
          description: Hourly additional disk space price per GiB in this region
        message:
          type: string
          description: Printable result of the request
        object_storage_gb_price_usd:
          type: string
          description: Hourly additional disk space price per GiB in this region
        service_plan:
          type: string
          maxLength: 128
          description: Subscription plan
        service_type:
          type: string
          maxLength: 64
          description: Service type code
      required:
      - base_price_usd
      - cloud_name
      - service_plan
      - service_type
    ProjectServiceTypesListResponse:
      type: object
      description: ProjectServiceTypesListResponse
      properties:
        clickhouse:
          type: object
          description: Service type information
          properties:
            default_version:
              type: string
              description: Default version of the service if no explicit version is defined
            description:
              type: string
              description: Single line description of the service
            latest_available_version:
              type: string
              description: Latest available version of the service
            user_config_schema:
              type: object
              description: JSON-Schema for the 'user_config' properties
              properties: {}
          required:
          - description
          - user_config_schema
        dragonfly:
          type: object
          description: Service type information
          properties:
            default_version:
              type: string
              description: Default version of the service if no explicit version is defined
            description:
              type: string
              description: Single line description of the service
            latest_available_version:
              type: string
              description: Latest available version of the service
            user_config_schema:
              type: object
              description: JSON-Schema for the 'user_config' properties
              properties: {}
          required:
          - description
          - user_config_schema
        elasticsearch:
          type: object
          description: Service type information
          properties:
            default_version:
              type: string
              description: Default version of the service if no explicit version is defined
            description:
              type: string
              description: Single line description of the service
            latest_available_version:
              type: string
              description: Latest available version of the service
            user_config_schema:
              type: object
              description: JSON-Schema for the 'user_config' properties
              properties: {}
          required:
          - description
          - user_config_schema
        errors:
          type: array
          description: List of errors occurred during request processing
          items:
            type: object
            properties:
              message:
                type: string
                description: Printable error message
              more_info:
                type: string
                description: URL to the documentation of the error
              status:
                type: integer
                description: HTTP error status code
            required:
            - message
            - status
        flink:
          type: object
          description: Service type information
          properties:
            default_version:
              type: string
              description: Default version of the service if no explicit version is defined
            description:
              type: string
              description: Single line description of the service
            latest_available_version:
              type: string
              description: Latest available version of the service
            user_config_schema:
              type: object
              description: JSON-Schema for the 'user_config' properties
              properties: {}
          required:
          - description
          - user_config_schema
        grafana:
          type: object
          description: Service type information
          properties:
            default_version:
              type: string
              description: Default version of the service if no explicit version is defined
            description:
              type: string
              description: Single line description of the service
            latest_available_version:
              type: string
              description: Latest available version of the service
            user_config_schema:
              type: object
              description: JSON-Schema for the 'user_config' properties
              properties: {}
          required:
          - description
          - user_config_schema
        kafka:
          type: object
          description: Service type information
          properties:
            default_version:
              type: string
              description: Default version of the service if no explicit version is defined
            description:
              type: string
              description: Single line description of the service
            latest_available_version:
              type: string
              description: Latest available version of the service
            user_config_schema:
              type: object
              description: JSON-Schema for the 'user_config' properties
              properties: {}
          required:
          - description
          - user_config_schema
        kafka_connect:
          type: object
          description: Service type information
          properties:
            default_version:
              type: string
              description: Default version of the service if no explicit version is defined
            description:
              type: string
              description: Single line description of the service
            latest_available_version:
              type: string
              description: Latest available version of the service
            user_config_schema:
              type: object
              description: JSON-Schema for the 'user_config' properties
              properties: {}
          required:
          - description
          - user_config_schema
        kafka_mirrormaker:
          type: object
          description: Service type information
          properties:
            default_version:
              type: string
              description: Default version of the service if no explicit version is defined
            description:
              type: string
              description: Single line description of the service
            latest_available_version:
              type: string
              description: Latest available version of the service
            user_config_schema:
              type: object
              description: JSON-Schema for the 'user_config' properties
              properties: {}
          required:
          - description
          - user_config_schema
        message:
          type: string
          description: Printable result of the request
        mysql:
          type: object
          description: Service type information
          properties:
            default_version:
              type: string
              description: Default version of the service if no explicit version is defined
            description:
              type: string
              description: Single line description of the service
            latest_available_version:
              type: string
              description: Latest available version of the service
            user_config_schema:
              type: object
              description: JSON-Schema for the 'user_config' properties
              properties: {}
          required:
          - description
          - user_config_schema
        opensearch:
          type: object
          description: Service type information
          properties:
            default_version:
              type: string
              description: Default version of the service if no explicit version is defined
            description:
              type: string
              description: Single line description of the service
            latest_available_version:
              type: string
              description: Latest available version of the service
            user_config_schema:
              type: object
              description: JSON-Schema for the 'user_config' properties
              properties: {}
          required:
          - description
          - user_config_schema
        pg:
          type: object
          description: Service type information
          properties:
            default_version:
              type: string
              description: Default version of the service if no explicit version is defined
            description:
              type: string
              description: Single line description of the service
            latest_available_version:
              type: string
              description: Latest available version of the service
            user_config_schema:
              type: object
              description: JSON-Schema for the 'user_config' properties
              properties: {}
          required:
          - description
          - user_config_schema
        redis:
          type: object
          description: Service type information
          properties:
            default_version:
              type: string
              description: Default version of the service if no explicit version is defined
            description:
              type: string
              description: Single line description of the service
            latest_available_version:
              type: string
              description: Latest available version of the service
            user_config_schema:
              type: object
              description: JSON-Schema for the 'user_config' properties
              properties: {}
          required:
          - description
          - user_config_schema
        thanos:
          type: object
          description: Service type information
          properties:
            default_version:
              type: string
              description: Default version of the service if no explicit version is defined
            description:
              type: string
              description: Single line description of the service
            latest_available_version:
              type: string
              description: Latest available version of the service
            user_config_schema:
              type: object
              description: JSON-Schema for the 'user_config' properties
              properties: {}
          required:
          - description
          - user_config_schema
        valkey:
          type: object
          description: Service type information
          properties:
            default_version:
              type: string
              description: Default version of the service if no explicit version is defined
            description:
              type: string
              description: Single line description of the service
            latest_available_version:
              type: string
              description: Latest available version of the service
            user_config_schema:
              type: object
              description: JSON-Schema for the 'user_config' properties
              properties: {}
          required:
          - description
          - user_config_schema
    ProjectInviteDeleteResponse:
      type: object
      description: ProjectInviteDeleteResponse
      properties:
        errors:
          type: array
          description: List of errors occurred during request processing
          items:
            type: object
            properties:
              message:
                type: string
                description: Printable error message
              more_info:
                type: string
                description: URL to the documentation of the error
              status:
                type: integer
                description: HTTP error status code
            required:
            - message
            - status
        message:
          type: string
          description: Printable result of the request
    VpcPeeringConnectionCreateResponse:
      type: object
      description: VpcPeeringConnectionCreateResponse
      properties:
        create_time:
          type: string
          maxLength: 36
          description: VPC peering connection creation timestamp
        errors:
          type: array
          description: List of errors occurred during request processing
          items:
            type: object
            properties:
              message:
                type: string
                description: Printable error message
              more_info:
                type: string
                description: URL to the documentation of the error
              status:
                type: integer
                description: HTTP error status code
            required:
            - message
            - status
        message:
          type: string
          description: Printable result of the request
        peer_azure_app_id:
          type: string
          maxLength: 1024
          description: Azure app registration id in UUID4 form that is allowed to create a peering to the peer vnet
        peer_azure_tenant_id:
          type: string
          maxLength: 1024
          description: Azure tenant id in UUID4 form
        peer_cloud_account:
          type: string
          maxLength: 1024
          description: AWS account ID, GCP project ID, Azure subscription ID of the peered VPC, or string &quot;upcloud&quot; for UpCloud peering connections
        peer_region:
          type: string
          maxLength: 1024
          description: The peer VPC's region in AWS clouds. Always null in GCP, Azure, or UpCloud clouds
        peer_resource_group:
          type: string
          maxLength: 1024
          description: Azure resource group name of the peered VPC
        peer_vpc:
          type: string
          maxLength: 1024
          description: AWS VPC ID, GCP VPC network name, Azure Virtual network name of the peered VPC, or UpCloud VPC ID
        peering_connection_id:
          type: string
          minLength: 36
          maxLength: 36
          description: VPC peering connection ID
        state:
          type: string
          description: Project VPC peering connection state
          enum:
          - ACTIVE
          - APPROVED
          - APPROVED_PEER_REQUESTED
          - DELETED
          - DELETED_BY_PEER
          - DELETING
          - ERROR
          - INVALID_SPECIFICATION
          - PENDING_PEER
          - REJECTED_BY_PEER
        state_info:
          type: object
          description: State-specific help or error information
          properties:
            message:
              type: string
              description: Human-readable information message
            type:
              type: string
              description: Type of state information
            warnings:
              type: array
              description: List of warnings if any
              items:
                type: object
                properties:
                  conflicting_aws_account_id:
                    type: string
                    description: AWS account id of conflicting VPC
                  conflicting_aws_vpc_id:
                    type: string
                    description: VPC id which is conflicting with the current one
                  conflicting_aws_vpc_peering_connection_id:
                    type: string
                    description: AWS VPC connection id which is conflicting with current VPC
                  message:
                    type: string
                    description: Warning message to be shown to the user
                  type:
                    type: string
                    description: Type of warning
                    enum:
                    - overlapping-peer-vpc-ip-ranges
                    - upcloud-peering-in-error
                required:
                - message
                - type
          required:
          - message
          - type
        update_time:
          type: string
          maxLength: 36
          description: Timestamp of last change to the VPC peering connection
        user_peer_network_cidrs:
          type: array
          maxItems: 128
          description: List of private IPv4 ranges to route through the peering connection
          items:
            type: string
        vpc_peering_connection_type:
          type: string
          description: Type of network connection from the VPC
          enum:
          - aws-tgw-vpc-attachment
          - aws-vpc-peering-connection
          - azure-vnet-peering
          - do-vpc-peering
          - google-vpc-peering
          - upcloud-vpc-peering
      required:
      - create_time
      - peer_azure_app_id
      - peer_azure_tenant_id
      - peer_cloud_account
      - peer_resource_group
      - peer_vpc
      - state
      - state_info
      - update_time
      - user_peer_network_cidrs
      - vpc_peering_connection_type
  parameters:
    invited_email:
      in: path
      name: invited_email
      description: Email address of user to be invited
      schema:
        type: string
      required: true
    peer_cloud_account:
      in: path
      name: peer_cloud_account
      description: AWS account ID, Google project name, Azure subscription ID, or string &quot;upcloud&quot; for UpCloud peering connections
      schema:
        type: string
      required: true
    cloud:
      in: path
      name: cloud
      description: Cloud
      schema:
        type: string
      required: true
    peer_vpc:
      in: path
      name: peer_vpc
      description: AWS VPC-ID, Google network name, Azure VNet name, or UpCloud VPC ID
      schema:
        type: string
      required: true
    download_cookie:
      in: path
      name: download_cookie
      description: Authentication cookie for file download
      schema:
        type: string
      required: true
    project_vpc_id:
      in: path
      name: project_vpc_id
      description: Project VPC ID
      schema:
        type: string
      required: true
    service_plan:
      in: path
      name: service_plan
      description: Service plan
      schema:
        type: string
      required: true
    peer_resource_group:
      in: path
      name: peer_resource_group
      description: Azure resource group
      schema:
        type: string
      required: true
    peer_region:
      in: path
      name: peer_region
      description: AWS region
      schema:
        type: string
      required: true
    file_format:
      in: path
      name: file_format
      description: of the SBOM report
      schema:
        type: string
      required: true
    service_type:
      in: path
      name: service_type
      description: Service type
      schema:
        type: string
      required: true
    project:
      in: path
      name: project
      description: Project name
      schema:
        type: string
      required: true
    invite_verification_code:
      in: path
      name: invite_verification_code
      description: Verification code received via email
      schema:
        type: string
      required: true
    user_email:
      in: path
      name: user_email
      description: Email address
      schema:
        type: string
      required: true
  securitySchemes:
    tokenAuth:
      description: 'Header should be of the format `authorization: aivenv1 <TOKEN>`. Tokens can be obtained from [your Aiven profile page](https://console.aiven.io/profile/auth)'
      scheme: bearer
      type: http
    oauth2:
      type: oauth2
      description: OAuth2 security scheme
      flows:
        authorizationCode:
          authorizationUrl: https://console.aiven.io/oauth/authorize
          tokenUrl: https://api.aiven.io/v1/oauth2/token
          scopes:
            all: Provide full access to the API
            accounts: Allow enumerating and reading accounts configuration
            accounts:read: Allow modifying account configuration
            accounts:write: Provides full access to authentication related API
            authentication: Provides full access to authentication related API
            authentication:read: Allow reading authentication related configuration on resources (user profile, accounts)
            authentication:write: Allow modifying authentication related configurations on resources (user profile, accounts)
            billing: Provide full access to billing APIs
            billing:read: Allow reading billing information and configuration
            billing:write: Allow writing billing configuration
            payments: Provide full access to payment method APIs
            payments:read: Allow reading the payment method configurations
            payments:write: Allows writing payment method configuration
            privatelink: Provide full access to private link APIs
            privatelink:read: Allow enumerating and reading private link items and configurations
            privatelink:write: Allow writing (creating, modifying, deleting) private link items
            projects: Provide full access to projects APIs
            projects:read: Allow enumerating projects and reading their configuration
            projects:write: Allow writing (creating, modifying, deleting) projects
            scim: Provide full access to SCIM operations
            scim:read: Allow reading SCIM endpoints
            scim:write: Allow writing (modifying) SCIM endpoints
            services: Provide full access to services APIs
            services:read: Allow enumerating services and reading their configuration
            services:write: Allow writing (creating, modifying, deleting) services
            static_ips: Provide full access to static IPs APIs
            static_ips:read: Allow enumerating and reading static IP items and configurations
            static_ips:write: Allow writing (creating, modifying, deleting) static IP items
            tickets: Provide full access to support ticket APIs
            tickets:read: Allow enumerating and reading support tickets
            tickets:write: Allow writing (creating, modifying) support tickets
            user: Provide full access to user profile APIs
            user:read: Allow reading user profile and configuration
            user:write: Allow writing (modifying) user profile and configuration
externalDocs:
  description: Aiven CLI client
  url: https://github.com/aiven/aiven-client