openapi: 3.0.3 info: title: Waldur API version: 7.7.8 paths: /api-auth/eduteams/complete/: get: operationId: api_auth_eduteams_complete_retrieve parameters: - in: query name: code schema: type: string - in: query name: state schema: type: string tags: - api-auth responses: '200': description: No response body /api-auth/eduteams/init/: get: operationId: api_auth_eduteams_init_retrieve description: Redirect user to OIDC authorization endpoint tags: - api-auth responses: '200': description: No response body /api-auth/keycloak/complete/: get: operationId: api_auth_keycloak_complete_retrieve parameters: - in: query name: code schema: type: string - in: query name: state schema: type: string tags: - api-auth responses: '200': description: No response body /api-auth/keycloak/init/: get: operationId: api_auth_keycloak_init_retrieve description: Redirect user to OIDC authorization endpoint tags: - api-auth responses: '200': description: No response body /api-auth/logout/: post: operationId: api_auth_logout description: Logout from the system. If single logout is supported, returns logout URL. tags: - api-auth security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Logout' description: '' '204': description: No response body /api-auth/password/: post: operationId: api_auth_password tags: - api-auth requestBody: content: application/json: schema: $ref: '#/components/schemas/ObtainAuthTokenRequest' examples: ValidRequest: value: username: alice password: $ecr3t summary: Valid request example description: Example of a valid request to obtain an authentication token. required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/CoreAuthToken' examples: SuccessResponse: value: token: c84d653b9ec92c6cbac41c706593e66f567a7fa4 summary: Success response example description: Example of a successful response with the authentication token. description: '' '401': description: No response body /api-auth/saml2/login/: post: operationId: api_auth_saml2_login tags: - api-auth requestBody: content: application/json: schema: $ref: '#/components/schemas/Saml2LoginRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/Saml2Login' description: '' /api-auth/saml2/login/complete/: post: operationId: api_auth_saml2_login_complete tags: - api-auth requestBody: content: application/json: schema: $ref: '#/components/schemas/Saml2LoginCompleteRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/Saml2LoginComplete' description: '' /api-auth/saml2/logout/: get: operationId: api_auth_saml2_logout_retrieve tags: - api-auth responses: '200': description: No response body /api-auth/saml2/logout/complete/: get: operationId: api_auth_saml2_logout_complete_retrieve description: For IdPs which send GET requests tags: - api-auth responses: '200': content: application/json: schema: $ref: '#/components/schemas/Saml2LogoutComplete' description: '' post: operationId: api_auth_saml2_logout_complete description: For IdPs which send POST requests tags: - api-auth requestBody: content: application/json: schema: $ref: '#/components/schemas/Saml2LogoutCompleteRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Saml2LogoutComplete' description: '' /api-auth/saml2/providers/: get: operationId: api_auth_saml2_providers_list parameters: - in: query name: name schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - api-auth security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/Saml2Provider' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' /api-auth/tara/complete/: get: operationId: api_auth_tara_complete_retrieve parameters: - in: query name: code schema: type: string - in: query name: state schema: type: string tags: - api-auth responses: '200': description: No response body /api-auth/tara/init/: get: operationId: api_auth_tara_init_retrieve description: Redirect user to OIDC authorization endpoint tags: - api-auth responses: '200': description: No response body /api/access-subnets/: get: operationId: access_subnets_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: customer schema: type: string - in: query name: customer_uuid schema: type: string format: uuid - in: query name: description schema: type: string - in: query name: inet schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - access-subnets security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/AccessSubnet' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' post: operationId: access_subnets_create tags: - access-subnets requestBody: content: application/json: schema: $ref: '#/components/schemas/AccessSubnetRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/AccessSubnet' description: '' head: operationId: access_subnets_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: customer schema: type: string - in: query name: customer_uuid schema: type: string format: uuid - in: query name: description schema: type: string - in: query name: inet schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - access-subnets security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/access-subnets/{uuid}/: get: operationId: access_subnets_retrieve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - access-subnets security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/AccessSubnet' description: '' put: operationId: access_subnets_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - access-subnets requestBody: content: application/json: schema: $ref: '#/components/schemas/AccessSubnetRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/AccessSubnet' description: '' x-permissions: - permission: ACCESS_SUBNET.UPDATE scopes: - customer patch: operationId: access_subnets_partial_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - access-subnets requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedAccessSubnetRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/AccessSubnet' description: '' x-permissions: - permission: ACCESS_SUBNET.UPDATE scopes: - customer delete: operationId: access_subnets_destroy parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - access-subnets security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '204': description: No response body x-permissions: - permission: ACCESS_SUBNET.DELETE scopes: - customer /api/admin-announcements/: get: operationId: admin_announcements_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: description schema: type: string - in: query name: field schema: type: array items: type: string enum: - active_from - active_to - created - description - is_active - maintenance_affected_offerings - maintenance_name - maintenance_scheduled_end - maintenance_scheduled_start - maintenance_service_provider - maintenance_state - maintenance_type - maintenance_uuid - type - uuid - in: query name: is_active schema: type: boolean - in: query name: o schema: type: array items: type: string enum: - -active_from - -active_to - -created - -name - -type - active_from - active_to - created - name - type description: |+ Ordering explode: false style: form - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: type schema: type: array items: type: string enum: - danger - information - warning explode: true style: form tags: - admin-announcements security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/AdminAnnouncement' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' post: operationId: admin_announcements_create tags: - admin-announcements requestBody: content: application/json: schema: $ref: '#/components/schemas/AdminAnnouncementRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/AdminAnnouncement' description: '' head: operationId: admin_announcements_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: description schema: type: string - in: query name: is_active schema: type: boolean - in: query name: o schema: type: array items: type: string enum: - -active_from - -active_to - -created - -name - -type - active_from - active_to - created - name - type description: |+ Ordering explode: false style: form - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: type schema: type: array items: type: string enum: - danger - information - warning explode: true style: form tags: - admin-announcements security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/admin-announcements/{uuid}/: get: operationId: admin_announcements_retrieve parameters: - in: query name: field schema: type: array items: type: string enum: - active_from - active_to - created - description - is_active - maintenance_affected_offerings - maintenance_name - maintenance_scheduled_end - maintenance_scheduled_start - maintenance_service_provider - maintenance_state - maintenance_type - maintenance_uuid - type - uuid - in: path name: uuid schema: type: string format: uuid required: true tags: - admin-announcements security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/AdminAnnouncement' description: '' put: operationId: admin_announcements_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - admin-announcements requestBody: content: application/json: schema: $ref: '#/components/schemas/AdminAnnouncementRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/AdminAnnouncement' description: '' patch: operationId: admin_announcements_partial_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - admin-announcements requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedAdminAnnouncementRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/AdminAnnouncement' description: '' delete: operationId: admin_announcements_destroy parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - admin-announcements security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '204': description: No response body /api/auth-tokens/: get: operationId: auth_tokens_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - auth-tokens security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/AuthToken' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' head: operationId: auth_tokens_count description: Get number of items in the collection matching the request parameters. parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - auth-tokens security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/auth-tokens/{user_id}/: get: operationId: auth_tokens_retrieve parameters: - in: path name: user_id schema: type: integer required: true tags: - auth-tokens security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/AuthToken' description: '' delete: operationId: auth_tokens_destroy parameters: - in: path name: user_id schema: type: integer required: true tags: - auth-tokens security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '204': description: No response body /api/auth-valimo/: post: operationId: auth_valimo_create tags: - auth-valimo requestBody: content: application/json: schema: $ref: '#/components/schemas/AuthResultRequest' examples: ValidRequest: value: phone: '1234567890' summary: Start PKI login process description: Example of a valid request to start PKI login process with user's phone. required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/AuthResult' description: '' /api/auth-valimo/result/: post: operationId: auth_valimo_result description: "\n To get PKI login status and details - issue post request\ \ against /api/auth-valimo/result/\n with uuid in parameters.\n\n \ \ Possible states:\n - Scheduled - login process is scheduled\n\ \ - Processing - login is in progress\n - OK - login was successful.\ \ Response will contain token.\n - Canceled - login was canceled by\ \ user or timed out. Field details will contain additional info.\n \ \ - Erred - unexpected exception happened during login process.\n " tags: - auth-valimo requestBody: content: application/json: schema: $ref: '#/components/schemas/AuthResultUUIDRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/AuthResult' examples: SuccessfulLogin: value: uuid: e42473f39c844333a80107e139a4dd06 token: null message: '1234' state: OK error_message: '' details: User authenticated. summary: Successful login description: Example of response for successful login. CanceledLogin: value: uuid: e42473f39c844333a80107e139a4dd06 token: null message: '1234' state: Canceled error_message: '' details: User cancel. summary: Canceled login description: Example of response when login was canceled by user. description: '' /api/autoprovisioning-rules/: get: operationId: autoprovisioning_rules_list description: Manage autoprovisioning rules. parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - Autoprovisioning Rules security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/Rule' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' post: operationId: autoprovisioning_rules_create description: Manage autoprovisioning rules. tags: - Autoprovisioning Rules requestBody: content: application/json: schema: $ref: '#/components/schemas/RuleRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/Rule' description: '' head: operationId: autoprovisioning_rules_count description: Get number of items in the collection matching the request parameters. parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - Autoprovisioning Rules security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/autoprovisioning-rules/{uuid}/: get: operationId: autoprovisioning_rules_retrieve description: Manage autoprovisioning rules. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - Autoprovisioning Rules security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Rule' description: '' put: operationId: autoprovisioning_rules_update description: Manage autoprovisioning rules. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - Autoprovisioning Rules requestBody: content: application/json: schema: $ref: '#/components/schemas/RuleRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Rule' description: '' patch: operationId: autoprovisioning_rules_partial_update description: Manage autoprovisioning rules. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - Autoprovisioning Rules requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedRuleRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Rule' description: '' delete: operationId: autoprovisioning_rules_destroy description: Manage autoprovisioning rules. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - Autoprovisioning Rules security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '204': description: No response body /api/aws-images/: get: operationId: aws_images_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: region schema: type: string format: uuid tags: - aws-images security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/AwsImage' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' head: operationId: aws_images_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: region schema: type: string format: uuid tags: - aws-images security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/aws-images/{uuid}/: get: operationId: aws_images_retrieve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - aws-images security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/AwsImage' description: '' /api/aws-instances/: get: operationId: aws_instances_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: backend_id schema: type: string - in: query name: can_manage schema: type: boolean description: Can manage - in: query name: customer schema: type: string format: uuid - in: query name: customer_abbreviation schema: type: string - in: query name: customer_name schema: type: string - in: query name: customer_native_name schema: type: string - in: query name: customer_uuid schema: type: string format: uuid - in: query name: description schema: type: string - in: query name: external_ip schema: type: string - in: query name: field schema: type: array items: type: string enum: - access_url - backend_id - cores - created - customer - customer_abbreviation - customer_name - customer_native_name - description - disk - error_message - error_traceback - external_ips - image - image_name - internal_ips - is_limit_based - is_usage_based - key_fingerprint - key_name - latitude - longitude - marketplace_category_name - marketplace_category_uuid - marketplace_offering_name - marketplace_offering_plugin_options - marketplace_offering_uuid - marketplace_plan_uuid - marketplace_resource_state - marketplace_resource_uuid - min_disk - min_ram - modified - name - project - project_name - project_uuid - ram - region - resource_type - service_name - service_settings - service_settings_error_message - service_settings_state - service_settings_uuid - size - ssh_public_key - start_time - state - url - user_data - uuid - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: project schema: type: string format: uuid - in: query name: project_name schema: type: string - in: query name: project_uuid schema: type: string format: uuid - in: query name: service_settings_name schema: type: string - in: query name: service_settings_uuid schema: type: string format: uuid - in: query name: state schema: type: array items: type: string enum: - CREATING - CREATION_SCHEDULED - DELETING - DELETION_SCHEDULED - ERRED - OK - UPDATE_SCHEDULED - UPDATING explode: true style: form - in: query name: uuid schema: type: string format: uuid tags: - aws-instances security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/AwsInstance' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' post: operationId: aws_instances_create tags: - aws-instances requestBody: content: application/json: schema: $ref: '#/components/schemas/AwsInstanceRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/AwsInstance' description: '' head: operationId: aws_instances_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: backend_id schema: type: string - in: query name: can_manage schema: type: boolean description: Can manage - in: query name: customer schema: type: string format: uuid - in: query name: customer_abbreviation schema: type: string - in: query name: customer_name schema: type: string - in: query name: customer_native_name schema: type: string - in: query name: customer_uuid schema: type: string format: uuid - in: query name: description schema: type: string - in: query name: external_ip schema: type: string - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: project schema: type: string format: uuid - in: query name: project_name schema: type: string - in: query name: project_uuid schema: type: string format: uuid - in: query name: service_settings_name schema: type: string - in: query name: service_settings_uuid schema: type: string format: uuid - in: query name: state schema: type: array items: type: string enum: - CREATING - CREATION_SCHEDULED - DELETING - DELETION_SCHEDULED - ERRED - OK - UPDATE_SCHEDULED - UPDATING explode: true style: form - in: query name: uuid schema: type: string format: uuid tags: - aws-instances security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/aws-instances/{uuid}/: get: operationId: aws_instances_retrieve parameters: - in: query name: field schema: type: array items: type: string enum: - access_url - backend_id - cores - created - customer - customer_abbreviation - customer_name - customer_native_name - description - disk - error_message - error_traceback - external_ips - image - image_name - internal_ips - is_limit_based - is_usage_based - key_fingerprint - key_name - latitude - longitude - marketplace_category_name - marketplace_category_uuid - marketplace_offering_name - marketplace_offering_plugin_options - marketplace_offering_uuid - marketplace_plan_uuid - marketplace_resource_state - marketplace_resource_uuid - min_disk - min_ram - modified - name - project - project_name - project_uuid - ram - region - resource_type - service_name - service_settings - service_settings_error_message - service_settings_state - service_settings_uuid - size - ssh_public_key - start_time - state - url - user_data - uuid - in: path name: uuid schema: type: string format: uuid required: true tags: - aws-instances security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/AwsInstance' description: '' put: operationId: aws_instances_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - aws-instances requestBody: content: application/json: schema: $ref: '#/components/schemas/AwsInstanceRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/AwsInstance' description: '' patch: operationId: aws_instances_partial_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - aws-instances requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedAwsInstanceRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/AwsInstance' description: '' delete: operationId: aws_instances_destroy parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - aws-instances security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '204': description: No response body /api/aws-instances/{uuid}/pull/: post: operationId: aws_instances_pull parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - aws-instances security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/aws-instances/{uuid}/resize/: post: operationId: aws_instances_resize parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - aws-instances requestBody: content: application/json: schema: $ref: '#/components/schemas/AwsInstanceResizeRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/AwsInstanceResize' description: '' /api/aws-instances/{uuid}/restart/: post: operationId: aws_instances_restart parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - aws-instances security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/aws-instances/{uuid}/start/: post: operationId: aws_instances_start parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - aws-instances security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/aws-instances/{uuid}/stop/: post: operationId: aws_instances_stop parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - aws-instances security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/aws-instances/{uuid}/unlink/: post: operationId: aws_instances_unlink description: |- Delete resource from the database without scheduling operations on backend and without checking current state of the resource. It is intended to be used for removing resource stuck in transitioning state. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - aws-instances security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/aws-regions/: get: operationId: aws_regions_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - aws-regions security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/AwsRegion' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' head: operationId: aws_regions_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - aws-regions security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/aws-regions/{uuid}/: get: operationId: aws_regions_retrieve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - aws-regions security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/AwsRegion' description: '' /api/aws-sizes/: get: operationId: aws_sizes_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: region schema: type: string format: uuid tags: - aws-sizes security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/AwsSize' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' head: operationId: aws_sizes_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: region schema: type: string format: uuid tags: - aws-sizes security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/aws-sizes/{uuid}/: get: operationId: aws_sizes_retrieve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - aws-sizes security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/AwsSize' description: '' /api/aws-volumes/: get: operationId: aws_volumes_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: field schema: type: array items: type: string enum: - access_url - backend_id - created - customer - customer_abbreviation - customer_name - customer_native_name - description - device - error_message - error_traceback - instance - is_limit_based - is_usage_based - marketplace_category_name - marketplace_category_uuid - marketplace_offering_name - marketplace_offering_plugin_options - marketplace_offering_uuid - marketplace_plan_uuid - marketplace_resource_state - marketplace_resource_uuid - modified - name - project - project_name - project_uuid - region - resource_type - runtime_state - service_name - service_settings - service_settings_error_message - service_settings_state - service_settings_uuid - size - state - url - uuid - volume_type - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - aws-volumes security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/AwsVolume' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' post: operationId: aws_volumes_create tags: - aws-volumes requestBody: content: application/json: schema: $ref: '#/components/schemas/AwsVolumeRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/AwsVolume' description: '' head: operationId: aws_volumes_count description: Get number of items in the collection matching the request parameters. parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - aws-volumes security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/aws-volumes/{uuid}/: get: operationId: aws_volumes_retrieve parameters: - in: query name: field schema: type: array items: type: string enum: - access_url - backend_id - created - customer - customer_abbreviation - customer_name - customer_native_name - description - device - error_message - error_traceback - instance - is_limit_based - is_usage_based - marketplace_category_name - marketplace_category_uuid - marketplace_offering_name - marketplace_offering_plugin_options - marketplace_offering_uuid - marketplace_plan_uuid - marketplace_resource_state - marketplace_resource_uuid - modified - name - project - project_name - project_uuid - region - resource_type - runtime_state - service_name - service_settings - service_settings_error_message - service_settings_state - service_settings_uuid - size - state - url - uuid - volume_type - in: path name: uuid schema: type: string format: uuid required: true tags: - aws-volumes security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/AwsVolume' description: '' put: operationId: aws_volumes_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - aws-volumes requestBody: content: application/json: schema: $ref: '#/components/schemas/AwsVolumeRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/AwsVolume' description: '' patch: operationId: aws_volumes_partial_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - aws-volumes security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/AwsVolume' description: '' delete: operationId: aws_volumes_destroy parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - aws-volumes security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '204': description: No response body /api/aws-volumes/{uuid}/attach/: post: operationId: aws_volumes_attach parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - aws-volumes requestBody: content: application/json: schema: $ref: '#/components/schemas/AwsVolumeAttachRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/AwsVolumeAttach' description: '' /api/aws-volumes/{uuid}/detach/: post: operationId: aws_volumes_detach parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - aws-volumes security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/aws-volumes/{uuid}/pull/: post: operationId: aws_volumes_pull parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - aws-volumes security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/aws-volumes/{uuid}/unlink/: post: operationId: aws_volumes_unlink description: |- Delete resource from the database without scheduling operations on backend and without checking current state of the resource. It is intended to be used for removing resource stuck in transitioning state. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - aws-volumes security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/azure-images/: get: operationId: azure_images_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: location schema: type: string - in: query name: location_uuid schema: type: string format: uuid - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: settings schema: type: string - in: query name: settings_uuid schema: type: string format: uuid tags: - azure-images security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/AzureImage' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' head: operationId: azure_images_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: location schema: type: string - in: query name: location_uuid schema: type: string format: uuid - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: settings schema: type: string - in: query name: settings_uuid schema: type: string format: uuid tags: - azure-images security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/azure-images/{uuid}/: get: operationId: azure_images_retrieve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - azure-images security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/AzureImage' description: '' /api/azure-locations/: get: operationId: azure_locations_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: has_sizes schema: type: boolean - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: settings schema: type: string - in: query name: settings_uuid schema: type: string format: uuid tags: - azure-locations security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/AzureLocation' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' head: operationId: azure_locations_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: has_sizes schema: type: boolean - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: settings schema: type: string - in: query name: settings_uuid schema: type: string format: uuid tags: - azure-locations security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/azure-locations/{uuid}/: get: operationId: azure_locations_retrieve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - azure-locations security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/AzureLocation' description: '' /api/azure-public-ips/: get: operationId: azure_public_ips_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: backend_id schema: type: string - in: query name: can_manage schema: type: boolean description: Can manage - in: query name: customer schema: type: string format: uuid - in: query name: customer_abbreviation schema: type: string - in: query name: customer_name schema: type: string - in: query name: customer_native_name schema: type: string - in: query name: customer_uuid schema: type: string format: uuid - in: query name: description schema: type: string - in: query name: external_ip schema: type: string - in: query name: field schema: type: array items: type: string enum: - access_url - backend_id - created - customer - customer_abbreviation - customer_name - customer_native_name - description - error_message - error_traceback - is_limit_based - is_usage_based - location - marketplace_category_name - marketplace_category_uuid - marketplace_offering_name - marketplace_offering_plugin_options - marketplace_offering_uuid - marketplace_plan_uuid - marketplace_resource_state - marketplace_resource_uuid - modified - name - project - project_name - project_uuid - resource_group - resource_type - service_name - service_settings - service_settings_error_message - service_settings_state - service_settings_uuid - state - url - uuid - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: project schema: type: string format: uuid - in: query name: project_name schema: type: string - in: query name: project_uuid schema: type: string format: uuid - in: query name: resource_group schema: type: string - in: query name: resource_group_uuid schema: type: string format: uuid - in: query name: service_settings_name schema: type: string - in: query name: service_settings_uuid schema: type: string format: uuid - in: query name: state schema: type: array items: type: string enum: - CREATING - CREATION_SCHEDULED - DELETING - DELETION_SCHEDULED - ERRED - OK - UPDATE_SCHEDULED - UPDATING explode: true style: form - in: query name: uuid schema: type: string format: uuid tags: - azure-public-ips security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/AzurePublicIP' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' post: operationId: azure_public_ips_create tags: - azure-public-ips requestBody: content: application/json: schema: $ref: '#/components/schemas/AzurePublicIPRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/AzurePublicIP' description: '' head: operationId: azure_public_ips_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: backend_id schema: type: string - in: query name: can_manage schema: type: boolean description: Can manage - in: query name: customer schema: type: string format: uuid - in: query name: customer_abbreviation schema: type: string - in: query name: customer_name schema: type: string - in: query name: customer_native_name schema: type: string - in: query name: customer_uuid schema: type: string format: uuid - in: query name: description schema: type: string - in: query name: external_ip schema: type: string - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: project schema: type: string format: uuid - in: query name: project_name schema: type: string - in: query name: project_uuid schema: type: string format: uuid - in: query name: resource_group schema: type: string - in: query name: resource_group_uuid schema: type: string format: uuid - in: query name: service_settings_name schema: type: string - in: query name: service_settings_uuid schema: type: string format: uuid - in: query name: state schema: type: array items: type: string enum: - CREATING - CREATION_SCHEDULED - DELETING - DELETION_SCHEDULED - ERRED - OK - UPDATE_SCHEDULED - UPDATING explode: true style: form - in: query name: uuid schema: type: string format: uuid tags: - azure-public-ips security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/azure-public-ips/{uuid}/: get: operationId: azure_public_ips_retrieve parameters: - in: query name: field schema: type: array items: type: string enum: - access_url - backend_id - created - customer - customer_abbreviation - customer_name - customer_native_name - description - error_message - error_traceback - is_limit_based - is_usage_based - location - marketplace_category_name - marketplace_category_uuid - marketplace_offering_name - marketplace_offering_plugin_options - marketplace_offering_uuid - marketplace_plan_uuid - marketplace_resource_state - marketplace_resource_uuid - modified - name - project - project_name - project_uuid - resource_group - resource_type - service_name - service_settings - service_settings_error_message - service_settings_state - service_settings_uuid - state - url - uuid - in: path name: uuid schema: type: string format: uuid required: true tags: - azure-public-ips security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/AzurePublicIP' description: '' put: operationId: azure_public_ips_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - azure-public-ips requestBody: content: application/json: schema: $ref: '#/components/schemas/AzurePublicIPRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/AzurePublicIP' description: '' patch: operationId: azure_public_ips_partial_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - azure-public-ips requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedAzurePublicIPRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/AzurePublicIP' description: '' delete: operationId: azure_public_ips_destroy parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - azure-public-ips security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '204': description: No response body /api/azure-public-ips/{uuid}/pull/: post: operationId: azure_public_ips_pull parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - azure-public-ips security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/azure-public-ips/{uuid}/unlink/: post: operationId: azure_public_ips_unlink description: |- Delete resource from the database without scheduling operations on backend and without checking current state of the resource. It is intended to be used for removing resource stuck in transitioning state. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - azure-public-ips security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/azure-resource-groups/: get: operationId: azure_resource_groups_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: field schema: type: array items: type: string enum: - access_url - backend_id - created - customer - customer_abbreviation - customer_name - customer_native_name - description - error_message - error_traceback - is_limit_based - is_usage_based - location - marketplace_category_name - marketplace_category_uuid - marketplace_offering_name - marketplace_offering_plugin_options - marketplace_offering_uuid - marketplace_plan_uuid - marketplace_resource_state - marketplace_resource_uuid - modified - name - project - project_name - project_uuid - resource_type - service_name - service_settings - service_settings_error_message - service_settings_state - service_settings_uuid - state - url - uuid - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - azure-resource-groups security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/AzureResourceGroup' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' head: operationId: azure_resource_groups_count description: Get number of items in the collection matching the request parameters. parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - azure-resource-groups security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/azure-resource-groups/{uuid}/: get: operationId: azure_resource_groups_retrieve parameters: - in: query name: field schema: type: array items: type: string enum: - access_url - backend_id - created - customer - customer_abbreviation - customer_name - customer_native_name - description - error_message - error_traceback - is_limit_based - is_usage_based - location - marketplace_category_name - marketplace_category_uuid - marketplace_offering_name - marketplace_offering_plugin_options - marketplace_offering_uuid - marketplace_plan_uuid - marketplace_resource_state - marketplace_resource_uuid - modified - name - project - project_name - project_uuid - resource_type - service_name - service_settings - service_settings_error_message - service_settings_state - service_settings_uuid - state - url - uuid - in: path name: uuid schema: type: string format: uuid required: true tags: - azure-resource-groups security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/AzureResourceGroup' description: '' /api/azure-sizes/: get: operationId: azure_sizes_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: location schema: type: string - in: query name: location_uuid schema: type: string format: uuid - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: settings schema: type: string - in: query name: settings_uuid schema: type: string format: uuid - in: query name: zone schema: type: integer tags: - azure-sizes security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/AzureSize' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' head: operationId: azure_sizes_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: location schema: type: string - in: query name: location_uuid schema: type: string format: uuid - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: settings schema: type: string - in: query name: settings_uuid schema: type: string format: uuid - in: query name: zone schema: type: integer tags: - azure-sizes security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/azure-sizes/{uuid}/: get: operationId: azure_sizes_retrieve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - azure-sizes security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/AzureSize' description: '' /api/azure-sql-databases/: get: operationId: azure_sql_databases_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: backend_id schema: type: string - in: query name: can_manage schema: type: boolean description: Can manage - in: query name: customer schema: type: string format: uuid - in: query name: customer_abbreviation schema: type: string - in: query name: customer_name schema: type: string - in: query name: customer_native_name schema: type: string - in: query name: customer_uuid schema: type: string format: uuid - in: query name: description schema: type: string - in: query name: external_ip schema: type: string - in: query name: field schema: type: array items: type: string enum: - access_url - backend_id - charset - collation - created - customer - customer_abbreviation - customer_name - customer_native_name - description - error_message - error_traceback - is_limit_based - is_usage_based - location_name - marketplace_category_name - marketplace_category_uuid - marketplace_offering_name - marketplace_offering_plugin_options - marketplace_offering_uuid - marketplace_plan_uuid - marketplace_resource_state - marketplace_resource_uuid - modified - name - project - project_name - project_uuid - resource_group_name - resource_type - server - server_marketplace_uuid - server_name - server_uuid - service_name - service_settings - service_settings_error_message - service_settings_state - service_settings_uuid - state - url - uuid - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: project schema: type: string format: uuid - in: query name: project_name schema: type: string - in: query name: project_uuid schema: type: string format: uuid - in: query name: resource_group schema: type: string - in: query name: resource_group_uuid schema: type: string format: uuid - in: query name: server schema: type: string - in: query name: server_uuid schema: type: string format: uuid - in: query name: service_settings_name schema: type: string - in: query name: service_settings_uuid schema: type: string format: uuid - in: query name: state schema: type: array items: type: string enum: - CREATING - CREATION_SCHEDULED - DELETING - DELETION_SCHEDULED - ERRED - OK - UPDATE_SCHEDULED - UPDATING explode: true style: form - in: query name: uuid schema: type: string format: uuid tags: - azure-sql-databases security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/AzureSqlDatabase' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' post: operationId: azure_sql_databases_create tags: - azure-sql-databases requestBody: content: application/json: schema: $ref: '#/components/schemas/AzureSqlDatabaseRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/AzureSqlDatabase' description: '' head: operationId: azure_sql_databases_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: backend_id schema: type: string - in: query name: can_manage schema: type: boolean description: Can manage - in: query name: customer schema: type: string format: uuid - in: query name: customer_abbreviation schema: type: string - in: query name: customer_name schema: type: string - in: query name: customer_native_name schema: type: string - in: query name: customer_uuid schema: type: string format: uuid - in: query name: description schema: type: string - in: query name: external_ip schema: type: string - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: project schema: type: string format: uuid - in: query name: project_name schema: type: string - in: query name: project_uuid schema: type: string format: uuid - in: query name: resource_group schema: type: string - in: query name: resource_group_uuid schema: type: string format: uuid - in: query name: server schema: type: string - in: query name: server_uuid schema: type: string format: uuid - in: query name: service_settings_name schema: type: string - in: query name: service_settings_uuid schema: type: string format: uuid - in: query name: state schema: type: array items: type: string enum: - CREATING - CREATION_SCHEDULED - DELETING - DELETION_SCHEDULED - ERRED - OK - UPDATE_SCHEDULED - UPDATING explode: true style: form - in: query name: uuid schema: type: string format: uuid tags: - azure-sql-databases security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/azure-sql-databases/{uuid}/: get: operationId: azure_sql_databases_retrieve parameters: - in: query name: field schema: type: array items: type: string enum: - access_url - backend_id - charset - collation - created - customer - customer_abbreviation - customer_name - customer_native_name - description - error_message - error_traceback - is_limit_based - is_usage_based - location_name - marketplace_category_name - marketplace_category_uuid - marketplace_offering_name - marketplace_offering_plugin_options - marketplace_offering_uuid - marketplace_plan_uuid - marketplace_resource_state - marketplace_resource_uuid - modified - name - project - project_name - project_uuid - resource_group_name - resource_type - server - server_marketplace_uuid - server_name - server_uuid - service_name - service_settings - service_settings_error_message - service_settings_state - service_settings_uuid - state - url - uuid - in: path name: uuid schema: type: string format: uuid required: true tags: - azure-sql-databases security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/AzureSqlDatabase' description: '' put: operationId: azure_sql_databases_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - azure-sql-databases requestBody: content: application/json: schema: $ref: '#/components/schemas/AzureSqlDatabaseRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/AzureSqlDatabase' description: '' patch: operationId: azure_sql_databases_partial_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - azure-sql-databases requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedAzureSqlDatabaseRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/AzureSqlDatabase' description: '' delete: operationId: azure_sql_databases_destroy parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - azure-sql-databases security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '204': description: No response body /api/azure-sql-databases/{uuid}/pull/: post: operationId: azure_sql_databases_pull parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - azure-sql-databases security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/azure-sql-databases/{uuid}/unlink/: post: operationId: azure_sql_databases_unlink description: |- Delete resource from the database without scheduling operations on backend and without checking current state of the resource. It is intended to be used for removing resource stuck in transitioning state. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - azure-sql-databases security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/azure-sql-servers/: get: operationId: azure_sql_servers_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: backend_id schema: type: string - in: query name: can_manage schema: type: boolean description: Can manage - in: query name: customer schema: type: string format: uuid - in: query name: customer_abbreviation schema: type: string - in: query name: customer_name schema: type: string - in: query name: customer_native_name schema: type: string - in: query name: customer_uuid schema: type: string format: uuid - in: query name: description schema: type: string - in: query name: external_ip schema: type: string - in: query name: field schema: type: array items: type: string enum: - access_url - backend_id - created - customer - customer_abbreviation - customer_name - customer_native_name - description - error_message - error_traceback - fqdn - is_limit_based - is_usage_based - location - location_name - marketplace_category_name - marketplace_category_uuid - marketplace_offering_name - marketplace_offering_plugin_options - marketplace_offering_uuid - marketplace_plan_uuid - marketplace_resource_state - marketplace_resource_uuid - modified - name - password - project - project_name - project_uuid - resource_group - resource_group_name - resource_type - service_name - service_settings - service_settings_error_message - service_settings_state - service_settings_uuid - state - storage_mb - url - username - uuid - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: project schema: type: string format: uuid - in: query name: project_name schema: type: string - in: query name: project_uuid schema: type: string format: uuid - in: query name: resource_group schema: type: string - in: query name: resource_group_uuid schema: type: string format: uuid - in: query name: service_settings_name schema: type: string - in: query name: service_settings_uuid schema: type: string format: uuid - in: query name: state schema: type: array items: type: string enum: - CREATING - CREATION_SCHEDULED - DELETING - DELETION_SCHEDULED - ERRED - OK - UPDATE_SCHEDULED - UPDATING explode: true style: form - in: query name: uuid schema: type: string format: uuid tags: - azure-sql-servers security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/AzureSqlServer' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' post: operationId: azure_sql_servers_create tags: - azure-sql-servers requestBody: content: application/json: schema: $ref: '#/components/schemas/AzureSqlServerRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/AzureSqlServer' description: '' head: operationId: azure_sql_servers_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: backend_id schema: type: string - in: query name: can_manage schema: type: boolean description: Can manage - in: query name: customer schema: type: string format: uuid - in: query name: customer_abbreviation schema: type: string - in: query name: customer_name schema: type: string - in: query name: customer_native_name schema: type: string - in: query name: customer_uuid schema: type: string format: uuid - in: query name: description schema: type: string - in: query name: external_ip schema: type: string - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: project schema: type: string format: uuid - in: query name: project_name schema: type: string - in: query name: project_uuid schema: type: string format: uuid - in: query name: resource_group schema: type: string - in: query name: resource_group_uuid schema: type: string format: uuid - in: query name: service_settings_name schema: type: string - in: query name: service_settings_uuid schema: type: string format: uuid - in: query name: state schema: type: array items: type: string enum: - CREATING - CREATION_SCHEDULED - DELETING - DELETION_SCHEDULED - ERRED - OK - UPDATE_SCHEDULED - UPDATING explode: true style: form - in: query name: uuid schema: type: string format: uuid tags: - azure-sql-servers security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/azure-sql-servers/{uuid}/: get: operationId: azure_sql_servers_retrieve parameters: - in: query name: field schema: type: array items: type: string enum: - access_url - backend_id - created - customer - customer_abbreviation - customer_name - customer_native_name - description - error_message - error_traceback - fqdn - is_limit_based - is_usage_based - location - location_name - marketplace_category_name - marketplace_category_uuid - marketplace_offering_name - marketplace_offering_plugin_options - marketplace_offering_uuid - marketplace_plan_uuid - marketplace_resource_state - marketplace_resource_uuid - modified - name - password - project - project_name - project_uuid - resource_group - resource_group_name - resource_type - service_name - service_settings - service_settings_error_message - service_settings_state - service_settings_uuid - state - storage_mb - url - username - uuid - in: path name: uuid schema: type: string format: uuid required: true tags: - azure-sql-servers security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/AzureSqlServer' description: '' put: operationId: azure_sql_servers_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - azure-sql-servers requestBody: content: application/json: schema: $ref: '#/components/schemas/AzureSqlServerRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/AzureSqlServer' description: '' patch: operationId: azure_sql_servers_partial_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - azure-sql-servers requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedAzureSqlServerRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/AzureSqlServer' description: '' delete: operationId: azure_sql_servers_destroy parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - azure-sql-servers security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '204': description: No response body /api/azure-sql-servers/{uuid}/create_database/: post: operationId: azure_sql_servers_create_database parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - azure-sql-servers requestBody: content: application/json: schema: $ref: '#/components/schemas/AzureSqlDatabaseCreateRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/AzureSqlDatabaseCreate' description: '' /api/azure-sql-servers/{uuid}/pull/: post: operationId: azure_sql_servers_pull parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - azure-sql-servers security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/azure-sql-servers/{uuid}/unlink/: post: operationId: azure_sql_servers_unlink description: |- Delete resource from the database without scheduling operations on backend and without checking current state of the resource. It is intended to be used for removing resource stuck in transitioning state. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - azure-sql-servers security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/azure-virtualmachines/: get: operationId: azure_virtualmachines_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: backend_id schema: type: string - in: query name: can_manage schema: type: boolean description: Can manage - in: query name: customer schema: type: string format: uuid - in: query name: customer_abbreviation schema: type: string - in: query name: customer_name schema: type: string - in: query name: customer_native_name schema: type: string - in: query name: customer_uuid schema: type: string format: uuid - in: query name: description schema: type: string - in: query name: external_ip schema: type: string - in: query name: field schema: type: array items: type: string enum: - access_url - backend_id - cores - created - customer - customer_abbreviation - customer_name - customer_native_name - description - disk - error_message - error_traceback - external_ips - image - image_name - internal_ips - is_limit_based - is_usage_based - key_fingerprint - key_name - latitude - location - location_name - longitude - marketplace_category_name - marketplace_category_uuid - marketplace_offering_name - marketplace_offering_plugin_options - marketplace_offering_uuid - marketplace_plan_uuid - marketplace_resource_state - marketplace_resource_uuid - min_disk - min_ram - modified - name - password - project - project_name - project_uuid - ram - resource_group - resource_group_name - resource_type - runtime_state - service_name - service_settings - service_settings_error_message - service_settings_state - service_settings_uuid - size - size_name - ssh_public_key - start_time - state - url - user_data - username - uuid - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: project schema: type: string format: uuid - in: query name: project_name schema: type: string - in: query name: project_uuid schema: type: string format: uuid - in: query name: resource_group schema: type: string - in: query name: resource_group_uuid schema: type: string format: uuid - in: query name: service_settings_name schema: type: string - in: query name: service_settings_uuid schema: type: string format: uuid - in: query name: state schema: type: array items: type: string enum: - CREATING - CREATION_SCHEDULED - DELETING - DELETION_SCHEDULED - ERRED - OK - UPDATE_SCHEDULED - UPDATING explode: true style: form - in: query name: uuid schema: type: string format: uuid tags: - azure-virtualmachines security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/AzureVirtualMachine' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' post: operationId: azure_virtualmachines_create tags: - azure-virtualmachines requestBody: content: application/json: schema: $ref: '#/components/schemas/AzureVirtualMachineRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/AzureVirtualMachine' description: '' head: operationId: azure_virtualmachines_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: backend_id schema: type: string - in: query name: can_manage schema: type: boolean description: Can manage - in: query name: customer schema: type: string format: uuid - in: query name: customer_abbreviation schema: type: string - in: query name: customer_name schema: type: string - in: query name: customer_native_name schema: type: string - in: query name: customer_uuid schema: type: string format: uuid - in: query name: description schema: type: string - in: query name: external_ip schema: type: string - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: project schema: type: string format: uuid - in: query name: project_name schema: type: string - in: query name: project_uuid schema: type: string format: uuid - in: query name: resource_group schema: type: string - in: query name: resource_group_uuid schema: type: string format: uuid - in: query name: service_settings_name schema: type: string - in: query name: service_settings_uuid schema: type: string format: uuid - in: query name: state schema: type: array items: type: string enum: - CREATING - CREATION_SCHEDULED - DELETING - DELETION_SCHEDULED - ERRED - OK - UPDATE_SCHEDULED - UPDATING explode: true style: form - in: query name: uuid schema: type: string format: uuid tags: - azure-virtualmachines security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/azure-virtualmachines/{uuid}/: get: operationId: azure_virtualmachines_retrieve parameters: - in: query name: field schema: type: array items: type: string enum: - access_url - backend_id - cores - created - customer - customer_abbreviation - customer_name - customer_native_name - description - disk - error_message - error_traceback - external_ips - image - image_name - internal_ips - is_limit_based - is_usage_based - key_fingerprint - key_name - latitude - location - location_name - longitude - marketplace_category_name - marketplace_category_uuid - marketplace_offering_name - marketplace_offering_plugin_options - marketplace_offering_uuid - marketplace_plan_uuid - marketplace_resource_state - marketplace_resource_uuid - min_disk - min_ram - modified - name - password - project - project_name - project_uuid - ram - resource_group - resource_group_name - resource_type - runtime_state - service_name - service_settings - service_settings_error_message - service_settings_state - service_settings_uuid - size - size_name - ssh_public_key - start_time - state - url - user_data - username - uuid - in: path name: uuid schema: type: string format: uuid required: true tags: - azure-virtualmachines security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/AzureVirtualMachine' description: '' put: operationId: azure_virtualmachines_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - azure-virtualmachines requestBody: content: application/json: schema: $ref: '#/components/schemas/AzureVirtualMachineRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/AzureVirtualMachine' description: '' patch: operationId: azure_virtualmachines_partial_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - azure-virtualmachines requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedAzureVirtualMachineRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/AzureVirtualMachine' description: '' delete: operationId: azure_virtualmachines_destroy parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - azure-virtualmachines security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '204': description: No response body /api/azure-virtualmachines/{uuid}/pull/: post: operationId: azure_virtualmachines_pull parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - azure-virtualmachines security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/azure-virtualmachines/{uuid}/restart/: post: operationId: azure_virtualmachines_restart parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - azure-virtualmachines security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/azure-virtualmachines/{uuid}/start/: post: operationId: azure_virtualmachines_start parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - azure-virtualmachines security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/azure-virtualmachines/{uuid}/stop/: post: operationId: azure_virtualmachines_stop parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - azure-virtualmachines security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/azure-virtualmachines/{uuid}/unlink/: post: operationId: azure_virtualmachines_unlink description: |- Delete resource from the database without scheduling operations on backend and without checking current state of the resource. It is intended to be used for removing resource stuck in transitioning state. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - azure-virtualmachines security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/backend-resource-requests/: get: operationId: backend_resource_requests_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: created schema: type: string format: date-time description: Created after - in: query name: finished schema: type: string format: date-time description: Modified after - in: query name: modified schema: type: string format: date-time description: Modified after - in: query name: o schema: type: array items: type: string enum: - -created - created description: |+ Ordering explode: false style: form - in: query name: offering_uuid schema: type: string format: uuid - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: started schema: type: string format: date-time description: Created after - in: query name: state schema: type: array items: type: string enum: - Done - Erred - Processing - Sent explode: true style: form tags: - backend-resource-requests security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/BackendResourceReq' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' post: operationId: backend_resource_requests_create tags: - backend-resource-requests requestBody: content: application/json: schema: $ref: '#/components/schemas/BackendResourceReqRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/BackendResourceReq' description: '' head: operationId: backend_resource_requests_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: created schema: type: string format: date-time description: Created after - in: query name: finished schema: type: string format: date-time description: Modified after - in: query name: modified schema: type: string format: date-time description: Modified after - in: query name: o schema: type: array items: type: string enum: - -created - created description: |+ Ordering explode: false style: form - in: query name: offering_uuid schema: type: string format: uuid - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: started schema: type: string format: date-time description: Created after - in: query name: state schema: type: array items: type: string enum: - Done - Erred - Processing - Sent explode: true style: form tags: - backend-resource-requests security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/backend-resource-requests/{uuid}/: get: operationId: backend_resource_requests_retrieve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - backend-resource-requests security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/BackendResourceReq' description: '' /api/backend-resource-requests/{uuid}/set_done/: post: operationId: backend_resource_requests_set_done parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - backend-resource-requests security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: object additionalProperties: {} description: '' x-permissions: - permission: OFFERING.MANAGE_BACKEND_RESOURCES scopes: - offering - offering.customer /api/backend-resource-requests/{uuid}/set_erred/: post: operationId: backend_resource_requests_set_erred parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - backend-resource-requests requestBody: content: application/json: schema: $ref: '#/components/schemas/BackendResourceRequestSetErredRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: object additionalProperties: {} description: '' x-permissions: - permission: OFFERING.MANAGE_BACKEND_RESOURCES scopes: - offering - offering.customer /api/backend-resource-requests/{uuid}/start_processing/: post: operationId: backend_resource_requests_start_processing parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - backend-resource-requests security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: object additionalProperties: {} description: '' x-permissions: - permission: OFFERING.MANAGE_BACKEND_RESOURCES scopes: - offering - offering.customer /api/backend-resources/: get: operationId: backend_resources_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: backend_id schema: type: string description: Backend ID - in: query name: created schema: type: string format: date-time description: Created after - in: query name: modified schema: type: string format: date-time description: Modified after - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - in: query name: o schema: type: array items: type: string enum: - -created - created description: |+ Ordering explode: false style: form - in: query name: offering_uuid schema: type: string format: uuid - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: project_uuid schema: type: string format: uuid tags: - backend-resources security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/BackendResource' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' x-permissions: - permission: OFFERING.MANAGE_BACKEND_RESOURCES scopes: - offering - offering.customer post: operationId: backend_resources_create tags: - backend-resources requestBody: content: application/json: schema: $ref: '#/components/schemas/BackendResourceRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/BackendResource' description: '' head: operationId: backend_resources_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: backend_id schema: type: string description: Backend ID - in: query name: created schema: type: string format: date-time description: Created after - in: query name: modified schema: type: string format: date-time description: Modified after - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - in: query name: o schema: type: array items: type: string enum: - -created - created description: |+ Ordering explode: false style: form - in: query name: offering_uuid schema: type: string format: uuid - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: project_uuid schema: type: string format: uuid tags: - backend-resources security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body x-permissions: - permission: OFFERING.MANAGE_BACKEND_RESOURCES scopes: - offering - offering.customer /api/backend-resources/{uuid}/: get: operationId: backend_resources_retrieve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - backend-resources security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/BackendResource' description: '' x-permissions: - permission: OFFERING.MANAGE_BACKEND_RESOURCES scopes: - offering - offering.customer delete: operationId: backend_resources_destroy parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - backend-resources security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '204': description: No response body x-permissions: - permission: OFFERING.MANAGE_BACKEND_RESOURCES scopes: - offering - offering.customer /api/backend-resources/{uuid}/import_resource/: post: operationId: backend_resources_import_resource parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - backend-resources requestBody: content: application/json: schema: $ref: '#/components/schemas/BackendResourceImportRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Resource' description: '' /api/billing-total-cost/: get: operationId: billing_total_cost_retrieve parameters: - in: query name: accounting_is_running schema: type: boolean - in: query name: customer_uuid schema: type: string format: uuid - in: query name: month schema: type: integer - in: query name: name schema: type: string - in: query name: year schema: type: integer tags: - billing-total-cost security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/TotalCustomerCost' description: '' /api/booking-offerings/: get: operationId: booking_offerings_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: field schema: type: array items: type: string enum: - access_url - attributes - backend_id - backend_metadata - billable - category - category_title - category_uuid - citation_count - components - country - created - customer - customer_name - customer_uuid - datacite_doi - description - endpoints - files - full_description - getting_started - googlecalendar - has_compliance_requirements - image - integration_guide - latitude - longitude - name - options - order_count - organization_groups - parent_description - parent_name - parent_uuid - paused_reason - plans - plugin_options - privacy_policy_link - project - project_name - project_uuid - quotas - resource_options - roles - scope - scope_error_message - scope_name - scope_state - scope_uuid - screenshots - shared - slug - state - thumbnail - total_cost - total_cost_estimated - total_customers - type - url - uuid - vendor_details - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - booking-offerings security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/Offering' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' head: operationId: booking_offerings_count description: Get number of items in the collection matching the request parameters. parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - booking-offerings security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/booking-offerings/{uuid}/: get: operationId: booking_offerings_retrieve parameters: - in: query name: field schema: type: array items: type: string enum: - access_url - attributes - backend_id - backend_metadata - billable - category - category_title - category_uuid - citation_count - components - country - created - customer - customer_name - customer_uuid - datacite_doi - description - endpoints - files - full_description - getting_started - googlecalendar - has_compliance_requirements - image - integration_guide - latitude - longitude - name - options - order_count - organization_groups - parent_description - parent_name - parent_uuid - paused_reason - plans - plugin_options - privacy_policy_link - project - project_name - project_uuid - quotas - resource_options - roles - scope - scope_error_message - scope_name - scope_state - scope_uuid - screenshots - shared - slug - state - thumbnail - total_cost - total_cost_estimated - total_customers - type - url - uuid - vendor_details - in: path name: uuid schema: type: string format: uuid required: true tags: - booking-offerings security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Offering' description: '' /api/booking-offerings/{uuid}/google_calendar_sync/: post: operationId: booking_offerings_google_calendar_sync parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - booking-offerings security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/booking-offerings/{uuid}/share_google_calendar/: post: operationId: booking_offerings_share_google_calendar parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - booking-offerings security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/booking-offerings/{uuid}/unshare_google_calendar/: post: operationId: booking_offerings_unshare_google_calendar parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - booking-offerings security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/booking-resources/: get: operationId: booking_resources_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: backend_id schema: type: string description: Backend ID - in: query name: category_uuid schema: type: string format: uuid - in: query name: connected_customer_uuid schema: type: string format: uuid - in: query name: created schema: type: string format: date-time description: Created after - in: query name: customer schema: type: string - in: query name: customer_uuid schema: type: string format: uuid - in: query name: downscaled schema: type: boolean - in: query name: field schema: type: array items: type: string enum: - attributes - available_actions - backend_id - backend_metadata - can_terminate - category_icon - category_title - category_uuid - consumer_reviewed_by - consumer_reviewed_by_full_name - consumer_reviewed_by_username - created - created_by - created_by_full_name - created_by_username - creation_order - current_usages - customer_name - customer_slug - customer_uuid - description - downscaled - effective_id - end_date - end_date_requested_by - endpoints - error_message - error_traceback - is_limit_based - is_usage_based - last_sync - limit_usage - limits - modified - name - offering - offering_billable - offering_customer_uuid - offering_description - offering_image - offering_name - offering_plugin_options - offering_shared - offering_slug - offering_thumbnail - offering_type - offering_uuid - options - order_in_progress - parent_name - parent_offering_name - parent_offering_slug - parent_offering_uuid - parent_uuid - paused - plan - plan_description - plan_name - plan_unit - plan_uuid - project - project_description - project_end_date - project_end_date_requested_by - project_name - project_slug - project_uuid - provider_name - provider_uuid - report - resource_type - resource_uuid - restrict_member_access - scope - service_settings_uuid - slots - slug - state - url - user_requires_reconsent - username - uuid - in: query name: has_terminate_date schema: type: boolean description: Has termination date - in: query name: lexis_links_supported schema: type: boolean description: LEXIS links supported - in: query name: modified schema: type: string format: date-time description: Modified after - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - in: query name: o schema: type: array items: type: string enum: - -created - -name - -schedules - -type - created - name - schedules - type description: |+ Ordering explode: false style: form - in: query name: offering schema: type: string - in: query name: offering_billable schema: type: string format: uuid - in: query name: offering_shared schema: type: boolean description: Offering shared - in: query name: offering_slug schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: offering_type schema: type: string - in: query name: offering_uuid schema: type: array items: type: string format: uuid description: Multiple values may be separated by commas. explode: false style: form - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: parent_offering_uuid schema: type: string format: uuid - in: query name: paused schema: type: boolean - in: query name: project_name schema: type: string - in: query name: project_uuid schema: type: string format: uuid - in: query name: provider_uuid schema: type: string format: uuid - in: query name: query schema: type: string description: Search by resource UUID, name, backend ID, effective ID, IPs or hypervisor - in: query name: restrict_member_access schema: type: boolean - in: query name: runtime_state schema: type: string description: Runtime state - in: query name: service_manager_uuid schema: type: string format: uuid description: Service Manager UUID - in: query name: state schema: type: array items: type: string enum: - Creating - Erred - OK - Terminated - Terminating - Updating explode: true style: form - in: query name: visible_to_username schema: type: string description: Visible to username tags: - booking-resources security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/BookingResource' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' head: operationId: booking_resources_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: backend_id schema: type: string description: Backend ID - in: query name: category_uuid schema: type: string format: uuid - in: query name: connected_customer_uuid schema: type: string format: uuid - in: query name: created schema: type: string format: date-time description: Created after - in: query name: customer schema: type: string - in: query name: customer_uuid schema: type: string format: uuid - in: query name: downscaled schema: type: boolean - in: query name: has_terminate_date schema: type: boolean description: Has termination date - in: query name: lexis_links_supported schema: type: boolean description: LEXIS links supported - in: query name: modified schema: type: string format: date-time description: Modified after - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - in: query name: o schema: type: array items: type: string enum: - -created - -name - -schedules - -type - created - name - schedules - type description: |+ Ordering explode: false style: form - in: query name: offering schema: type: string - in: query name: offering_billable schema: type: string format: uuid - in: query name: offering_shared schema: type: boolean description: Offering shared - in: query name: offering_slug schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: offering_type schema: type: string - in: query name: offering_uuid schema: type: array items: type: string format: uuid description: Multiple values may be separated by commas. explode: false style: form - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: parent_offering_uuid schema: type: string format: uuid - in: query name: paused schema: type: boolean - in: query name: project_name schema: type: string - in: query name: project_uuid schema: type: string format: uuid - in: query name: provider_uuid schema: type: string format: uuid - in: query name: query schema: type: string description: Search by resource UUID, name, backend ID, effective ID, IPs or hypervisor - in: query name: restrict_member_access schema: type: boolean - in: query name: runtime_state schema: type: string description: Runtime state - in: query name: service_manager_uuid schema: type: string format: uuid description: Service Manager UUID - in: query name: state schema: type: array items: type: string enum: - Creating - Erred - OK - Terminated - Terminating - Updating explode: true style: form - in: query name: visible_to_username schema: type: string description: Visible to username tags: - booking-resources security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/booking-resources/{uuid}/: get: operationId: booking_resources_retrieve parameters: - in: query name: field schema: type: array items: type: string enum: - attributes - available_actions - backend_id - backend_metadata - can_terminate - category_icon - category_title - category_uuid - consumer_reviewed_by - consumer_reviewed_by_full_name - consumer_reviewed_by_username - created - created_by - created_by_full_name - created_by_username - creation_order - current_usages - customer_name - customer_slug - customer_uuid - description - downscaled - effective_id - end_date - end_date_requested_by - endpoints - error_message - error_traceback - is_limit_based - is_usage_based - last_sync - limit_usage - limits - modified - name - offering - offering_billable - offering_customer_uuid - offering_description - offering_image - offering_name - offering_plugin_options - offering_shared - offering_slug - offering_thumbnail - offering_type - offering_uuid - options - order_in_progress - parent_name - parent_offering_name - parent_offering_slug - parent_offering_uuid - parent_uuid - paused - plan - plan_description - plan_name - plan_unit - plan_uuid - project - project_description - project_end_date - project_end_date_requested_by - project_name - project_slug - project_uuid - provider_name - provider_uuid - report - resource_type - resource_uuid - restrict_member_access - scope - service_settings_uuid - slots - slug - state - url - user_requires_reconsent - username - uuid - in: path name: uuid schema: type: string format: uuid required: true tags: - booking-resources security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/BookingResource' description: '' /api/booking-resources/{uuid}/accept/: post: operationId: booking_resources_accept parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - booking-resources security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body x-permissions: - permission: RESOURCE.ACCEPT_BOOKING_REQUEST scopes: - project.customer - offering - offering.customer /api/booking-resources/{uuid}/reject/: post: operationId: booking_resources_reject parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - booking-resources security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/broadcast-message-templates/: get: operationId: broadcast_message_templates_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: name schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - broadcast-message-templates security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/MessageTemplate' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' post: operationId: broadcast_message_templates_create tags: - broadcast-message-templates requestBody: content: application/json: schema: $ref: '#/components/schemas/MessageTemplateRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/MessageTemplate' description: '' head: operationId: broadcast_message_templates_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: name schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - broadcast-message-templates security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/broadcast-message-templates/{uuid}/: get: operationId: broadcast_message_templates_retrieve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - broadcast-message-templates security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/MessageTemplate' description: '' put: operationId: broadcast_message_templates_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - broadcast-message-templates requestBody: content: application/json: schema: $ref: '#/components/schemas/MessageTemplateRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/MessageTemplate' description: '' patch: operationId: broadcast_message_templates_partial_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - broadcast-message-templates requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedMessageTemplateRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/MessageTemplate' description: '' delete: operationId: broadcast_message_templates_destroy parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - broadcast-message-templates security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '204': description: No response body /api/broadcast-messages/: get: operationId: broadcast_messages_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: field schema: type: array items: type: string enum: - author_full_name - body - created - emails - query - send_at - state - subject - uuid - in: query name: o schema: type: array items: type: string enum: - -author_full_name - -created - -subject - author_full_name - created - subject description: |+ Ordering explode: false style: form - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: state schema: type: string enum: - DRAFT - SCHEDULED - SENT - in: query name: subject schema: type: string tags: - broadcast-messages security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/BroadcastMessage' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' post: operationId: broadcast_messages_create tags: - broadcast-messages requestBody: content: application/json: schema: $ref: '#/components/schemas/BroadcastMessageRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/BroadcastMessage' description: '' head: operationId: broadcast_messages_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: o schema: type: array items: type: string enum: - -author_full_name - -created - -subject - author_full_name - created - subject description: |+ Ordering explode: false style: form - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: state schema: type: string enum: - DRAFT - SCHEDULED - SENT - in: query name: subject schema: type: string tags: - broadcast-messages security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/broadcast-messages/{uuid}/: get: operationId: broadcast_messages_retrieve parameters: - in: query name: field schema: type: array items: type: string enum: - author_full_name - body - created - emails - query - send_at - state - subject - uuid - in: path name: uuid schema: type: string format: uuid required: true tags: - broadcast-messages security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/BroadcastMessage' description: '' put: operationId: broadcast_messages_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - broadcast-messages requestBody: content: application/json: schema: $ref: '#/components/schemas/BroadcastMessageRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/BroadcastMessage' description: '' patch: operationId: broadcast_messages_partial_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - broadcast-messages requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedBroadcastMessageRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/BroadcastMessage' description: '' delete: operationId: broadcast_messages_destroy parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - broadcast-messages security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '204': description: No response body /api/broadcast-messages/{uuid}/schedule/: post: operationId: broadcast_messages_schedule parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - broadcast-messages security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/broadcast-messages/{uuid}/send/: post: operationId: broadcast_messages_send parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - broadcast-messages security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/broadcast-messages/recipients/: get: operationId: broadcast_messages_recipients_retrieve parameters: - in: query name: field schema: type: array items: type: string enum: - author_full_name - body - created - emails - query - send_at - state - subject - uuid tags: - broadcast-messages security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/BroadcastMessage' description: '' head: operationId: broadcast_messages_recipients_count tags: - broadcast-messages security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body description: Get number of items in the collection matching the request parameters. /api/call-managing-organisations/: get: operationId: call_managing_organisations_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: customer schema: type: string - in: query name: customer_keyword schema: type: string - in: query name: customer_uuid schema: type: string format: uuid - in: query name: o schema: type: array items: type: string enum: - -customer_name - customer_name description: |+ Ordering explode: false style: form - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - call-managing-organisations security: - tokenAuth: [] - waldurOIDCAuth: [] - {} responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/CallManagingOrganisation' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' post: operationId: call_managing_organisations_create tags: - call-managing-organisations requestBody: content: application/json: schema: $ref: '#/components/schemas/CallManagingOrganisationRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/CallManagingOrganisation' description: '' head: operationId: call_managing_organisations_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: customer schema: type: string - in: query name: customer_keyword schema: type: string - in: query name: customer_uuid schema: type: string format: uuid - in: query name: o schema: type: array items: type: string enum: - -customer_name - customer_name description: |+ Ordering explode: false style: form - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - call-managing-organisations security: - tokenAuth: [] - waldurOIDCAuth: [] - {} responses: '200': description: No response body /api/call-managing-organisations/{uuid}/: get: operationId: call_managing_organisations_retrieve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - call-managing-organisations security: - tokenAuth: [] - waldurOIDCAuth: [] - {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/CallManagingOrganisation' description: '' put: operationId: call_managing_organisations_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - call-managing-organisations requestBody: content: application/json: schema: $ref: '#/components/schemas/CallManagingOrganisationRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/CallManagingOrganisation' description: '' patch: operationId: call_managing_organisations_partial_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - call-managing-organisations requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedCallManagingOrganisationRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/CallManagingOrganisation' description: '' delete: operationId: call_managing_organisations_destroy parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - call-managing-organisations security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '204': description: No response body /api/call-managing-organisations/{uuid}/add_user/: post: operationId: call_managing_organisations_add_user parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - call-managing-organisations requestBody: content: application/json: schema: $ref: '#/components/schemas/UserRoleCreateRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/UserRoleExpirationTime' description: '' /api/call-managing-organisations/{uuid}/delete_user/: post: operationId: call_managing_organisations_delete_user parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - call-managing-organisations requestBody: content: application/json: schema: $ref: '#/components/schemas/UserRoleDeleteRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/call-managing-organisations/{uuid}/list_users/: get: operationId: call_managing_organisations_list_users_list parameters: - in: query name: field schema: type: array items: type: string enum: - created - created_by_full_name - created_by_uuid - expiration_time - role_name - role_uuid - user_email - user_full_name - user_image - user_username - user_uuid - uuid description: Fields to include in response - in: query name: full_name schema: type: string description: User full name - in: query name: native_name schema: type: string description: User native name - in: query name: o schema: type: array items: type: string enum: - created - email - expiration_time - full_name - native_name - role - username description: Ordering fields - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: role schema: type: string format: uuid description: Role UUID or name - in: query name: search_string schema: type: string description: Search string for user - in: query name: user schema: type: string format: uuid description: User UUID - in: query name: user_slug schema: type: string description: User slug - in: query name: user_url schema: type: string description: User URL - in: query name: username schema: type: string description: User username - in: path name: uuid schema: type: string format: uuid required: true tags: - call-managing-organisations security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/UserRoleDetails' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' /api/call-managing-organisations/{uuid}/stats/: get: operationId: call_managing_organisations_stats_retrieve description: Return statistics for call managing organisation. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - call-managing-organisations security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/CallManagingOrganisationStat' description: '' /api/call-managing-organisations/{uuid}/update_user/: post: operationId: call_managing_organisations_update_user parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - call-managing-organisations requestBody: content: application/json: schema: $ref: '#/components/schemas/UserRoleUpdateRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/UserRoleExpirationTime' description: '' /api/call-proposal-project-role-mappings/: get: operationId: call_proposal_project_role_mappings_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: call_uuid schema: type: string format: uuid - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - call-proposal-project-role-mappings security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/ProposalProjectRoleMapping' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' post: operationId: call_proposal_project_role_mappings_create tags: - call-proposal-project-role-mappings requestBody: content: application/json: schema: $ref: '#/components/schemas/ProposalProjectRoleMappingRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/ProposalProjectRoleMapping' description: '' head: operationId: call_proposal_project_role_mappings_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: call_uuid schema: type: string format: uuid - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - call-proposal-project-role-mappings security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/call-proposal-project-role-mappings/{uuid}/: get: operationId: call_proposal_project_role_mappings_retrieve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - call-proposal-project-role-mappings security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ProposalProjectRoleMapping' description: '' put: operationId: call_proposal_project_role_mappings_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - call-proposal-project-role-mappings requestBody: content: application/json: schema: $ref: '#/components/schemas/ProposalProjectRoleMappingRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ProposalProjectRoleMapping' description: '' patch: operationId: call_proposal_project_role_mappings_partial_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - call-proposal-project-role-mappings requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedProposalProjectRoleMappingRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ProposalProjectRoleMapping' description: '' delete: operationId: call_proposal_project_role_mappings_destroy parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - call-proposal-project-role-mappings security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '204': description: No response body /api/call-rounds/: get: operationId: call_rounds_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - call-rounds security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/CallRound' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' head: operationId: call_rounds_count description: Get number of items in the collection matching the request parameters. parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - call-rounds security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/call-rounds/{uuid}/: get: operationId: call_rounds_retrieve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - call-rounds security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/CallRound' description: '' /api/call-rounds/{uuid}/reviewers/: get: operationId: call_rounds_reviewers_list description: Return list of reviewers for round. parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: path name: uuid schema: type: string format: uuid required: true tags: - call-rounds security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/RoundReviewer' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' /api/celery-stats/: get: operationId: celery_stats_retrieve tags: - celery-stats security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/checklists-admin/: get: operationId: checklists_admin_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - checklists-admin security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/Checklist' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' post: operationId: checklists_admin_create tags: - checklists-admin requestBody: content: application/json: schema: $ref: '#/components/schemas/ChecklistRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/Checklist' description: '' head: operationId: checklists_admin_count description: Get number of items in the collection matching the request parameters. parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - checklists-admin security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/checklists-admin-categories/: get: operationId: checklists_admin_categories_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - checklists-admin-categories security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/ChecklistCategory' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' post: operationId: checklists_admin_categories_create tags: - checklists-admin-categories requestBody: content: application/json: schema: $ref: '#/components/schemas/ChecklistCategoryRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/ChecklistCategory' description: '' head: operationId: checklists_admin_categories_count description: Get number of items in the collection matching the request parameters. parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - checklists-admin-categories security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/checklists-admin-categories/{uuid}/: get: operationId: checklists_admin_categories_retrieve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - checklists-admin-categories security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ChecklistCategory' description: '' put: operationId: checklists_admin_categories_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - checklists-admin-categories requestBody: content: application/json: schema: $ref: '#/components/schemas/ChecklistCategoryRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ChecklistCategory' description: '' patch: operationId: checklists_admin_categories_partial_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - checklists-admin-categories requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedChecklistCategoryRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ChecklistCategory' description: '' delete: operationId: checklists_admin_categories_destroy parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - checklists-admin-categories security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '204': description: No response body /api/checklists-admin-question-dependencies/: get: operationId: checklists_admin_question_dependencies_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: depends_on_question_uuid schema: type: string format: uuid - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: question_uuid schema: type: string format: uuid tags: - checklists-admin-question-dependencies security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/QuestionDependency' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' post: operationId: checklists_admin_question_dependencies_create tags: - checklists-admin-question-dependencies requestBody: content: application/json: schema: $ref: '#/components/schemas/QuestionDependencyRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/QuestionDependency' description: '' head: operationId: checklists_admin_question_dependencies_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: depends_on_question_uuid schema: type: string format: uuid - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: question_uuid schema: type: string format: uuid tags: - checklists-admin-question-dependencies security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/checklists-admin-question-dependencies/{uuid}/: get: operationId: checklists_admin_question_dependencies_retrieve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - checklists-admin-question-dependencies security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/QuestionDependency' description: '' put: operationId: checklists_admin_question_dependencies_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - checklists-admin-question-dependencies requestBody: content: application/json: schema: $ref: '#/components/schemas/QuestionDependencyRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/QuestionDependency' description: '' patch: operationId: checklists_admin_question_dependencies_partial_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - checklists-admin-question-dependencies requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedQuestionDependencyRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/QuestionDependency' description: '' delete: operationId: checklists_admin_question_dependencies_destroy parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - checklists-admin-question-dependencies security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '204': description: No response body /api/checklists-admin-question-options/: get: operationId: checklists_admin_question_options_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: question_uuid schema: type: string format: uuid tags: - checklists-admin-question-options security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/QuestionOptionsAdmin' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' post: operationId: checklists_admin_question_options_create tags: - checklists-admin-question-options requestBody: content: application/json: schema: $ref: '#/components/schemas/QuestionOptionsAdminRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/QuestionOptionsAdmin' description: '' head: operationId: checklists_admin_question_options_count description: Get number of items in the collection matching the request parameters. parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: question_uuid schema: type: string format: uuid tags: - checklists-admin-question-options security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/checklists-admin-question-options/{uuid}/: get: operationId: checklists_admin_question_options_retrieve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - checklists-admin-question-options security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/QuestionOptionsAdmin' description: '' put: operationId: checklists_admin_question_options_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - checklists-admin-question-options requestBody: content: application/json: schema: $ref: '#/components/schemas/QuestionOptionsAdminRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/QuestionOptionsAdmin' description: '' patch: operationId: checklists_admin_question_options_partial_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - checklists-admin-question-options requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedQuestionOptionsAdminRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/QuestionOptionsAdmin' description: '' delete: operationId: checklists_admin_question_options_destroy parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - checklists-admin-question-options security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '204': description: No response body /api/checklists-admin-questions/: get: operationId: checklists_admin_questions_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: checklist_uuid schema: type: string format: uuid - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - checklists-admin-questions security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/QuestionAdmin' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' post: operationId: checklists_admin_questions_create tags: - checklists-admin-questions requestBody: content: application/json: schema: $ref: '#/components/schemas/QuestionAdminRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/QuestionAdmin' description: '' head: operationId: checklists_admin_questions_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: checklist_uuid schema: type: string format: uuid - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - checklists-admin-questions security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/checklists-admin-questions/{uuid}/: get: operationId: checklists_admin_questions_retrieve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - checklists-admin-questions security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/QuestionAdmin' description: '' put: operationId: checklists_admin_questions_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - checklists-admin-questions requestBody: content: application/json: schema: $ref: '#/components/schemas/QuestionAdminRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/QuestionAdmin' description: '' patch: operationId: checklists_admin_questions_partial_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - checklists-admin-questions requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedQuestionAdminRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/QuestionAdmin' description: '' delete: operationId: checklists_admin_questions_destroy parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - checklists-admin-questions security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '204': description: No response body /api/checklists-admin/{uuid}/: get: operationId: checklists_admin_retrieve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - checklists-admin security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Checklist' description: '' put: operationId: checklists_admin_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - checklists-admin requestBody: content: application/json: schema: $ref: '#/components/schemas/ChecklistRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Checklist' description: '' patch: operationId: checklists_admin_partial_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - checklists-admin requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedChecklistRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Checklist' description: '' delete: operationId: checklists_admin_destroy parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - checklists-admin security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '204': description: No response body /api/checklists-admin/{uuid}/questions/: get: operationId: checklists_admin_checklist_questions description: Return checklist questions. parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: path name: uuid schema: type: string format: uuid required: true tags: - checklists-admin security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/QuestionAdmin' description: '' description: '' /api/component-user-usage-limits/: get: operationId: component_user_usage_limits_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: component_type schema: type: string - in: query name: offering_uuid schema: type: string format: uuid - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: resource schema: type: string description: Resource URL - in: query name: resource_uuid schema: type: string format: uuid - in: query name: username schema: type: string tags: - component-user-usage-limits security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/ComponentUserUsageLimit' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' post: operationId: component_user_usage_limits_create tags: - component-user-usage-limits requestBody: content: application/json: schema: $ref: '#/components/schemas/ComponentUserUsageLimitRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/ComponentUserUsageLimit' description: '' head: operationId: component_user_usage_limits_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: component_type schema: type: string - in: query name: offering_uuid schema: type: string format: uuid - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: resource schema: type: string description: Resource URL - in: query name: resource_uuid schema: type: string format: uuid - in: query name: username schema: type: string tags: - component-user-usage-limits security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/component-user-usage-limits/{uuid}/: get: operationId: component_user_usage_limits_retrieve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - component-user-usage-limits security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ComponentUserUsageLimit' description: '' put: operationId: component_user_usage_limits_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - component-user-usage-limits requestBody: content: application/json: schema: $ref: '#/components/schemas/ComponentUserUsageLimitRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ComponentUserUsageLimit' description: '' x-permissions: - permission: RESOURCE.CONSUMPTION_LIMITATION scopes: - resource.project.customer - resource.project patch: operationId: component_user_usage_limits_partial_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - component-user-usage-limits requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedComponentUserUsageLimitRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ComponentUserUsageLimit' description: '' x-permissions: - permission: RESOURCE.CONSUMPTION_LIMITATION scopes: - resource.project.customer - resource.project delete: operationId: component_user_usage_limits_destroy parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - component-user-usage-limits security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '204': description: No response body x-permissions: - permission: RESOURCE.CONSUMPTION_LIMITATION scopes: - resource.project.customer - resource.project /api/configuration/: get: operationId: configuration_retrieve description: Retrieve public settings tags: - configuration security: - tokenAuth: [] - waldurOIDCAuth: [] - {} responses: '200': content: application/json: schema: type: object additionalProperties: {} description: '' /api/customer-credits/: get: operationId: customer_credits_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: customer_name schema: type: string - in: query name: customer_slug schema: type: string - in: query name: customer_uuid schema: type: string format: uuid - in: query name: o schema: type: array items: type: string enum: - -customer_name - -end_date - -expected_consumption - -value - customer_name - end_date - expected_consumption - value description: |+ Ordering explode: false style: form - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - customer-credits security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/CustomerCredit' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' post: operationId: customer_credits_create tags: - customer-credits requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateCustomerCreditRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/CreateCustomerCredit' description: '' head: operationId: customer_credits_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: customer_name schema: type: string - in: query name: customer_slug schema: type: string - in: query name: customer_uuid schema: type: string format: uuid - in: query name: o schema: type: array items: type: string enum: - -customer_name - -end_date - -expected_consumption - -value - customer_name - end_date - expected_consumption - value description: |+ Ordering explode: false style: form - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - customer-credits security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/customer-credits/{uuid}/: get: operationId: customer_credits_retrieve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - customer-credits security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/CustomerCredit' description: '' put: operationId: customer_credits_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - customer-credits requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateCustomerCreditRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/CreateCustomerCredit' description: '' patch: operationId: customer_credits_partial_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - customer-credits requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedCreateCustomerCreditRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/CreateCustomerCredit' description: '' delete: operationId: customer_credits_destroy parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - customer-credits security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '204': description: No response body /api/customer-credits/{uuid}/apply_compensations/: post: operationId: customer_credits_apply_compensations parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - customer-credits requestBody: content: application/json: schema: $ref: '#/components/schemas/CustomerCreditRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/CustomerCredit' description: '' /api/customer-credits/{uuid}/clear_compensations/: post: operationId: customer_credits_clear_compensations parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - customer-credits requestBody: content: application/json: schema: $ref: '#/components/schemas/CustomerCreditRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/CustomerCredit' description: '' /api/customer-credits/{uuid}/consumptions/: get: operationId: customer_credits_consumptions_list description: Get credit consumption history grouped by month. parameters: - in: query name: customer_name schema: type: string - in: query name: customer_slug schema: type: string - in: query name: customer_uuid schema: type: string format: uuid - in: query name: o schema: type: array items: type: string enum: - -customer_name - -end_date - -expected_consumption - -value - customer_name - end_date - expected_consumption - value description: |+ Ordering explode: false style: form - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: path name: uuid schema: type: string format: uuid required: true tags: - customer-credits security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/CustomerCreditConsumption' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' /api/customer-permissions-reviews/: get: operationId: customer_permissions_reviews_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: closed schema: type: string format: date-time - in: query name: customer_uuid schema: type: string format: uuid description: Customer UUID - in: query name: is_pending schema: type: boolean description: Is pending - in: query name: o schema: type: array items: type: string enum: - -closed - -created - closed - created description: |+ Ordering explode: false style: form - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: reviewer_uuid schema: type: string format: uuid description: Reviewer UUID tags: - customer-permissions-reviews security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/CustomerPermissionReview' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' head: operationId: customer_permissions_reviews_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: closed schema: type: string format: date-time - in: query name: customer_uuid schema: type: string format: uuid description: Customer UUID - in: query name: is_pending schema: type: boolean description: Is pending - in: query name: o schema: type: array items: type: string enum: - -closed - -created - closed - created description: |+ Ordering explode: false style: form - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: reviewer_uuid schema: type: string format: uuid description: Reviewer UUID tags: - customer-permissions-reviews security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/customer-permissions-reviews/{uuid}/: get: operationId: customer_permissions_reviews_retrieve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - customer-permissions-reviews security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/CustomerPermissionReview' description: '' /api/customer-permissions-reviews/{uuid}/close/: post: operationId: customer_permissions_reviews_close description: Close customer permission review. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - customer-permissions-reviews security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/customer-quotas/: get: operationId: customer_quotas_list description: List customer quotas. parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - customer-quotas security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/CustomerQuotas' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' head: operationId: customer_quotas_count description: Get number of items in the collection matching the request parameters. parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - customer-quotas security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/customers/: get: operationId: customers_list description: |- To get a list of customers, run GET against /api/customers/ as authenticated user. Note that a user can only see connected customers: - customers that the user owns - customers that have a project where user has a role Staff also can filter customers by user UUID, for example /api/customers/?user_uuid= Staff also can filter customers by exists accounting_start_date, for example: The first category: /api/customers/?accounting_is_running=True has accounting_start_date empty (i.e. accounting starts at once) has accounting_start_date in the past (i.e. has already started). Those that are not in the first: /api/customers/?accounting_is_running=False # exists accounting_start_date parameters: - in: query name: abbreviation schema: type: string - in: query name: agreement_number schema: type: string - in: query name: archived schema: type: boolean - in: query name: backend_id schema: type: string - in: query name: contact_details schema: type: string - in: query name: field schema: type: array items: type: string enum: - abbreviation - access_subnets - accounting_start_date - address - agreement_number - archived - backend_id - bank_account - bank_name - billing_price_estimate - blocked - call_managing_organization_uuid - contact_details - country - country_name - created - customer_credit - customer_unallocated_credit - default_tax_percent - description - display_name - domain - email - homepage - image - is_service_provider - latitude - longitude - max_service_accounts - name - native_name - organization_groups - payment_profiles - phone_number - postal - project_metadata_checklist - projects - projects_count - registration_code - service_provider - service_provider_uuid - slug - sponsor_number - url - users_count - uuid - vat_code - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - in: query name: native_name schema: type: string - name: o required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: organization_group_name schema: type: string - in: query name: organization_group_uuid schema: type: array items: type: string format: uuid description: organization_group_uuid explode: true style: form - in: query name: owned_by_current_user schema: type: boolean description: Return a list of customers where current user is owner. - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: query schema: type: string description: Filter by name, native name, abbreviation, domain, UUID, registration code or agreement number - in: query name: registration_code schema: type: string tags: - customers security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/Customer' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' post: operationId: customers_create description: A new customer can only be created by users with staff privilege tags: - customers requestBody: content: application/json: schema: $ref: '#/components/schemas/CustomerRequest' examples: CreateCustomer: value: name: Customer A native_name: Customer A abbreviation: CA contact_details: Luhamaa 28, 10128 Tallinn summary: Create customer required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/Customer' description: '' head: operationId: customers_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: abbreviation schema: type: string - in: query name: agreement_number schema: type: string - in: query name: archived schema: type: boolean - in: query name: backend_id schema: type: string - in: query name: contact_details schema: type: string - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - in: query name: native_name schema: type: string - name: o required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: organization_group_name schema: type: string - in: query name: organization_group_uuid schema: type: array items: type: string format: uuid description: organization_group_uuid explode: true style: form - in: query name: owned_by_current_user schema: type: boolean description: Return a list of customers where current user is owner. - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: query schema: type: string description: Filter by name, native name, abbreviation, domain, UUID, registration code or agreement number - in: query name: registration_code schema: type: string tags: - customers security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/customers/{customer_uuid}/project-metadata-compliance-details/: get: operationId: customers_project_metadata_compliance_details_list description: Get detailed project compliance information with database-level pagination. parameters: - in: path name: customer_uuid schema: type: string format: uuid description: UUID of the customer required: true - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - customers security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/ProjectDetailsResponse' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' /api/customers/{customer_uuid}/project-metadata-compliance-overview/: get: operationId: customers_project_metadata_compliance_overview_list description: Get compliance overview statistics for all projects. parameters: - in: path name: customer_uuid schema: type: string format: uuid description: UUID of the customer required: true - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - customers security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/ComplianceOverview' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' /api/customers/{customer_uuid}/project-metadata-compliance-projects/: get: operationId: customers_project_metadata_compliance_projects_list description: List project checklist answer data with database-level pagination. parameters: - in: path name: customer_uuid schema: type: string format: uuid description: UUID of the customer required: true - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - customers security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/ProjectAnswer' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' /api/customers/{customer_uuid}/project-metadata-question-answers/: get: operationId: customers_project_metadata_question_answers_list description: List questions with project answers, paginated by question at database level. parameters: - in: path name: customer_uuid schema: type: string format: uuid description: UUID of the customer required: true - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - customers security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/QuestionAnswer' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' /api/customers/{customer_uuid}/users/: get: operationId: customers_users_list description: A list of users connected to the customer. parameters: - in: query name: agreement_date schema: type: string format: date-time description: Agreement date after - in: query name: civil_number schema: type: string - in: path name: customer_uuid schema: type: string format: uuid description: UUID of the customer required: true - in: query name: date_joined schema: type: string format: date-time description: Date joined after - in: query name: description schema: type: string - in: query name: email schema: type: string - in: query name: field schema: type: array items: type: string enum: - email - expiration_time - full_name - image - projects - role_name - url - username - uuid - in: query name: full_name schema: type: string description: Full name - in: query name: is_active schema: type: boolean - in: query name: job_title schema: type: string - in: query name: modified schema: type: string format: date-time description: Date modified after - in: query name: native_name schema: type: string - in: query name: o schema: type: string enum: - concatenated_name - -concatenated_name description: Ordering. Sort by a combination of first name, last name, and username. - in: query name: organization schema: type: string - in: query name: organization_role schema: type: array items: anyOf: - type: string enum: - CUSTOMER.MANAGER - CUSTOMER.OWNER - CUSTOMER.SUPPORT - type: string description: Filter by one or more organization roles. Select a standard role or provide a custom role string. Can be specified multiple times. - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: phone_number schema: type: string - in: query name: project_role schema: type: array items: anyOf: - type: string enum: - PROJECT.ADMIN - PROJECT.MANAGER - PROJECT.MEMBER - type: string description: Filter by one or more project roles. Select a standard role or provide a custom role string. Can be specified multiple times. - in: query name: registration_method schema: type: string - in: query name: user_keyword schema: type: string description: User keyword - in: query name: username schema: type: string tags: - customers security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/CustomerUser' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' /api/customers/{uuid}/: get: operationId: customers_retrieve parameters: - in: query name: field schema: type: array items: type: string enum: - abbreviation - access_subnets - accounting_start_date - address - agreement_number - archived - backend_id - bank_account - bank_name - billing_price_estimate - blocked - call_managing_organization_uuid - contact_details - country - country_name - created - customer_credit - customer_unallocated_credit - default_tax_percent - description - display_name - domain - email - homepage - image - is_service_provider - latitude - longitude - max_service_accounts - name - native_name - organization_groups - payment_profiles - phone_number - postal - project_metadata_checklist - projects - projects_count - registration_code - service_provider - service_provider_uuid - slug - sponsor_number - url - users_count - uuid - vat_code - in: path name: uuid schema: type: string format: uuid required: true tags: - customers security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Customer' description: '' put: operationId: customers_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - customers requestBody: content: application/json: schema: $ref: '#/components/schemas/CustomerRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Customer' description: '' patch: operationId: customers_partial_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - customers requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedCustomerRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Customer' description: '' delete: operationId: customers_destroy description: If a customer has connected projects, deletion request will fail with 409 response code. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - customers security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '204': description: No response body /api/customers/{uuid}/add_user/: post: operationId: customers_add_user parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - customers requestBody: content: application/json: schema: $ref: '#/components/schemas/UserRoleCreateRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/UserRoleExpirationTime' description: '' /api/customers/{uuid}/delete_user/: post: operationId: customers_delete_user parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - customers requestBody: content: application/json: schema: $ref: '#/components/schemas/UserRoleDeleteRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/customers/{uuid}/list_users/: get: operationId: customers_list_users_list parameters: - in: query name: field schema: type: array items: type: string enum: - created - created_by_full_name - created_by_uuid - expiration_time - role_name - role_uuid - user_email - user_full_name - user_image - user_username - user_uuid - uuid description: Fields to include in response - in: query name: full_name schema: type: string description: User full name - in: query name: native_name schema: type: string description: User native name - in: query name: o schema: type: array items: type: string enum: - created - email - expiration_time - full_name - native_name - role - username description: Ordering fields - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: role schema: type: string format: uuid description: Role UUID or name - in: query name: search_string schema: type: string description: Search string for user - in: query name: user schema: type: string format: uuid description: User UUID - in: query name: user_slug schema: type: string description: User slug - in: query name: user_url schema: type: string description: User URL - in: query name: username schema: type: string description: User username - in: path name: uuid schema: type: string format: uuid required: true tags: - customers security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/UserRoleDetails' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' /api/customers/{uuid}/stats/: get: operationId: customers_stats_retrieve description: Return statistics about customer resources usage parameters: - in: query name: for_current_month schema: type: boolean - in: path name: uuid schema: type: string format: uuid required: true tags: - customers security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ComponentsUsageStats' description: '' /api/customers/{uuid}/update_organization_groups/: post: operationId: customers_update_organization_groups description: Update organization groups for customer parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - customers requestBody: content: application/json: schema: $ref: '#/components/schemas/OrganizationGroupsRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/customers/{uuid}/update_user/: post: operationId: customers_update_user parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - customers requestBody: content: application/json: schema: $ref: '#/components/schemas/UserRoleUpdateRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/UserRoleExpirationTime' description: '' /api/customers/countries/: get: operationId: customers_countries_list description: Return list of countries parameters: - in: query name: abbreviation schema: type: string - in: query name: agreement_number schema: type: string - in: query name: archived schema: type: boolean - in: query name: backend_id schema: type: string - in: query name: contact_details schema: type: string - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - in: query name: native_name schema: type: string - name: o required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: organization_group_name schema: type: string - in: query name: organization_group_uuid schema: type: array items: type: string format: uuid description: organization_group_uuid explode: true style: form - in: query name: owned_by_current_user schema: type: boolean description: Return a list of customers where current user is owner. - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: query schema: type: string description: Filter by name, native name, abbreviation, domain, UUID, registration code or agreement number - in: query name: registration_code schema: type: string tags: - customers security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/Country' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' head: operationId: customers_countries_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: abbreviation schema: type: string - in: query name: agreement_number schema: type: string - in: query name: archived schema: type: boolean - in: query name: backend_id schema: type: string - in: query name: contact_details schema: type: string - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - in: query name: native_name schema: type: string - name: o required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: organization_group_name schema: type: string - in: query name: organization_group_uuid schema: type: array items: type: string format: uuid description: organization_group_uuid explode: true style: form - in: query name: owned_by_current_user schema: type: boolean description: Return a list of customers where current user is owner. - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: query schema: type: string description: Filter by name, native name, abbreviation, domain, UUID, registration code or agreement number - in: query name: registration_code schema: type: string tags: - customers security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/daily-quotas/: get: operationId: daily_quotas_retrieve parameters: - in: query name: end schema: type: string format: date description: End date in format YYYY-MM-DD - in: query name: quota_names schema: type: array items: type: string description: List of quota names - in: query name: scope schema: type: string format: uuid description: UUID of the scope object - in: query name: start schema: type: string format: date description: Start date in format YYYY-MM-DD tags: - daily-quotas security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: object additionalProperties: type: array items: type: integer description: '' /api/database-stats/: get: operationId: database_stats_list tags: - database-stats security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/TableSize' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' /api/digitalocean-droplets/: get: operationId: digitalocean_droplets_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: backend_id schema: type: string - in: query name: can_manage schema: type: boolean description: Can manage - in: query name: customer schema: type: string format: uuid - in: query name: customer_abbreviation schema: type: string - in: query name: customer_name schema: type: string - in: query name: customer_native_name schema: type: string - in: query name: customer_uuid schema: type: string format: uuid - in: query name: description schema: type: string - in: query name: external_ip schema: type: string - in: query name: field schema: type: array items: type: string enum: - access_url - backend_id - cores - created - customer - customer_abbreviation - customer_name - customer_native_name - description - disk - error_message - error_traceback - external_ips - image - image_name - internal_ips - is_limit_based - is_usage_based - key_fingerprint - key_name - latitude - longitude - marketplace_category_name - marketplace_category_uuid - marketplace_offering_name - marketplace_offering_plugin_options - marketplace_offering_uuid - marketplace_plan_uuid - marketplace_resource_state - marketplace_resource_uuid - min_disk - min_ram - modified - name - project - project_name - project_uuid - ram - region - region_name - resource_type - runtime_state - service_name - service_settings - service_settings_error_message - service_settings_state - service_settings_uuid - size - ssh_public_key - start_time - state - url - user_data - uuid - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: project schema: type: string format: uuid - in: query name: project_name schema: type: string - in: query name: project_uuid schema: type: string format: uuid - in: query name: service_settings_name schema: type: string - in: query name: service_settings_uuid schema: type: string format: uuid - in: query name: state schema: type: array items: type: string enum: - CREATING - CREATION_SCHEDULED - DELETING - DELETION_SCHEDULED - ERRED - OK - UPDATE_SCHEDULED - UPDATING explode: true style: form - in: query name: uuid schema: type: string format: uuid tags: - digitalocean-droplets security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/DigitalOceanDroplet' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' post: operationId: digitalocean_droplets_create tags: - digitalocean-droplets requestBody: content: application/json: schema: $ref: '#/components/schemas/DigitalOceanDropletRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/DigitalOceanDroplet' description: '' head: operationId: digitalocean_droplets_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: backend_id schema: type: string - in: query name: can_manage schema: type: boolean description: Can manage - in: query name: customer schema: type: string format: uuid - in: query name: customer_abbreviation schema: type: string - in: query name: customer_name schema: type: string - in: query name: customer_native_name schema: type: string - in: query name: customer_uuid schema: type: string format: uuid - in: query name: description schema: type: string - in: query name: external_ip schema: type: string - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: project schema: type: string format: uuid - in: query name: project_name schema: type: string - in: query name: project_uuid schema: type: string format: uuid - in: query name: service_settings_name schema: type: string - in: query name: service_settings_uuid schema: type: string format: uuid - in: query name: state schema: type: array items: type: string enum: - CREATING - CREATION_SCHEDULED - DELETING - DELETION_SCHEDULED - ERRED - OK - UPDATE_SCHEDULED - UPDATING explode: true style: form - in: query name: uuid schema: type: string format: uuid tags: - digitalocean-droplets security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/digitalocean-droplets/{uuid}/: get: operationId: digitalocean_droplets_retrieve parameters: - in: query name: field schema: type: array items: type: string enum: - access_url - backend_id - cores - created - customer - customer_abbreviation - customer_name - customer_native_name - description - disk - error_message - error_traceback - external_ips - image - image_name - internal_ips - is_limit_based - is_usage_based - key_fingerprint - key_name - latitude - longitude - marketplace_category_name - marketplace_category_uuid - marketplace_offering_name - marketplace_offering_plugin_options - marketplace_offering_uuid - marketplace_plan_uuid - marketplace_resource_state - marketplace_resource_uuid - min_disk - min_ram - modified - name - project - project_name - project_uuid - ram - region - region_name - resource_type - runtime_state - service_name - service_settings - service_settings_error_message - service_settings_state - service_settings_uuid - size - ssh_public_key - start_time - state - url - user_data - uuid - in: path name: uuid schema: type: string format: uuid required: true tags: - digitalocean-droplets security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/DigitalOceanDroplet' description: '' put: operationId: digitalocean_droplets_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - digitalocean-droplets requestBody: content: application/json: schema: $ref: '#/components/schemas/DigitalOceanDropletRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/DigitalOceanDroplet' description: '' patch: operationId: digitalocean_droplets_partial_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - digitalocean-droplets requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedDigitalOceanDropletRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/DigitalOceanDroplet' description: '' delete: operationId: digitalocean_droplets_destroy parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - digitalocean-droplets security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '204': description: No response body /api/digitalocean-droplets/{uuid}/pull/: post: operationId: digitalocean_droplets_pull parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - digitalocean-droplets security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/digitalocean-droplets/{uuid}/resize/: post: operationId: digitalocean_droplets_resize description: |- To resize droplet, submit a POST request to the instance URL, specifying URI of a target size. Pass {'disk': true} along with target size in order to perform permanent resizing, which allows you to resize your disk space as well as CPU and RAM. After increasing the disk size, you will not be able to decrease it. Pass {'disk': false} along with target size in order to perform flexible resizing, which only upgrades your CPU and RAM. This option is reversible. Note that instance must be OFFLINE. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - digitalocean-droplets requestBody: content: application/json: schema: $ref: '#/components/schemas/DigitalOceanDropletResizeRequest' examples: Digitalocean-droplet-resize: value: size: http://example.com/api/digitalocean-sizes/1ee385bc043249498cfeb8c7e3e079f0/ summary: digitalocean-droplet-resize required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/DigitalOceanDropletResize' description: '' /api/digitalocean-droplets/{uuid}/restart/: post: operationId: digitalocean_droplets_restart parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - digitalocean-droplets security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/digitalocean-droplets/{uuid}/start/: post: operationId: digitalocean_droplets_start parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - digitalocean-droplets security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/digitalocean-droplets/{uuid}/stop/: post: operationId: digitalocean_droplets_stop parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - digitalocean-droplets security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/digitalocean-droplets/{uuid}/unlink/: post: operationId: digitalocean_droplets_unlink description: |- Delete resource from the database without scheduling operations on backend and without checking current state of the resource. It is intended to be used for removing resource stuck in transitioning state. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - digitalocean-droplets security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/digitalocean-images/: get: operationId: digitalocean_images_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: distribution schema: type: string - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - in: query name: o schema: type: array items: type: string enum: - -distribution - -type - distribution - type description: |+ Ordering explode: false style: form - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: type schema: type: string tags: - digitalocean-images security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/DigitalOceanImage' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' head: operationId: digitalocean_images_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: distribution schema: type: string - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - in: query name: o schema: type: array items: type: string enum: - -distribution - -type - distribution - type description: |+ Ordering explode: false style: form - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: type schema: type: string tags: - digitalocean-images security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/digitalocean-images/{uuid}/: get: operationId: digitalocean_images_retrieve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - digitalocean-images security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/DigitalOceanImage' description: '' /api/digitalocean-regions/: get: operationId: digitalocean_regions_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - digitalocean-regions security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/DigitalOceanRegion' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' head: operationId: digitalocean_regions_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - digitalocean-regions security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/digitalocean-regions/{uuid}/: get: operationId: digitalocean_regions_retrieve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - digitalocean-regions security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/DigitalOceanRegion' description: '' /api/digitalocean-sizes/: get: operationId: digitalocean_sizes_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: cores schema: type: integer - in: query name: disk schema: type: integer - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: ram schema: type: integer tags: - digitalocean-sizes security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/DigitalOceanSize' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' head: operationId: digitalocean_sizes_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: cores schema: type: integer - in: query name: disk schema: type: integer - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: ram schema: type: integer tags: - digitalocean-sizes security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/digitalocean-sizes/{uuid}/: get: operationId: digitalocean_sizes_retrieve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - digitalocean-sizes security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/DigitalOceanSize' description: '' /api/email-logs/: get: operationId: email_logs_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: body schema: type: string - in: query name: emails schema: type: string - in: query name: o schema: type: array items: type: string enum: - -sent_at - -subject - sent_at - subject description: |+ Ordering explode: false style: form - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: sent_at schema: type: string format: date - in: query name: subject schema: type: string tags: - email-logs security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/EmailLog' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' head: operationId: email_logs_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: body schema: type: string - in: query name: emails schema: type: string - in: query name: o schema: type: array items: type: string enum: - -sent_at - -subject - sent_at - subject description: |+ Ordering explode: false style: form - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: sent_at schema: type: string format: date - in: query name: subject schema: type: string tags: - email-logs security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/email-logs/{uuid}/: get: operationId: email_logs_retrieve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - email-logs security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/EmailLog' description: '' /api/event-subscriptions/: get: operationId: event_subscriptions_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: o schema: type: array items: type: string enum: - -created - created description: |+ Ordering explode: false style: form - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: user_username schema: type: string - in: query name: user_uuid schema: type: string tags: - event-subscriptions security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/EventSubscription' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' post: operationId: event_subscriptions_create tags: - event-subscriptions requestBody: content: application/json: schema: $ref: '#/components/schemas/EventSubscriptionRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/EventSubscription' description: '' head: operationId: event_subscriptions_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: o schema: type: array items: type: string enum: - -created - created description: |+ Ordering explode: false style: form - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: user_username schema: type: string - in: query name: user_uuid schema: type: string tags: - event-subscriptions security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/event-subscriptions/{uuid}/: get: operationId: event_subscriptions_retrieve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - event-subscriptions security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/EventSubscription' description: '' delete: operationId: event_subscriptions_destroy parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - event-subscriptions security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '204': description: No response body /api/events/: get: operationId: events_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: created_from schema: type: number - in: query name: created_to schema: type: number - in: query name: customer_uuid schema: type: string format: uuid description: Customer UUID - in: query name: field schema: type: array items: type: string enum: - context - created - event_type - message - uuid - in: query name: message schema: type: string - in: query name: o schema: type: array items: type: string enum: - -created - created description: |+ Ordering explode: false style: form - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: project_uuid schema: type: string format: uuid description: Project UUID - in: query name: user_uuid schema: type: string format: uuid description: User UUID tags: - events security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/Event' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' head: operationId: events_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: created_from schema: type: number - in: query name: created_to schema: type: number - in: query name: customer_uuid schema: type: string format: uuid description: Customer UUID - in: query name: message schema: type: string - in: query name: o schema: type: array items: type: string enum: - -created - created description: |+ Ordering explode: false style: form - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: project_uuid schema: type: string format: uuid description: Project UUID - in: query name: user_uuid schema: type: string format: uuid description: User UUID tags: - events security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/events-stats/: get: operationId: events_stats_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - events-stats security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/EventStats' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' head: operationId: events_stats_count description: Get number of items in the collection matching the request parameters. parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - events-stats security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/events/{id}/: get: operationId: events_retrieve parameters: - in: query name: field schema: type: array items: type: string enum: - context - created - event_type - message - uuid - in: path name: id schema: type: integer description: A unique integer value identifying this event. required: true tags: - events security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Event' description: '' /api/events/count/: get: operationId: events_count_retrieve parameters: - in: query name: field schema: type: array items: type: string enum: - context - created - event_type - message - uuid tags: - events security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Event' examples: ValidExample: value: count: 12321 summary: Valid example description: '' head: operationId: events_count_count tags: - events security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body description: Get number of items in the collection matching the request parameters. /api/events/event_groups/: get: operationId: events_event_groups_retrieve description: |- Returns a list of groups with event types. Group is used in exclude_features query param. parameters: - in: query name: field schema: type: array items: type: string enum: - context - created - event_type - message - uuid tags: - events security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Event' description: '' head: operationId: events_event_groups_count description: Get number of items in the collection matching the request parameters. tags: - events security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/events/scope_types/: get: operationId: events_scope_types_retrieve description: Returns a list of scope types acceptable by events filter. parameters: - in: query name: field schema: type: array items: type: string enum: - context - created - event_type - message - uuid tags: - events security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Event' description: '' head: operationId: events_scope_types_count description: Get number of items in the collection matching the request parameters. tags: - events security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/external-links/: get: operationId: external_links_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - name: o required: false in: query description: Which field to use when ordering the results. schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: query schema: type: string description: Filter by name, link or description tags: - external-links security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/ExternalLink' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' post: operationId: external_links_create tags: - external-links requestBody: content: application/json: schema: $ref: '#/components/schemas/ExternalLinkRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/ExternalLink' description: '' head: operationId: external_links_count description: Get number of items in the collection matching the request parameters. parameters: - name: o required: false in: query description: Which field to use when ordering the results. schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: query schema: type: string description: Filter by name, link or description tags: - external-links security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/external-links/{uuid}/: get: operationId: external_links_retrieve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - external-links security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ExternalLink' description: '' put: operationId: external_links_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - external-links requestBody: content: application/json: schema: $ref: '#/components/schemas/ExternalLinkRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ExternalLink' description: '' patch: operationId: external_links_partial_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - external-links requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedExternalLinkRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ExternalLink' description: '' delete: operationId: external_links_destroy parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - external-links security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '204': description: No response body /api/feature-values/: post: operationId: feature_values description: Override feature values tags: - feature-values requestBody: content: application/json: schema: type: object additionalProperties: {} security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: string description: '' /api/financial-reports/: get: operationId: financial_reports_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: abbreviation schema: type: string - in: query name: agreement_number schema: type: string - in: query name: archived schema: type: boolean - in: query name: backend_id schema: type: string - in: query name: contact_details schema: type: string - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - in: query name: native_name schema: type: string - name: o required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: organization_group_name schema: type: string - in: query name: organization_group_uuid schema: type: array items: type: string format: uuid description: organization_group_uuid explode: true style: form - in: query name: owned_by_current_user schema: type: boolean description: Return a list of customers where current user is owner. - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: query schema: type: string description: Filter by name, native name, abbreviation, domain, UUID, registration code or agreement number - in: query name: registration_code schema: type: string tags: - financial-reports security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/FinancialReport' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' head: operationId: financial_reports_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: abbreviation schema: type: string - in: query name: agreement_number schema: type: string - in: query name: archived schema: type: boolean - in: query name: backend_id schema: type: string - in: query name: contact_details schema: type: string - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - in: query name: native_name schema: type: string - name: o required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: organization_group_name schema: type: string - in: query name: organization_group_uuid schema: type: array items: type: string format: uuid description: organization_group_uuid explode: true style: form - in: query name: owned_by_current_user schema: type: boolean description: Return a list of customers where current user is owner. - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: query schema: type: string description: Filter by name, native name, abbreviation, domain, UUID, registration code or agreement number - in: query name: registration_code schema: type: string tags: - financial-reports security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/financial-reports/{uuid}/: get: operationId: financial_reports_retrieve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - financial-reports security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/FinancialReport' description: '' /api/freeipa-profiles/: get: operationId: freeipa_profiles_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: query schema: type: string description: Filter by username, user UUID, first name or last name - in: query name: user schema: type: string format: uuid tags: - freeipa-profiles security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/FreeipaProfile' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' post: operationId: freeipa_profiles_create tags: - freeipa-profiles requestBody: content: application/json: schema: $ref: '#/components/schemas/FreeipaProfileRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/FreeipaProfile' description: '' head: operationId: freeipa_profiles_count description: Get number of items in the collection matching the request parameters. parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: query schema: type: string description: Filter by username, user UUID, first name or last name - in: query name: user schema: type: string format: uuid tags: - freeipa-profiles security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/freeipa-profiles/{uuid}/: get: operationId: freeipa_profiles_retrieve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - freeipa-profiles security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/FreeipaProfile' description: '' put: operationId: freeipa_profiles_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - freeipa-profiles requestBody: content: application/json: schema: $ref: '#/components/schemas/FreeipaProfileRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/FreeipaProfile' description: '' patch: operationId: freeipa_profiles_partial_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - freeipa-profiles security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/FreeipaProfile' description: '' /api/freeipa-profiles/{uuid}/update_ssh_keys/: post: operationId: freeipa_profiles_update_ssh_keys description: Update SSH keys for profile. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - freeipa-profiles security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/google-auth/: get: operationId: google_auth_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: field schema: type: array items: type: string enum: - calendar_refresh_token - calendar_token - created - customer - customer_abbreviation - customer_country - customer_image - customer_name - customer_native_name - customer_slug - customer_uuid - description - enable_notifications - google_auth_url - image - offering_count - organization_groups - url - uuid - in: query name: has_credentials schema: type: boolean description: has_credentials - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - google-auth security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/GoogleCredentials' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' head: operationId: google_auth_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: has_credentials schema: type: boolean description: has_credentials - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - google-auth security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/google-auth/{uuid}/: get: operationId: google_auth_retrieve parameters: - in: query name: field schema: type: array items: type: string enum: - calendar_refresh_token - calendar_token - created - customer - customer_abbreviation - customer_country - customer_image - customer_name - customer_native_name - customer_slug - customer_uuid - description - enable_notifications - google_auth_url - image - offering_count - organization_groups - url - uuid - in: path name: uuid schema: type: string format: uuid required: true tags: - google-auth security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/GoogleCredentials' description: '' /api/google-auth/{uuid}/authorize/: get: operationId: google_auth_authorize_retrieve parameters: - in: query name: field schema: type: array items: type: string enum: - calendar_refresh_token - calendar_token - created - customer - customer_abbreviation - customer_country - customer_image - customer_name - customer_native_name - customer_slug - customer_uuid - description - enable_notifications - google_auth_url - image - offering_count - organization_groups - url - uuid - in: path name: uuid schema: type: string format: uuid required: true tags: - google-auth security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/GoogleCredentials' description: '' /api/google-auth/callback/: get: operationId: google_auth_callback_retrieve description: Callback endpoint for Google authorization. parameters: - in: query name: code schema: type: string description: Authorization code required: true - in: query name: state schema: type: string description: Service provider UUID required: true tags: - google-auth security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body head: operationId: google_auth_callback_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: code schema: type: string description: Authorization code required: true - in: query name: state schema: type: string description: Service provider UUID required: true tags: - google-auth security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/hooks/: get: operationId: hooks_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - hooks security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body head: operationId: hooks_count description: Get number of items in the collection matching the request parameters. parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - hooks security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/hooks-email/: get: operationId: hooks_email_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: author_email schema: type: string - in: query name: author_fullname schema: type: string description: User full name contains - in: query name: author_username schema: type: string - in: query name: author_uuid schema: type: string format: uuid - in: query name: email schema: type: string - in: query name: is_active schema: type: boolean - in: query name: last_published schema: type: string format: date-time - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: query schema: type: string description: Filter by author name, username and email tags: - hooks-email security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/EmailHook' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' post: operationId: hooks_email_create tags: - hooks-email requestBody: content: application/json: schema: $ref: '#/components/schemas/EmailHookRequest' examples: Email-hook-create: value: event_types: - openstack_instance_start_succeeded event_groups: - users email: test@example.com summary: email-hook-create description: You should specify list of event_types or event_groups. required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/EmailHook' description: '' head: operationId: hooks_email_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: author_email schema: type: string - in: query name: author_fullname schema: type: string description: User full name contains - in: query name: author_username schema: type: string - in: query name: author_uuid schema: type: string format: uuid - in: query name: email schema: type: string - in: query name: is_active schema: type: boolean - in: query name: last_published schema: type: string format: date-time - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: query schema: type: string description: Filter by author name, username and email tags: - hooks-email security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/hooks-email/{uuid}/: get: operationId: hooks_email_retrieve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - hooks-email security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/EmailHook' description: '' put: operationId: hooks_email_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - hooks-email requestBody: content: application/json: schema: $ref: '#/components/schemas/EmailHookRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/EmailHook' description: '' patch: operationId: hooks_email_partial_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - hooks-email requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedEmailHookRequest' examples: Email-hook-update: value: is_active: 'false' summary: email-hook-update description: temporarily disable hook without deleting it. security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/EmailHook' description: '' delete: operationId: hooks_email_destroy parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - hooks-email security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '204': description: No response body /api/hooks-web/: get: operationId: hooks_web_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: author_email schema: type: string - in: query name: author_fullname schema: type: string description: User full name contains - in: query name: author_username schema: type: string - in: query name: author_uuid schema: type: string format: uuid - in: query name: content_type schema: type: integer enum: - 1 - 2 - in: query name: destination_url schema: type: string - in: query name: is_active schema: type: boolean - in: query name: last_published schema: type: string format: date-time - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: query schema: type: string description: Filter by author name, username and email tags: - hooks-web security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/WebHook' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' post: operationId: hooks_web_create description: |- When hook is activated, POST request is issued against destination URL with the following data: .. code-block:: javascript { "timestamp": "2015-07-14T12:12:56.000000", "message": "Customer ABC LLC has been updated.", "type": "customer_update_succeeded", "context": { "user_native_name": "Walter Lebrowski", "customer_contact_details": "", "user_username": "Walter", "user_uuid": "1c3323fc4ae44120b57ec40dea1be6e6", "customer_uuid": "4633bbbb0b3a4b91bffc0e18f853de85", "ip_address": "8.8.8.8", "user_full_name": "Walter Lebrowski", "customer_abbreviation": "ABC LLC", "customer_name": "ABC LLC" }, "levelname": "INFO" } Note that context depends on event type. tags: - hooks-web requestBody: content: application/json: schema: $ref: '#/components/schemas/WebHookRequest' examples: Webhook-create: value: event_types: - customer_update_succeeded event_groups: - users destination_url: http://example.com/ summary: webhook-create description: You should specify list of event_types or event_groups. required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/WebHook' description: '' head: operationId: hooks_web_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: author_email schema: type: string - in: query name: author_fullname schema: type: string description: User full name contains - in: query name: author_username schema: type: string - in: query name: author_uuid schema: type: string format: uuid - in: query name: content_type schema: type: integer enum: - 1 - 2 - in: query name: destination_url schema: type: string - in: query name: is_active schema: type: boolean - in: query name: last_published schema: type: string format: date-time - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: query schema: type: string description: Filter by author name, username and email tags: - hooks-web security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/hooks-web/{uuid}/: get: operationId: hooks_web_retrieve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - hooks-web security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/WebHook' description: '' put: operationId: hooks_web_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - hooks-web requestBody: content: application/json: schema: $ref: '#/components/schemas/WebHookRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/WebHook' description: '' patch: operationId: hooks_web_partial_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - hooks-web requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWebHookRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/WebHook' description: '' delete: operationId: hooks_web_destroy parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - hooks-web security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '204': description: No response body /api/identity-providers/: get: operationId: identity_providers_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - identity-providers security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/IdentityProvider' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' post: operationId: identity_providers_create tags: - identity-providers requestBody: content: application/json: schema: $ref: '#/components/schemas/IdentityProviderRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/IdentityProvider' description: '' head: operationId: identity_providers_count description: Get number of items in the collection matching the request parameters. parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - identity-providers security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/identity-providers/{provider}/: get: operationId: identity_providers_retrieve parameters: - in: path name: provider schema: type: string required: true tags: - identity-providers security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/IdentityProvider' description: '' put: operationId: identity_providers_update parameters: - in: path name: provider schema: type: string required: true tags: - identity-providers requestBody: content: application/json: schema: $ref: '#/components/schemas/IdentityProviderRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/IdentityProvider' description: '' patch: operationId: identity_providers_partial_update parameters: - in: path name: provider schema: type: string required: true tags: - identity-providers requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedIdentityProviderRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/IdentityProvider' description: '' delete: operationId: identity_providers_destroy parameters: - in: path name: provider schema: type: string required: true tags: - identity-providers security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '204': description: No response body /api/invoice-items/: get: operationId: invoice_items_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: credit_uuid schema: type: string format: uuid - in: query name: customer_uuid schema: type: string format: uuid - in: query name: month schema: type: integer - in: query name: offering_uuid schema: type: string format: uuid - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: project_uuid schema: type: string format: uuid - in: query name: resource_uuid schema: type: string format: uuid - in: query name: start_month schema: type: number description: Start month - in: query name: start_year schema: type: number description: Start year - in: query name: year schema: type: integer tags: - invoice-items security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/InvoiceItemDetail' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' head: operationId: invoice_items_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: credit_uuid schema: type: string format: uuid - in: query name: customer_uuid schema: type: string format: uuid - in: query name: month schema: type: integer - in: query name: offering_uuid schema: type: string format: uuid - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: project_uuid schema: type: string format: uuid - in: query name: resource_uuid schema: type: string format: uuid - in: query name: start_month schema: type: number description: Start month - in: query name: start_year schema: type: number description: Start year - in: query name: year schema: type: integer tags: - invoice-items security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/invoice-items/{uuid}/: get: operationId: invoice_items_retrieve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - invoice-items security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/InvoiceItemDetail' description: '' put: operationId: invoice_items_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - invoice-items requestBody: content: application/json: schema: $ref: '#/components/schemas/InvoiceItemUpdateRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/InvoiceItemUpdate' description: '' patch: operationId: invoice_items_partial_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - invoice-items requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedInvoiceItemUpdateRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/InvoiceItemUpdate' description: '' delete: operationId: invoice_items_destroy parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - invoice-items security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '204': description: No response body /api/invoice-items/{uuid}/consumptions/: get: operationId: invoice_items_consumptions_retrieve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - invoice-items security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/InvoiceItemDetail' description: '' /api/invoice-items/{uuid}/create_compensation/: post: operationId: invoice_items_create_compensation description: Create compensation invoice item for selected invoice item. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - invoice-items requestBody: content: application/json: schema: $ref: '#/components/schemas/InvoiceItemCompensationRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/InvoiceItemCompensation' description: '' /api/invoice-items/{uuid}/migrate_to/: post: operationId: invoice_items_migrate_to description: Move invoice item from one invoice to another one. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - invoice-items requestBody: content: application/json: schema: $ref: '#/components/schemas/InvoiceItemMigrateToRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/InvoiceItemMigrateTo' description: '' /api/invoice-items/costs/: get: operationId: invoice_items_costs_list description: Get costs breakdown for a project by year and month. parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: project_uuid schema: type: string format: uuid description: UUID of the project for which statistics should be calculated. tags: - invoice-items security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/InvoiceCost' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' head: operationId: invoice_items_costs_count description: Get number of items in the collection matching the request parameters. parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: project_uuid schema: type: string format: uuid description: UUID of the project for which statistics should be calculated. tags: - invoice-items security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/invoice-items/customer_costs_for_period/: get: operationId: invoice_items_customer_costs_for_period_retrieve parameters: - in: query name: customer_uuid schema: type: string format: uuid description: UUID of the project for which statistics should be calculated. - in: query name: period schema: type: integer description: Period for which statistics should be calculated. tags: - invoice-items security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/CostsForPeriod' description: '' head: operationId: invoice_items_customer_costs_for_period_count parameters: - in: query name: customer_uuid schema: type: string format: uuid description: UUID of the project for which statistics should be calculated. - in: query name: period schema: type: integer description: Period for which statistics should be calculated. tags: - invoice-items security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body description: Get number of items in the collection matching the request parameters. /api/invoice-items/project_costs_for_period/: get: operationId: invoice_items_project_costs_for_period_retrieve description: Get resource cost breakdown for a project over a specified period. parameters: - in: query name: period schema: type: integer description: Period for which statistics should be calculated (1, 3 or 12 months). - in: query name: project_uuid schema: type: string format: uuid description: UUID of the project for which statistics should be calculated. tags: - invoice-items security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/CostsForPeriod' description: '' head: operationId: invoice_items_project_costs_for_period_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: period schema: type: integer description: Period for which statistics should be calculated (1, 3 or 12 months). - in: query name: project_uuid schema: type: string format: uuid description: UUID of the project for which statistics should be calculated. tags: - invoice-items security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/invoice-items/total_price/: get: operationId: invoice_items_total_price_retrieve description: Calculate total price for filtered invoice items. parameters: - in: query name: credit_uuid schema: type: string format: uuid - in: query name: customer_uuid schema: type: string format: uuid - in: query name: month schema: type: integer - in: query name: offering_uuid schema: type: string format: uuid - in: query name: project_uuid schema: type: string format: uuid - in: query name: resource_uuid schema: type: string format: uuid - in: query name: start_month schema: type: number description: Start month - in: query name: start_year schema: type: number description: Start year - in: query name: year schema: type: integer tags: - invoice-items security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/InvoiceItemTotalPrice' description: '' head: operationId: invoice_items_total_price_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: credit_uuid schema: type: string format: uuid - in: query name: customer_uuid schema: type: string format: uuid - in: query name: month schema: type: integer - in: query name: offering_uuid schema: type: string format: uuid - in: query name: project_uuid schema: type: string format: uuid - in: query name: resource_uuid schema: type: string format: uuid - in: query name: start_month schema: type: number description: Start month - in: query name: start_year schema: type: number description: Start year - in: query name: year schema: type: integer tags: - invoice-items security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/invoice/send-financial-report-by-mail/: post: operationId: invoice_send_financial_report_by_mail tags: - invoice requestBody: content: application/json: schema: $ref: '#/components/schemas/FinancialReportEmailRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/invoices/: get: operationId: invoices_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: created schema: type: string format: date - in: query name: customer schema: type: string - in: query name: customer_uuid schema: type: string format: uuid - in: query name: end_date schema: type: string format: date - in: query name: field schema: type: array items: type: string enum: - backend_id - compensations - customer - customer_details - due_date - incurred_costs - invoice_date - issuer_details - items - month - number - payment_url - price - reference_number - state - tax - total - url - uuid - year - in: query name: month schema: type: integer - in: query name: o schema: type: array items: type: string enum: - -created - -month - -year - created - month - year description: |+ Ordering explode: false style: form - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: start_date schema: type: string format: date - in: query name: state schema: type: array items: type: string enum: - canceled - created - paid - pending explode: true style: form - in: query name: year schema: type: integer tags: - invoices security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/Invoice' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' head: operationId: invoices_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: created schema: type: string format: date - in: query name: customer schema: type: string - in: query name: customer_uuid schema: type: string format: uuid - in: query name: end_date schema: type: string format: date - in: query name: month schema: type: integer - in: query name: o schema: type: array items: type: string enum: - -created - -month - -year - created - month - year description: |+ Ordering explode: false style: form - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: start_date schema: type: string format: date - in: query name: state schema: type: array items: type: string enum: - canceled - created - paid - pending explode: true style: form - in: query name: year schema: type: integer tags: - invoices security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/invoices/{uuid}/: get: operationId: invoices_retrieve parameters: - in: query name: field schema: type: array items: type: string enum: - backend_id - compensations - customer - customer_details - due_date - incurred_costs - invoice_date - issuer_details - items - month - number - payment_url - price - reference_number - state - tax - total - url - uuid - year - in: path name: uuid schema: type: string format: uuid required: true tags: - invoices security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Invoice' description: '' /api/invoices/{uuid}/items/: get: operationId: invoices_items_retrieve description: Retrieve a list of invoice items for the specified invoice. summary: Get invoice items parameters: - in: query name: conceal_compensation_items schema: type: boolean description: Conceal compensation items - in: query name: o schema: type: string enum: - project_name - -project_name - resource_name - -resource_name - provider_name - -provider_name - name - -name description: Order results by field - in: query name: offering_uuid schema: type: string - in: query name: project_uuid schema: type: string - in: query name: provider_uuid schema: type: string - in: query name: query schema: type: string - in: path name: uuid schema: type: string format: uuid required: true tags: - invoices security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/InvoiceItem' description: '' /api/invoices/{uuid}/paid/: post: operationId: invoices_paid description: Mark invoice as paid and optionally create payment record with proof of payment. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - invoices requestBody: content: application/json: schema: $ref: '#/components/schemas/PaidRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Invoice' description: '' /api/invoices/{uuid}/send_notification/: post: operationId: invoices_send_notification description: Schedule sending of a notification for the specified invoice. summary: Send invoice notification parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - invoices security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/invoices/{uuid}/set_backend_id/: post: operationId: invoices_set_backend_id description: Set backend ID for invoice. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - invoices requestBody: content: application/json: schema: $ref: '#/components/schemas/BackendIdRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/invoices/{uuid}/set_payment_url/: post: operationId: invoices_set_payment_url description: Set payment URL for invoice. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - invoices requestBody: content: application/json: schema: $ref: '#/components/schemas/PaymentURLRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/invoices/{uuid}/set_reference_number/: post: operationId: invoices_set_reference_number description: Set reference number for invoice. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - invoices requestBody: content: application/json: schema: $ref: '#/components/schemas/ReferenceNumberRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/invoices/{uuid}/stats/: get: operationId: invoices_stats_list description: Spendings grouped by offerings and filtered by provider. parameters: - in: query name: created schema: type: string format: date - in: query name: customer schema: type: string - in: query name: customer_uuid schema: type: string format: uuid - in: query name: end_date schema: type: string format: date - in: query name: month schema: type: integer - in: query name: o schema: type: array items: type: string enum: - -created - -month - -year - created - month - year description: |+ Ordering explode: false style: form - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: provider_uuid schema: type: string - in: query name: start_date schema: type: string format: date - in: query name: state schema: type: array items: type: string enum: - canceled - created - paid - pending explode: true style: form - in: path name: uuid schema: type: string format: uuid required: true - in: query name: year schema: type: integer tags: - invoices security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/InvoiceStatsOffering' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' /api/invoices/growth/: get: operationId: invoices_growth_retrieve description: Analyze invoice trends over time by comparing monthly totals for major customers versus others over the past year. parameters: - in: query name: accounting_is_running schema: type: boolean - in: query name: accounting_mode schema: type: string - in: query name: customers_count schema: type: integer tags: - invoices security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/InvoiceGrowth' description: '' head: operationId: invoices_growth_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: accounting_is_running schema: type: boolean - in: query name: accounting_mode schema: type: string - in: query name: customers_count schema: type: integer tags: - invoices security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/keycloak-groups/: get: operationId: keycloak_groups_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: role schema: type: string - in: query name: scope_type schema: type: string - in: query name: scope_uuid schema: type: string format: uuid tags: - keycloak-groups security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/KeycloakGroup' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' head: operationId: keycloak_groups_count description: Get number of items in the collection matching the request parameters. parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: role schema: type: string - in: query name: scope_type schema: type: string - in: query name: scope_uuid schema: type: string format: uuid tags: - keycloak-groups security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/keycloak-groups/{uuid}/: get: operationId: keycloak_groups_retrieve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - keycloak-groups security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/KeycloakGroup' description: '' /api/keycloak-user-group-memberships/: get: operationId: keycloak_user_group_memberships_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: email schema: type: string - in: query name: first_name schema: type: string - in: query name: group_uuid schema: type: string format: uuid - in: query name: last_name schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: role_uuid schema: type: string format: uuid - in: query name: scope_type schema: type: string - in: query name: scope_uuid schema: type: string format: uuid - in: query name: state schema: type: array items: type: string enum: - active - pending explode: true style: form - in: query name: username schema: type: string tags: - keycloak-user-group-memberships security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/KeycloakUserGroupMembership' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' post: operationId: keycloak_user_group_memberships_create tags: - keycloak-user-group-memberships requestBody: content: application/json: schema: $ref: '#/components/schemas/KeycloakUserGroupMembershipRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/KeycloakUserGroupMembership' description: '' head: operationId: keycloak_user_group_memberships_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: email schema: type: string - in: query name: first_name schema: type: string - in: query name: group_uuid schema: type: string format: uuid - in: query name: last_name schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: role_uuid schema: type: string format: uuid - in: query name: scope_type schema: type: string - in: query name: scope_uuid schema: type: string format: uuid - in: query name: state schema: type: array items: type: string enum: - active - pending explode: true style: form - in: query name: username schema: type: string tags: - keycloak-user-group-memberships security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/keycloak-user-group-memberships/{uuid}/: get: operationId: keycloak_user_group_memberships_retrieve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - keycloak-user-group-memberships security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/KeycloakUserGroupMembership' description: '' put: operationId: keycloak_user_group_memberships_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - keycloak-user-group-memberships requestBody: content: application/json: schema: $ref: '#/components/schemas/KeycloakUserGroupMembershipRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/KeycloakUserGroupMembership' description: '' patch: operationId: keycloak_user_group_memberships_partial_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - keycloak-user-group-memberships requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedKeycloakUserGroupMembershipRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/KeycloakUserGroupMembership' description: '' delete: operationId: keycloak_user_group_memberships_destroy parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - keycloak-user-group-memberships security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '204': description: No response body /api/keys/: get: operationId: keys_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: created schema: type: string format: date-time description: Created after - in: query name: field schema: type: array items: type: string enum: - fingerprint_md5 - fingerprint_sha256 - fingerprint_sha512 - is_shared - name - public_key - type - url - user_uuid - uuid - in: query name: fingerprint_md5 schema: type: string - in: query name: fingerprint_sha256 schema: type: string - in: query name: fingerprint_sha512 schema: type: string - in: query name: is_shared schema: type: boolean - in: query name: modified schema: type: string format: date-time description: Modified after - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - in: query name: o schema: type: array items: type: string enum: - -name - name description: |+ Ordering explode: false style: form - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: user_uuid schema: type: string format: uuid - in: query name: uuid schema: type: string format: uuid tags: - keys security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/SshKey' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' post: operationId: keys_create tags: - keys requestBody: content: application/json: schema: $ref: '#/components/schemas/SshKeyRequest' examples: Ssh-key-create: value: name: ssh_public_key1 public_key: ssh-rsa ... jhon@example.com summary: ssh-key-create required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/SshKey' description: '' head: operationId: keys_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: created schema: type: string format: date-time description: Created after - in: query name: fingerprint_md5 schema: type: string - in: query name: fingerprint_sha256 schema: type: string - in: query name: fingerprint_sha512 schema: type: string - in: query name: is_shared schema: type: boolean - in: query name: modified schema: type: string format: date-time description: Modified after - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - in: query name: o schema: type: array items: type: string enum: - -name - name description: |+ Ordering explode: false style: form - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: user_uuid schema: type: string format: uuid - in: query name: uuid schema: type: string format: uuid tags: - keys security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/keys/{uuid}/: get: operationId: keys_retrieve parameters: - in: query name: field schema: type: array items: type: string enum: - fingerprint_md5 - fingerprint_sha256 - fingerprint_sha512 - is_shared - name - public_key - type - url - user_uuid - uuid - in: path name: uuid schema: type: string format: uuid required: true tags: - keys security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/SshKey' description: '' delete: operationId: keys_destroy parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - keys security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '204': description: No response body /api/lexis-links/: get: operationId: lexis_links_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: customer_uuid schema: type: string format: uuid - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: project_uuid schema: type: string format: uuid - in: query name: query schema: type: string description: Filter by robot account username or type - in: query name: resource_uuid schema: type: string format: uuid - in: query name: uuid schema: type: string format: uuid tags: - lexis-links security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/LexisLink' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' post: operationId: lexis_links_create tags: - lexis-links requestBody: content: application/json: schema: $ref: '#/components/schemas/LexisLinkCreateRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '201': description: No response body x-permissions: - permission: LEXIS_LINK.CREATE scopes: - '*' - robot_account.resource.offering.customer head: operationId: lexis_links_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: customer_uuid schema: type: string format: uuid - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: project_uuid schema: type: string format: uuid - in: query name: query schema: type: string description: Filter by robot account username or type - in: query name: resource_uuid schema: type: string format: uuid - in: query name: uuid schema: type: string format: uuid tags: - lexis-links security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/lexis-links/{uuid}/: get: operationId: lexis_links_retrieve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - lexis-links security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/LexisLink' description: '' put: operationId: lexis_links_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - lexis-links requestBody: content: application/json: schema: $ref: '#/components/schemas/LexisLinkRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/LexisLink' description: '' patch: operationId: lexis_links_partial_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - lexis-links requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedLexisLinkRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/LexisLink' description: '' delete: operationId: lexis_links_destroy parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - lexis-links security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '204': description: No response body x-permissions: - permission: LEXIS_LINK.DELETE scopes: - '*' - robot_account.resource.offering.customer /api/maintenance-announcement-offerings/: get: operationId: maintenance_announcement_offerings_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - maintenance-announcement-offerings security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/MaintenanceAnnouncementOffering' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' post: operationId: maintenance_announcement_offerings_create tags: - maintenance-announcement-offerings requestBody: content: application/json: schema: $ref: '#/components/schemas/MaintenanceAnnouncementOfferingRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/MaintenanceAnnouncementOffering' description: '' head: operationId: maintenance_announcement_offerings_count description: Get number of items in the collection matching the request parameters. parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - maintenance-announcement-offerings security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/maintenance-announcement-offerings/{uuid}/: get: operationId: maintenance_announcement_offerings_retrieve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - maintenance-announcement-offerings security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/MaintenanceAnnouncementOffering' description: '' put: operationId: maintenance_announcement_offerings_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - maintenance-announcement-offerings requestBody: content: application/json: schema: $ref: '#/components/schemas/MaintenanceAnnouncementOfferingRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/MaintenanceAnnouncementOffering' description: '' patch: operationId: maintenance_announcement_offerings_partial_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - maintenance-announcement-offerings requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedMaintenanceAnnouncementOfferingRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/MaintenanceAnnouncementOffering' description: '' delete: operationId: maintenance_announcement_offerings_destroy parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - maintenance-announcement-offerings security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '204': description: No response body /api/maintenance-announcement-template-offerings/: get: operationId: maintenance_announcement_template_offerings_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: impact_level schema: type: integer - in: query name: maintenance_template_uuid schema: type: string format: uuid - in: query name: o schema: type: array items: type: string enum: - -created - created description: |+ Ordering explode: false style: form - in: query name: offering_uuid schema: type: string format: uuid - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: service_provider_uuid schema: type: string format: uuid tags: - maintenance-announcement-template-offerings security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/MaintenanceAnnouncementOfferingTemplate' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' post: operationId: maintenance_announcement_template_offerings_create tags: - maintenance-announcement-template-offerings requestBody: content: application/json: schema: $ref: '#/components/schemas/MaintenanceAnnouncementOfferingTemplateRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/MaintenanceAnnouncementOfferingTemplate' description: '' head: operationId: maintenance_announcement_template_offerings_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: impact_level schema: type: integer - in: query name: maintenance_template_uuid schema: type: string format: uuid - in: query name: o schema: type: array items: type: string enum: - -created - created description: |+ Ordering explode: false style: form - in: query name: offering_uuid schema: type: string format: uuid - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: service_provider_uuid schema: type: string format: uuid tags: - maintenance-announcement-template-offerings security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/maintenance-announcement-template-offerings/{uuid}/: get: operationId: maintenance_announcement_template_offerings_retrieve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - maintenance-announcement-template-offerings security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/MaintenanceAnnouncementOfferingTemplate' description: '' put: operationId: maintenance_announcement_template_offerings_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - maintenance-announcement-template-offerings requestBody: content: application/json: schema: $ref: '#/components/schemas/MaintenanceAnnouncementOfferingTemplateRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/MaintenanceAnnouncementOfferingTemplate' description: '' patch: operationId: maintenance_announcement_template_offerings_partial_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - maintenance-announcement-template-offerings requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedMaintenanceAnnouncementOfferingTemplateRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/MaintenanceAnnouncementOfferingTemplate' description: '' delete: operationId: maintenance_announcement_template_offerings_destroy parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - maintenance-announcement-template-offerings security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '204': description: No response body /api/maintenance-announcements/: get: operationId: maintenance_announcements_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: maintenance_type schema: type: integer - in: query name: o schema: type: array items: type: string enum: - -created - -name - -scheduled_end - -scheduled_start - created - name - scheduled_end - scheduled_start description: |+ Ordering explode: false style: form - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: scheduled_end_after schema: type: string format: date-time - in: query name: scheduled_end_before schema: type: string format: date-time - in: query name: scheduled_start_after schema: type: string format: date-time - in: query name: scheduled_start_before schema: type: string format: date-time - in: query name: service_provider_uuid schema: type: string format: uuid - in: query name: state schema: type: array items: type: string enum: - Cancelled - Completed - Draft - In progress - Scheduled explode: true style: form tags: - maintenance-announcements security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/MaintenanceAnnouncement' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' post: operationId: maintenance_announcements_create tags: - maintenance-announcements requestBody: content: application/json: schema: $ref: '#/components/schemas/MaintenanceAnnouncementRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/MaintenanceAnnouncement' description: '' head: operationId: maintenance_announcements_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: maintenance_type schema: type: integer - in: query name: o schema: type: array items: type: string enum: - -created - -name - -scheduled_end - -scheduled_start - created - name - scheduled_end - scheduled_start description: |+ Ordering explode: false style: form - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: scheduled_end_after schema: type: string format: date-time - in: query name: scheduled_end_before schema: type: string format: date-time - in: query name: scheduled_start_after schema: type: string format: date-time - in: query name: scheduled_start_before schema: type: string format: date-time - in: query name: service_provider_uuid schema: type: string format: uuid - in: query name: state schema: type: array items: type: string enum: - Cancelled - Completed - Draft - In progress - Scheduled explode: true style: form tags: - maintenance-announcements security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/maintenance-announcements-template/: get: operationId: maintenance_announcements_template_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: maintenance_type schema: type: integer - in: query name: o schema: type: array items: type: string enum: - -created - -name - created - name description: |+ Ordering explode: false style: form - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: service_provider_uuid schema: type: string format: uuid tags: - maintenance-announcements-template security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/MaintenanceAnnouncementTemplate' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' post: operationId: maintenance_announcements_template_create tags: - maintenance-announcements-template requestBody: content: application/json: schema: $ref: '#/components/schemas/MaintenanceAnnouncementTemplateRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/MaintenanceAnnouncementTemplate' description: '' head: operationId: maintenance_announcements_template_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: maintenance_type schema: type: integer - in: query name: o schema: type: array items: type: string enum: - -created - -name - created - name description: |+ Ordering explode: false style: form - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: service_provider_uuid schema: type: string format: uuid tags: - maintenance-announcements-template security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/maintenance-announcements-template/{uuid}/: get: operationId: maintenance_announcements_template_retrieve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - maintenance-announcements-template security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/MaintenanceAnnouncementTemplate' description: '' put: operationId: maintenance_announcements_template_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - maintenance-announcements-template requestBody: content: application/json: schema: $ref: '#/components/schemas/MaintenanceAnnouncementTemplateRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/MaintenanceAnnouncementTemplate' description: '' patch: operationId: maintenance_announcements_template_partial_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - maintenance-announcements-template requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedMaintenanceAnnouncementTemplateRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/MaintenanceAnnouncementTemplate' description: '' delete: operationId: maintenance_announcements_template_destroy parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - maintenance-announcements-template security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '204': description: No response body /api/maintenance-announcements/{uuid}/: get: operationId: maintenance_announcements_retrieve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - maintenance-announcements security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/MaintenanceAnnouncement' description: '' put: operationId: maintenance_announcements_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - maintenance-announcements requestBody: content: application/json: schema: $ref: '#/components/schemas/MaintenanceAnnouncementRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/MaintenanceAnnouncement' description: '' patch: operationId: maintenance_announcements_partial_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - maintenance-announcements requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedMaintenanceAnnouncementRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/MaintenanceAnnouncement' description: '' delete: operationId: maintenance_announcements_destroy parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - maintenance-announcements security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '204': description: No response body /api/maintenance-announcements/{uuid}/cancel_maintenance/: post: operationId: maintenance_announcements_cancel_maintenance description: Cancel the maintenance announcement parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - maintenance-announcements security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/MaintenanceActionResponse' description: '' /api/maintenance-announcements/{uuid}/complete_maintenance/: post: operationId: maintenance_announcements_complete_maintenance description: Complete the maintenance announcement parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - maintenance-announcements security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/MaintenanceActionResponse' description: '' /api/maintenance-announcements/{uuid}/schedule/: post: operationId: maintenance_announcements_schedule description: Schedule/publish the maintenance announcement parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - maintenance-announcements security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/MaintenanceActionResponse' description: '' /api/maintenance-announcements/{uuid}/start_maintenance/: post: operationId: maintenance_announcements_start_maintenance description: Start the maintenance announcement parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - maintenance-announcements security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/MaintenanceActionResponse' description: '' /api/maintenance-announcements/{uuid}/unschedule/: post: operationId: maintenance_announcements_unschedule description: Unschedule/unpublish the maintenance announcement parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - maintenance-announcements security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/MaintenanceActionResponse' description: '' /api/managed-rancher-cluster-resources/: get: operationId: managed_rancher_cluster_resources_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: field schema: type: array items: type: string enum: - attributes - available_actions - backend_id - backend_metadata - can_terminate - category_icon - category_title - category_uuid - created - creation_order - current_usages - customer_name - customer_slug - customer_uuid - description - downscaled - effective_id - end_date - end_date_requested_by - endpoints - error_message - error_traceback - is_limit_based - is_usage_based - last_sync - limit_usage - limits - modified - name - offering - offering_billable - offering_customer_uuid - offering_description - offering_image - offering_name - offering_plugin_options - offering_shared - offering_slug - offering_thumbnail - offering_type - offering_uuid - options - order_in_progress - parent_name - parent_offering_name - parent_offering_slug - parent_offering_uuid - parent_uuid - paused - plan - plan_description - plan_name - plan_unit - plan_uuid - project - project_description - project_end_date - project_end_date_requested_by - project_name - project_slug - project_uuid - provider_name - provider_uuid - report - resource_type - resource_uuid - restrict_member_access - scope - service_settings_uuid - slug - state - url - user_requires_reconsent - username - uuid - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - managed-rancher-cluster-resources security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/Resource' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' head: operationId: managed_rancher_cluster_resources_count description: Get number of items in the collection matching the request parameters. parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - managed-rancher-cluster-resources security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/managed-rancher-cluster-resources/{uuid}/: get: operationId: managed_rancher_cluster_resources_retrieve parameters: - in: query name: field schema: type: array items: type: string enum: - attributes - available_actions - backend_id - backend_metadata - can_terminate - category_icon - category_title - category_uuid - created - creation_order - current_usages - customer_name - customer_slug - customer_uuid - description - downscaled - effective_id - end_date - end_date_requested_by - endpoints - error_message - error_traceback - is_limit_based - is_usage_based - last_sync - limit_usage - limits - modified - name - offering - offering_billable - offering_customer_uuid - offering_description - offering_image - offering_name - offering_plugin_options - offering_shared - offering_slug - offering_thumbnail - offering_type - offering_uuid - options - order_in_progress - parent_name - parent_offering_name - parent_offering_slug - parent_offering_uuid - parent_uuid - paused - plan - plan_description - plan_name - plan_unit - plan_uuid - project - project_description - project_end_date - project_end_date_requested_by - project_name - project_slug - project_uuid - provider_name - provider_uuid - report - resource_type - resource_uuid - restrict_member_access - scope - service_settings_uuid - slug - state - url - user_requires_reconsent - username - uuid - in: path name: uuid schema: type: string format: uuid required: true tags: - managed-rancher-cluster-resources security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Resource' description: '' /api/managed-rancher-cluster-resources/{uuid}/add_node/: post: operationId: managed_rancher_cluster_resources_add_node parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - managed-rancher-cluster-resources requestBody: content: application/json: schema: $ref: '#/components/schemas/ManagedRancherCreateNodeRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RancherNode' description: '' x-permissions: - permission: ORDER.APPROVE scopes: - project.customer /api/marketplace-bookings/{uuid}/: get: operationId: marketplace_bookings_list parameters: - in: path name: uuid schema: type: string pattern: ^[a-f0-9]+$ required: true tags: - marketplace-bookings security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/Booking' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' /api/marketplace-categories/: get: operationId: marketplace_categories_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: customer_uuid schema: type: string format: uuid description: Customer UUID - in: query name: customers_offerings_state schema: type: array items: type: string enum: - 1 - 2 - 3 - 4 description: |+ Customers offerings state explode: true style: form - in: query name: field schema: type: array items: type: string enum: - articles - available_offerings_count - columns - components - default_tenant_category - default_vm_category - default_volume_category - description - group - icon - offering_count - sections - title - url - uuid - in: query name: group_uuid schema: type: string format: uuid - in: query name: has_shared schema: type: boolean description: Has shared - in: query name: offering_name schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: resource_customer_uuid schema: type: string format: uuid - in: query name: resource_project_uuid schema: type: string format: uuid - in: query name: title schema: type: string tags: - marketplace-categories security: - tokenAuth: [] - waldurOIDCAuth: [] - {} responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/MarketplaceCategory' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' post: operationId: marketplace_categories_create tags: - marketplace-categories requestBody: content: application/json: schema: $ref: '#/components/schemas/MarketplaceCategoryRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/MarketplaceCategory' description: '' head: operationId: marketplace_categories_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: customer_uuid schema: type: string format: uuid description: Customer UUID - in: query name: customers_offerings_state schema: type: array items: type: string enum: - 1 - 2 - 3 - 4 description: |+ Customers offerings state explode: true style: form - in: query name: group_uuid schema: type: string format: uuid - in: query name: has_shared schema: type: boolean description: Has shared - in: query name: offering_name schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: resource_customer_uuid schema: type: string format: uuid - in: query name: resource_project_uuid schema: type: string format: uuid - in: query name: title schema: type: string tags: - marketplace-categories security: - tokenAuth: [] - waldurOIDCAuth: [] - {} responses: '200': description: No response body /api/marketplace-categories/{uuid}/: get: operationId: marketplace_categories_retrieve parameters: - in: query name: field schema: type: array items: type: string enum: - articles - available_offerings_count - columns - components - default_tenant_category - default_vm_category - default_volume_category - description - group - icon - offering_count - sections - title - url - uuid - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-categories security: - tokenAuth: [] - waldurOIDCAuth: [] - {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/MarketplaceCategory' description: '' put: operationId: marketplace_categories_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-categories requestBody: content: application/json: schema: $ref: '#/components/schemas/MarketplaceCategoryRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/MarketplaceCategory' description: '' patch: operationId: marketplace_categories_partial_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-categories requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedMarketplaceCategoryRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/MarketplaceCategory' description: '' delete: operationId: marketplace_categories_destroy parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-categories security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '204': description: No response body /api/marketplace-category-columns/: get: operationId: marketplace_category_columns_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: category_uuid schema: type: string format: uuid - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: title schema: type: string tags: - marketplace-category-columns security: - tokenAuth: [] - waldurOIDCAuth: [] - {} responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/CategoryColumn' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' post: operationId: marketplace_category_columns_create tags: - marketplace-category-columns requestBody: content: application/json: schema: $ref: '#/components/schemas/CategoryColumnRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/CategoryColumn' description: '' head: operationId: marketplace_category_columns_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: category_uuid schema: type: string format: uuid - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: title schema: type: string tags: - marketplace-category-columns security: - tokenAuth: [] - waldurOIDCAuth: [] - {} responses: '200': description: No response body /api/marketplace-category-columns/{uuid}/: get: operationId: marketplace_category_columns_retrieve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-category-columns security: - tokenAuth: [] - waldurOIDCAuth: [] - {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/CategoryColumn' description: '' put: operationId: marketplace_category_columns_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-category-columns requestBody: content: application/json: schema: $ref: '#/components/schemas/CategoryColumnRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/CategoryColumn' description: '' patch: operationId: marketplace_category_columns_partial_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-category-columns requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedCategoryColumnRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/CategoryColumn' description: '' delete: operationId: marketplace_category_columns_destroy parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-category-columns security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '204': description: No response body /api/marketplace-category-component-usages/: get: operationId: marketplace_category_component_usages_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: date_after schema: type: string format: date - in: query name: date_before schema: type: string format: date - in: query name: field schema: type: array items: type: string enum: - category_title - category_uuid - date - fixed_usage - measured_unit - name - reported_usage - scope - type - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - marketplace-category-component-usages security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/CategoryComponentUsage' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' head: operationId: marketplace_category_component_usages_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: date_after schema: type: string format: date - in: query name: date_before schema: type: string format: date - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - marketplace-category-component-usages security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/marketplace-category-component-usages/{id}/: get: operationId: marketplace_category_component_usages_retrieve parameters: - in: query name: field schema: type: array items: type: string enum: - category_title - category_uuid - date - fixed_usage - measured_unit - name - reported_usage - scope - type - in: path name: id schema: type: integer description: A unique integer value identifying this category component usage. required: true tags: - marketplace-category-component-usages security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/CategoryComponentUsage' description: '' /api/marketplace-category-components/: get: operationId: marketplace_category_components_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - marketplace-category-components security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/CategoryComponents' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' post: operationId: marketplace_category_components_create tags: - marketplace-category-components requestBody: content: application/json: schema: $ref: '#/components/schemas/CategoryComponentsRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/CategoryComponents' description: '' head: operationId: marketplace_category_components_count description: Get number of items in the collection matching the request parameters. parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - marketplace-category-components security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/marketplace-category-components/{id}/: get: operationId: marketplace_category_components_retrieve parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this category component. required: true tags: - marketplace-category-components security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/CategoryComponents' description: '' put: operationId: marketplace_category_components_update parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this category component. required: true tags: - marketplace-category-components requestBody: content: application/json: schema: $ref: '#/components/schemas/CategoryComponentsRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/CategoryComponents' description: '' patch: operationId: marketplace_category_components_partial_update parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this category component. required: true tags: - marketplace-category-components requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedCategoryComponentsRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/CategoryComponents' description: '' delete: operationId: marketplace_category_components_destroy parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this category component. required: true tags: - marketplace-category-components security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '204': description: No response body /api/marketplace-category-groups/: get: operationId: marketplace_category_groups_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: field schema: type: array items: type: string enum: - description - icon - title - url - uuid - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: title schema: type: string tags: - marketplace-category-groups security: - tokenAuth: [] - waldurOIDCAuth: [] - {} responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/CategoryGroup' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' post: operationId: marketplace_category_groups_create tags: - marketplace-category-groups requestBody: content: application/json: schema: $ref: '#/components/schemas/CategoryGroupRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/CategoryGroup' description: '' head: operationId: marketplace_category_groups_count description: Get number of items in the collection matching the request parameters. parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: title schema: type: string tags: - marketplace-category-groups security: - tokenAuth: [] - waldurOIDCAuth: [] - {} responses: '200': description: No response body /api/marketplace-category-groups/{uuid}/: get: operationId: marketplace_category_groups_retrieve parameters: - in: query name: field schema: type: array items: type: string enum: - description - icon - title - url - uuid - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-category-groups security: - tokenAuth: [] - waldurOIDCAuth: [] - {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/CategoryGroup' description: '' put: operationId: marketplace_category_groups_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-category-groups requestBody: content: application/json: schema: $ref: '#/components/schemas/CategoryGroupRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/CategoryGroup' description: '' patch: operationId: marketplace_category_groups_partial_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-category-groups requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedCategoryGroupRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/CategoryGroup' description: '' delete: operationId: marketplace_category_groups_destroy parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-category-groups security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '204': description: No response body /api/marketplace-category-help-articles/: get: operationId: marketplace_category_help_articles_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - marketplace-category-help-articles security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/CategoryHelpArticles' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' post: operationId: marketplace_category_help_articles_create tags: - marketplace-category-help-articles requestBody: content: application/json: schema: $ref: '#/components/schemas/CategoryHelpArticlesRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/CategoryHelpArticles' description: '' head: operationId: marketplace_category_help_articles_count description: Get number of items in the collection matching the request parameters. parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - marketplace-category-help-articles security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/marketplace-category-help-articles/{id}/: get: operationId: marketplace_category_help_articles_retrieve parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this category help article. required: true tags: - marketplace-category-help-articles security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/CategoryHelpArticles' description: '' put: operationId: marketplace_category_help_articles_update parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this category help article. required: true tags: - marketplace-category-help-articles requestBody: content: application/json: schema: $ref: '#/components/schemas/CategoryHelpArticlesRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/CategoryHelpArticles' description: '' patch: operationId: marketplace_category_help_articles_partial_update parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this category help article. required: true tags: - marketplace-category-help-articles requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedCategoryHelpArticlesRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/CategoryHelpArticles' description: '' delete: operationId: marketplace_category_help_articles_destroy parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this category help article. required: true tags: - marketplace-category-help-articles security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '204': description: No response body /api/marketplace-component-usages/: get: operationId: marketplace_component_usages_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: billing_period schema: type: string format: date - in: query name: customer_uuid schema: type: string format: uuid - in: query name: date_after schema: type: string format: date - in: query name: date_before schema: type: string format: date - in: query name: field schema: type: array items: type: string enum: - billing_period - created - customer_name - customer_uuid - date - description - measured_unit - modified_by - name - offering_name - offering_uuid - project_name - project_uuid - recurring - resource_name - resource_uuid - type - usage - uuid - in: query name: o schema: type: array items: type: string enum: - -billing_period - -usage - billing_period - usage description: |+ Ordering explode: false style: form - in: query name: offering_uuid schema: type: string format: uuid - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: project_uuid schema: type: string format: uuid - in: query name: resource schema: type: string - in: query name: resource_uuid schema: type: string format: uuid - in: query name: type schema: type: string tags: - marketplace-component-usages security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/ComponentUsage' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' head: operationId: marketplace_component_usages_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: billing_period schema: type: string format: date - in: query name: customer_uuid schema: type: string format: uuid - in: query name: date_after schema: type: string format: date - in: query name: date_before schema: type: string format: date - in: query name: o schema: type: array items: type: string enum: - -billing_period - -usage - billing_period - usage description: |+ Ordering explode: false style: form - in: query name: offering_uuid schema: type: string format: uuid - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: project_uuid schema: type: string format: uuid - in: query name: resource schema: type: string - in: query name: resource_uuid schema: type: string format: uuid - in: query name: type schema: type: string tags: - marketplace-component-usages security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/marketplace-component-usages/{uuid}/: get: operationId: marketplace_component_usages_retrieve parameters: - in: query name: field schema: type: array items: type: string enum: - billing_period - created - customer_name - customer_uuid - date - description - measured_unit - modified_by - name - offering_name - offering_uuid - project_name - project_uuid - recurring - resource_name - resource_uuid - type - usage - uuid - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-component-usages security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ComponentUsage' description: '' /api/marketplace-component-usages/{uuid}/set_user_usage/: post: operationId: marketplace_component_usages_set_user_usage parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-component-usages requestBody: content: application/json: schema: $ref: '#/components/schemas/ComponentUserUsageCreateRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '201': description: No response body x-permissions: - permission: RESOURCE.SET_USAGE scopes: - resource.offering - resource.offering.customer /api/marketplace-component-usages/set_usage/: post: operationId: marketplace_component_usages_set_usage tags: - marketplace-component-usages requestBody: content: application/json: schema: $ref: '#/components/schemas/ComponentUsageCreateRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '201': description: No response body /api/marketplace-component-user-usages/: get: operationId: marketplace_component_user_usages_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: billing_period_month schema: type: number - in: query name: billing_period_year schema: type: number - in: query name: component_usage__billing_period schema: type: string format: date - in: query name: customer_uuid schema: type: string format: uuid - in: query name: date_after schema: type: string format: date - in: query name: date_before schema: type: string format: date - in: query name: field schema: type: array items: type: string enum: - backend_id - billing_period - component_type - component_usage - created - customer_name - customer_uuid - date - description - measured_unit - modified - offering_name - offering_uuid - project_name - project_uuid - resource_name - resource_uuid - usage - user - username - uuid - in: query name: o schema: type: array items: type: string enum: - -component_usage__billing_period - -usage - -username - component_usage__billing_period - usage - username description: |+ Ordering explode: false style: form - in: query name: offering_uuid schema: type: string format: uuid - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: project_uuid schema: type: string format: uuid - in: query name: resource schema: type: string description: Resource URL - in: query name: resource_uuid schema: type: string format: uuid - in: query name: type schema: type: string - in: query name: username schema: type: string tags: - marketplace-component-user-usages security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/ComponentUserUsage' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' head: operationId: marketplace_component_user_usages_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: billing_period_month schema: type: number - in: query name: billing_period_year schema: type: number - in: query name: component_usage__billing_period schema: type: string format: date - in: query name: customer_uuid schema: type: string format: uuid - in: query name: date_after schema: type: string format: date - in: query name: date_before schema: type: string format: date - in: query name: o schema: type: array items: type: string enum: - -component_usage__billing_period - -usage - -username - component_usage__billing_period - usage - username description: |+ Ordering explode: false style: form - in: query name: offering_uuid schema: type: string format: uuid - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: project_uuid schema: type: string format: uuid - in: query name: resource schema: type: string description: Resource URL - in: query name: resource_uuid schema: type: string format: uuid - in: query name: type schema: type: string - in: query name: username schema: type: string tags: - marketplace-component-user-usages security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/marketplace-component-user-usages/{uuid}/: get: operationId: marketplace_component_user_usages_retrieve parameters: - in: query name: field schema: type: array items: type: string enum: - backend_id - billing_period - component_type - component_usage - created - customer_name - customer_uuid - date - description - measured_unit - modified - offering_name - offering_uuid - project_name - project_uuid - resource_name - resource_uuid - usage - user - username - uuid - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-component-user-usages security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ComponentUserUsage' description: '' /api/marketplace-course-accounts/: get: operationId: marketplace_course_accounts_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: email schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: project_uuid schema: type: string format: uuid - in: query name: state schema: type: array items: type: string enum: - Closed - Erred - OK explode: true style: form - in: query name: username schema: type: string tags: - marketplace-course-accounts security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/CourseAccount' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' post: operationId: marketplace_course_accounts_create tags: - marketplace-course-accounts requestBody: content: application/json: schema: $ref: '#/components/schemas/CourseAccountRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/CourseAccount' description: '' head: operationId: marketplace_course_accounts_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: email schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: project_uuid schema: type: string format: uuid - in: query name: state schema: type: array items: type: string enum: - Closed - Erred - OK explode: true style: form - in: query name: username schema: type: string tags: - marketplace-course-accounts security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/marketplace-course-accounts/{uuid}/: get: operationId: marketplace_course_accounts_retrieve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-course-accounts security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/CourseAccount' description: '' delete: operationId: marketplace_course_accounts_destroy parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-course-accounts security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '204': description: No response body x-permissions: - permission: PROJECT.COURSE_ACCOUNT_MANAGE scopes: - project - project.customer /api/marketplace-course-accounts/create_bulk/: post: operationId: marketplace_course_accounts_create_bulk tags: - marketplace-course-accounts requestBody: content: application/json: schema: $ref: '#/components/schemas/CourseAccountsBulkCreateRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/CourseAccountsBulkCreate' description: '' /api/marketplace-customer-estimated-cost-policies/: get: operationId: marketplace_customer_estimated_cost_policies_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: customer schema: type: string - in: query name: customer_uuid schema: type: string format: uuid - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: scope schema: type: string - in: query name: scope_uuid schema: type: string format: uuid tags: - marketplace-customer-estimated-cost-policies security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/CustomerEstimatedCostPolicy' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' post: operationId: marketplace_customer_estimated_cost_policies_create tags: - marketplace-customer-estimated-cost-policies requestBody: content: application/json: schema: $ref: '#/components/schemas/CustomerEstimatedCostPolicyRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/CustomerEstimatedCostPolicy' description: '' head: operationId: marketplace_customer_estimated_cost_policies_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: customer schema: type: string - in: query name: customer_uuid schema: type: string format: uuid - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: scope schema: type: string - in: query name: scope_uuid schema: type: string format: uuid tags: - marketplace-customer-estimated-cost-policies security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/marketplace-customer-estimated-cost-policies/{uuid}/: get: operationId: marketplace_customer_estimated_cost_policies_retrieve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-customer-estimated-cost-policies security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/CustomerEstimatedCostPolicy' description: '' put: operationId: marketplace_customer_estimated_cost_policies_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-customer-estimated-cost-policies requestBody: content: application/json: schema: $ref: '#/components/schemas/CustomerEstimatedCostPolicyRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/CustomerEstimatedCostPolicy' description: '' patch: operationId: marketplace_customer_estimated_cost_policies_partial_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-customer-estimated-cost-policies requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedCustomerEstimatedCostPolicyRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/CustomerEstimatedCostPolicy' description: '' delete: operationId: marketplace_customer_estimated_cost_policies_destroy parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-customer-estimated-cost-policies security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '204': description: No response body /api/marketplace-customer-estimated-cost-policies/actions/: get: operationId: marketplace_customer_estimated_cost_policies_actions_retrieve tags: - marketplace-customer-estimated-cost-policies security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/CustomerEstimatedCostPolicy' description: '' head: operationId: marketplace_customer_estimated_cost_policies_actions_count tags: - marketplace-customer-estimated-cost-policies security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body description: Get number of items in the collection matching the request parameters. /api/marketplace-customer-service-accounts/: get: operationId: marketplace_customer_service_accounts_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: customer schema: type: string - in: query name: customer_uuid schema: type: string format: uuid - in: query name: email schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: state schema: type: array items: type: string enum: - Closed - Erred - OK explode: true style: form - in: query name: username schema: type: string tags: - marketplace-customer-service-accounts security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/CustomerServiceAccount' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' post: operationId: marketplace_customer_service_accounts_create tags: - marketplace-customer-service-accounts requestBody: content: application/json: schema: $ref: '#/components/schemas/CustomerServiceAccountRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/CustomerServiceAccount' description: '' head: operationId: marketplace_customer_service_accounts_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: customer schema: type: string - in: query name: customer_uuid schema: type: string format: uuid - in: query name: email schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: state schema: type: array items: type: string enum: - Closed - Erred - OK explode: true style: form - in: query name: username schema: type: string tags: - marketplace-customer-service-accounts security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/marketplace-customer-service-accounts/{uuid}/: get: operationId: marketplace_customer_service_accounts_retrieve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-customer-service-accounts security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/CustomerServiceAccount' description: '' put: operationId: marketplace_customer_service_accounts_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-customer-service-accounts requestBody: content: application/json: schema: $ref: '#/components/schemas/CustomerServiceAccountRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/CustomerServiceAccount' description: '' x-permissions: - permission: SERVICE_ACCOUNT.MANAGE scopes: - customer patch: operationId: marketplace_customer_service_accounts_partial_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-customer-service-accounts requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedCustomerServiceAccountRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/CustomerServiceAccount' description: '' x-permissions: - permission: SERVICE_ACCOUNT.MANAGE scopes: - customer delete: operationId: marketplace_customer_service_accounts_destroy parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-customer-service-accounts security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '204': description: No response body x-permissions: - permission: SERVICE_ACCOUNT.MANAGE scopes: - customer /api/marketplace-customer-service-accounts/{uuid}/rotate_api_key/: post: operationId: marketplace_customer_service_accounts_rotate_api_key parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-customer-service-accounts security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/CustomerServiceAccount' description: '' x-permissions: - permission: SERVICE_ACCOUNT.MANAGE scopes: - customer /api/marketplace-global-categories/: get: operationId: marketplace_global_categories_retrieve description: Count of resource categories for all resources accessible by user. parameters: - in: query name: customer_uuid schema: type: string format: uuid description: UUID of the customer to filter resources by. - in: query name: project_uuid schema: type: string format: uuid description: UUID of the project to filter resources by. tags: - marketplace-global-categories security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: object additionalProperties: type: integer description: '' /api/marketplace-integration-statuses/: get: operationId: marketplace_integration_statuses_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: agent_type schema: type: string - in: query name: customer_uuid schema: type: string - in: query name: o schema: type: array items: type: string enum: - -last_request_timestamp - last_request_timestamp description: |+ Ordering explode: false style: form - in: query name: offering schema: type: string - in: query name: offering_slug schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: offering_uuid schema: type: array items: type: string format: uuid description: Multiple values may be separated by commas. explode: false style: form - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: parent_offering_uuid schema: type: string format: uuid - in: query name: status schema: type: array items: type: string enum: - Active - Disconnected - Unknown explode: true style: form tags: - marketplace-integration-statuses security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/IntegrationStatusDetails' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' head: operationId: marketplace_integration_statuses_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: agent_type schema: type: string - in: query name: customer_uuid schema: type: string - in: query name: o schema: type: array items: type: string enum: - -last_request_timestamp - last_request_timestamp description: |+ Ordering explode: false style: form - in: query name: offering schema: type: string - in: query name: offering_slug schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: offering_uuid schema: type: array items: type: string format: uuid description: Multiple values may be separated by commas. explode: false style: form - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: parent_offering_uuid schema: type: string format: uuid - in: query name: status schema: type: array items: type: string enum: - Active - Disconnected - Unknown explode: true style: form tags: - marketplace-integration-statuses security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/marketplace-integration-statuses/{uuid}/: get: operationId: marketplace_integration_statuses_retrieve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-integration-statuses security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/IntegrationStatusDetails' description: '' /api/marketplace-offering-estimated-cost-policies/: get: operationId: marketplace_offering_estimated_cost_policies_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: scope schema: type: string - in: query name: scope_uuid schema: type: string format: uuid tags: - marketplace-offering-estimated-cost-policies security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/OfferingEstimatedCostPolicy' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' post: operationId: marketplace_offering_estimated_cost_policies_create tags: - marketplace-offering-estimated-cost-policies requestBody: content: application/json: schema: $ref: '#/components/schemas/OfferingEstimatedCostPolicyRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/OfferingEstimatedCostPolicy' description: '' head: operationId: marketplace_offering_estimated_cost_policies_count description: Get number of items in the collection matching the request parameters. parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: scope schema: type: string - in: query name: scope_uuid schema: type: string format: uuid tags: - marketplace-offering-estimated-cost-policies security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/marketplace-offering-estimated-cost-policies/{uuid}/: get: operationId: marketplace_offering_estimated_cost_policies_retrieve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-offering-estimated-cost-policies security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OfferingEstimatedCostPolicy' description: '' put: operationId: marketplace_offering_estimated_cost_policies_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-offering-estimated-cost-policies requestBody: content: application/json: schema: $ref: '#/components/schemas/OfferingEstimatedCostPolicyRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OfferingEstimatedCostPolicy' description: '' patch: operationId: marketplace_offering_estimated_cost_policies_partial_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-offering-estimated-cost-policies requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedOfferingEstimatedCostPolicyRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OfferingEstimatedCostPolicy' description: '' delete: operationId: marketplace_offering_estimated_cost_policies_destroy parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-offering-estimated-cost-policies security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '204': description: No response body /api/marketplace-offering-estimated-cost-policies/actions/: get: operationId: marketplace_offering_estimated_cost_policies_actions_retrieve description: List available actions for OfferingEstimatedCostPolicy tags: - marketplace-offering-estimated-cost-policies security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OfferingEstimatedCostPolicy' description: '' head: operationId: marketplace_offering_estimated_cost_policies_actions_count description: Get number of items in the collection matching the request parameters. tags: - marketplace-offering-estimated-cost-policies security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/marketplace-offering-files/: get: operationId: marketplace_offering_files_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: field schema: type: array items: type: string enum: - created - file - name - offering - url - uuid - in: query name: o schema: type: array items: type: string enum: - -created - -name - created - name description: |+ Ordering explode: false style: form - in: query name: offering schema: type: string - in: query name: offering_slug schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: offering_uuid schema: type: array items: type: string format: uuid description: Multiple values may be separated by commas. explode: false style: form - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: parent_offering_uuid schema: type: string format: uuid tags: - marketplace-offering-files security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/OfferingFile' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' post: operationId: marketplace_offering_files_create tags: - marketplace-offering-files requestBody: content: application/json: schema: $ref: '#/components/schemas/OfferingFileRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/OfferingFile' description: '' head: operationId: marketplace_offering_files_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: o schema: type: array items: type: string enum: - -created - -name - created - name description: |+ Ordering explode: false style: form - in: query name: offering schema: type: string - in: query name: offering_slug schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: offering_uuid schema: type: array items: type: string format: uuid description: Multiple values may be separated by commas. explode: false style: form - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: parent_offering_uuid schema: type: string format: uuid tags: - marketplace-offering-files security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/marketplace-offering-files/{uuid}/: get: operationId: marketplace_offering_files_retrieve parameters: - in: query name: field schema: type: array items: type: string enum: - created - file - name - offering - url - uuid - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-offering-files security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OfferingFile' description: '' delete: operationId: marketplace_offering_files_destroy parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-offering-files security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '204': description: No response body /api/marketplace-offering-permissions/: get: operationId: marketplace_offering_permissions_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: created schema: type: string format: date-time description: Created after - in: query name: customer schema: type: string format: uuid - in: query name: full_name schema: type: string description: User full name contains - in: query name: modified schema: type: string format: date-time description: Modified after - in: query name: native_name schema: type: string - in: query name: o schema: type: array items: type: string enum: - -created - -email - -expiration_time - -full_name - -native_name - -role - -username - created - email - expiration_time - full_name - native_name - role - username description: |+ Ordering explode: false style: form - in: query name: offering schema: type: string format: uuid - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: role_name schema: type: string description: Role name contains - in: query name: role_uuid schema: type: string format: uuid description: Role UUID - in: query name: scope_name schema: type: string description: Scope name - in: query name: scope_type schema: type: string description: Scope type - in: query name: scope_uuid schema: type: string description: Scope UUID - in: query name: user schema: type: string format: uuid - in: query name: user_slug schema: type: string description: User slug contains - in: query name: user_url schema: type: string - in: query name: username schema: type: string tags: - marketplace-offering-permissions security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/OfferingPermission' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' head: operationId: marketplace_offering_permissions_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: created schema: type: string format: date-time description: Created after - in: query name: customer schema: type: string format: uuid - in: query name: full_name schema: type: string description: User full name contains - in: query name: modified schema: type: string format: date-time description: Modified after - in: query name: native_name schema: type: string - in: query name: o schema: type: array items: type: string enum: - -created - -email - -expiration_time - -full_name - -native_name - -role - -username - created - email - expiration_time - full_name - native_name - role - username description: |+ Ordering explode: false style: form - in: query name: offering schema: type: string format: uuid - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: role_name schema: type: string description: Role name contains - in: query name: role_uuid schema: type: string format: uuid description: Role UUID - in: query name: scope_name schema: type: string description: Scope name - in: query name: scope_type schema: type: string description: Scope type - in: query name: scope_uuid schema: type: string description: Scope UUID - in: query name: user schema: type: string format: uuid - in: query name: user_slug schema: type: string description: User slug contains - in: query name: user_url schema: type: string - in: query name: username schema: type: string tags: - marketplace-offering-permissions security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/marketplace-offering-permissions-log/: get: operationId: marketplace_offering_permissions_log_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: created schema: type: string format: date-time description: Created after - in: query name: customer schema: type: string format: uuid - in: query name: full_name schema: type: string description: User full name contains - in: query name: modified schema: type: string format: date-time description: Modified after - in: query name: native_name schema: type: string - in: query name: o schema: type: array items: type: string enum: - -created - -email - -expiration_time - -full_name - -native_name - -role - -username - created - email - expiration_time - full_name - native_name - role - username description: |+ Ordering explode: false style: form - in: query name: offering schema: type: string format: uuid - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: role_name schema: type: string description: Role name contains - in: query name: role_uuid schema: type: string format: uuid description: Role UUID - in: query name: scope_name schema: type: string description: Scope name - in: query name: scope_type schema: type: string description: Scope type - in: query name: scope_uuid schema: type: string description: Scope UUID - in: query name: user schema: type: string format: uuid - in: query name: user_slug schema: type: string description: User slug contains - in: query name: user_url schema: type: string - in: query name: username schema: type: string tags: - marketplace-offering-permissions-log security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/OfferingPermission' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' head: operationId: marketplace_offering_permissions_log_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: created schema: type: string format: date-time description: Created after - in: query name: customer schema: type: string format: uuid - in: query name: full_name schema: type: string description: User full name contains - in: query name: modified schema: type: string format: date-time description: Modified after - in: query name: native_name schema: type: string - in: query name: o schema: type: array items: type: string enum: - -created - -email - -expiration_time - -full_name - -native_name - -role - -username - created - email - expiration_time - full_name - native_name - role - username description: |+ Ordering explode: false style: form - in: query name: offering schema: type: string format: uuid - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: role_name schema: type: string description: Role name contains - in: query name: role_uuid schema: type: string format: uuid description: Role UUID - in: query name: scope_name schema: type: string description: Scope name - in: query name: scope_type schema: type: string description: Scope type - in: query name: scope_uuid schema: type: string description: Scope UUID - in: query name: user schema: type: string format: uuid - in: query name: user_slug schema: type: string description: User slug contains - in: query name: user_url schema: type: string - in: query name: username schema: type: string tags: - marketplace-offering-permissions-log security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/marketplace-offering-permissions-log/{id}/: get: operationId: marketplace_offering_permissions_log_retrieve parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this user role. required: true tags: - marketplace-offering-permissions-log security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OfferingPermission' description: '' /api/marketplace-offering-permissions/{id}/: get: operationId: marketplace_offering_permissions_retrieve parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this user role. required: true tags: - marketplace-offering-permissions security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OfferingPermission' description: '' /api/marketplace-offering-referrals/: get: operationId: marketplace_offering_referrals_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: o schema: type: array items: type: string enum: - -published - -relation_type - -resource_type - published - relation_type - resource_type description: |+ Ordering explode: false style: form - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - marketplace-offering-referrals security: - tokenAuth: [] - waldurOIDCAuth: [] - {} responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/OfferingReferral' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' head: operationId: marketplace_offering_referrals_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: o schema: type: array items: type: string enum: - -published - -relation_type - -resource_type - published - relation_type - resource_type description: |+ Ordering explode: false style: form - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - marketplace-offering-referrals security: - tokenAuth: [] - waldurOIDCAuth: [] - {} responses: '200': description: No response body /api/marketplace-offering-referrals/{uuid}/: get: operationId: marketplace_offering_referrals_retrieve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-offering-referrals security: - tokenAuth: [] - waldurOIDCAuth: [] - {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/OfferingReferral' description: '' /api/marketplace-offering-terms-of-service/: get: operationId: marketplace_offering_terms_of_service_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: is_active schema: type: boolean - in: query name: o schema: type: array items: type: string enum: - -created - -modified - -version - created - modified - version description: |+ Ordering explode: false style: form - in: query name: offering schema: type: string - in: query name: offering_uuid schema: type: string format: uuid - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: requires_reconsent schema: type: boolean - in: query name: version schema: type: string tags: - marketplace-offering-terms-of-service security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/OfferingTermsOfService' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' post: operationId: marketplace_offering_terms_of_service_create tags: - marketplace-offering-terms-of-service requestBody: content: application/json: schema: $ref: '#/components/schemas/OfferingTermsOfServiceCreateRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/OfferingTermsOfServiceCreate' description: '' x-permissions: - permission: OFFERING.UPDATE scopes: - offering.customer head: operationId: marketplace_offering_terms_of_service_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: is_active schema: type: boolean - in: query name: o schema: type: array items: type: string enum: - -created - -modified - -version - created - modified - version description: |+ Ordering explode: false style: form - in: query name: offering schema: type: string - in: query name: offering_uuid schema: type: string format: uuid - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: requires_reconsent schema: type: boolean - in: query name: version schema: type: string tags: - marketplace-offering-terms-of-service security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/marketplace-offering-terms-of-service/{uuid}/: get: operationId: marketplace_offering_terms_of_service_retrieve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-offering-terms-of-service security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OfferingTermsOfService' description: '' put: operationId: marketplace_offering_terms_of_service_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-offering-terms-of-service requestBody: content: application/json: schema: $ref: '#/components/schemas/OfferingTermsOfServiceRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OfferingTermsOfService' description: '' x-permissions: - permission: OFFERING.UPDATE scopes: - offering.customer patch: operationId: marketplace_offering_terms_of_service_partial_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-offering-terms-of-service requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedOfferingTermsOfServiceRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OfferingTermsOfService' description: '' x-permissions: - permission: OFFERING.UPDATE scopes: - offering.customer delete: operationId: marketplace_offering_terms_of_service_destroy parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-offering-terms-of-service security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '204': description: No response body x-permissions: - permission: OFFERING.UPDATE scopes: - offering.customer /api/marketplace-offering-usage-policies/: get: operationId: marketplace_offering_usage_policies_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: scope schema: type: string - in: query name: scope_uuid schema: type: string format: uuid tags: - marketplace-offering-usage-policies security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/OfferingUsagePolicy' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' post: operationId: marketplace_offering_usage_policies_create tags: - marketplace-offering-usage-policies requestBody: content: application/json: schema: $ref: '#/components/schemas/OfferingUsagePolicyRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/OfferingUsagePolicy' description: '' head: operationId: marketplace_offering_usage_policies_count description: Get number of items in the collection matching the request parameters. parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: scope schema: type: string - in: query name: scope_uuid schema: type: string format: uuid tags: - marketplace-offering-usage-policies security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/marketplace-offering-usage-policies/{uuid}/: get: operationId: marketplace_offering_usage_policies_retrieve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-offering-usage-policies security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OfferingUsagePolicy' description: '' put: operationId: marketplace_offering_usage_policies_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-offering-usage-policies requestBody: content: application/json: schema: $ref: '#/components/schemas/OfferingUsagePolicyRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OfferingUsagePolicy' description: '' patch: operationId: marketplace_offering_usage_policies_partial_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-offering-usage-policies requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedOfferingUsagePolicyRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OfferingUsagePolicy' description: '' delete: operationId: marketplace_offering_usage_policies_destroy parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-offering-usage-policies security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '204': description: No response body /api/marketplace-offering-usage-policies/actions/: get: operationId: marketplace_offering_usage_policies_actions_retrieve tags: - marketplace-offering-usage-policies security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OfferingUsagePolicy' description: '' head: operationId: marketplace_offering_usage_policies_actions_count tags: - marketplace-offering-usage-policies security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body description: Get number of items in the collection matching the request parameters. /api/marketplace-offering-user-roles/: get: operationId: marketplace_offering_user_roles_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: offering schema: type: string - in: query name: offering_slug schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: offering_uuid schema: type: array items: type: string format: uuid description: Multiple values may be separated by commas. explode: false style: form - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: parent_offering_uuid schema: type: string format: uuid tags: - marketplace-offering-user-roles security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/OfferingUserRole' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' post: operationId: marketplace_offering_user_roles_create tags: - marketplace-offering-user-roles requestBody: content: application/json: schema: $ref: '#/components/schemas/OfferingUserRoleRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/OfferingUserRole' description: '' head: operationId: marketplace_offering_user_roles_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: offering schema: type: string - in: query name: offering_slug schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: offering_uuid schema: type: array items: type: string format: uuid description: Multiple values may be separated by commas. explode: false style: form - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: parent_offering_uuid schema: type: string format: uuid tags: - marketplace-offering-user-roles security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/marketplace-offering-user-roles/{uuid}/: get: operationId: marketplace_offering_user_roles_retrieve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-offering-user-roles security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OfferingUserRole' description: '' put: operationId: marketplace_offering_user_roles_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-offering-user-roles requestBody: content: application/json: schema: $ref: '#/components/schemas/OfferingUserRoleRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OfferingUserRole' description: '' patch: operationId: marketplace_offering_user_roles_partial_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-offering-user-roles requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedOfferingUserRoleRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OfferingUserRole' description: '' delete: operationId: marketplace_offering_user_roles_destroy parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-offering-user-roles security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '204': description: No response body /api/marketplace-offering-users/: get: operationId: marketplace_offering_users_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: created schema: type: string format: date-time description: Created after - in: query name: field schema: type: array items: type: string enum: - created - customer_name - customer_uuid - is_restricted - modified - offering - offering_name - offering_uuid - service_provider_comment - service_provider_comment_url - state - url - user - user_email - user_full_name - user_username - user_uuid - username - uuid - in: query name: is_restricted schema: type: boolean - in: query name: modified schema: type: string format: date-time description: Modified after - in: query name: o schema: type: array items: type: string enum: - -created - -modified - -username - created - modified - username description: |+ Ordering explode: false style: form - in: query name: offering schema: type: string - in: query name: offering_slug schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: offering_uuid schema: type: array items: type: string format: uuid description: Multiple values may be separated by commas. explode: false style: form - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: parent_offering_uuid schema: type: string format: uuid - in: query name: provider_uuid schema: type: string format: uuid - in: query name: query schema: type: string description: Search by offering name, username or user name - in: query name: state schema: type: array items: type: string enum: - Creating - Deleted - Deleting - Error creating - Error deleting - OK - Pending account linking - Pending additional validation - Requested - Requested deletion explode: true style: form - in: query name: user_username schema: type: string - in: query name: user_uuid schema: type: string format: uuid tags: - marketplace-offering-users security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/OfferingUser' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' post: operationId: marketplace_offering_users_create tags: - marketplace-offering-users requestBody: content: application/json: schema: $ref: '#/components/schemas/OfferingUserRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/OfferingUser' description: '' head: operationId: marketplace_offering_users_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: created schema: type: string format: date-time description: Created after - in: query name: is_restricted schema: type: boolean - in: query name: modified schema: type: string format: date-time description: Modified after - in: query name: o schema: type: array items: type: string enum: - -created - -modified - -username - created - modified - username description: |+ Ordering explode: false style: form - in: query name: offering schema: type: string - in: query name: offering_slug schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: offering_uuid schema: type: array items: type: string format: uuid description: Multiple values may be separated by commas. explode: false style: form - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: parent_offering_uuid schema: type: string format: uuid - in: query name: provider_uuid schema: type: string format: uuid - in: query name: query schema: type: string description: Search by offering name, username or user name - in: query name: state schema: type: array items: type: string enum: - Creating - Deleted - Deleting - Error creating - Error deleting - OK - Pending account linking - Pending additional validation - Requested - Requested deletion explode: true style: form - in: query name: user_username schema: type: string - in: query name: user_uuid schema: type: string format: uuid tags: - marketplace-offering-users security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/marketplace-offering-users/{uuid}/: get: operationId: marketplace_offering_users_retrieve parameters: - in: query name: field schema: type: array items: type: string enum: - created - customer_name - customer_uuid - is_restricted - modified - offering - offering_name - offering_uuid - service_provider_comment - service_provider_comment_url - state - url - user - user_email - user_full_name - user_username - user_uuid - username - uuid - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-offering-users security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OfferingUser' description: '' put: operationId: marketplace_offering_users_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-offering-users requestBody: content: application/json: schema: $ref: '#/components/schemas/OfferingUserRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OfferingUser' description: '' patch: operationId: marketplace_offering_users_partial_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-offering-users requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedOfferingUserRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OfferingUser' description: '' delete: operationId: marketplace_offering_users_destroy parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-offering-users security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '204': description: No response body /api/marketplace-offering-users/{uuid}/begin_creating/: post: operationId: marketplace_offering_users_begin_creating parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-offering-users security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body x-permissions: - permission: OFFERING.UPDATE_USER scopes: - offering.customer /api/marketplace-offering-users/{uuid}/checklist/: get: operationId: marketplace_offering_users_checklist_retrieve description: Get checklist with questions and existing answers. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-offering-users security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ChecklistResponse' description: '' '400': content: application/json: schema: description: No checklist configured description: '' '404': content: application/json: schema: description: Object not found description: '' /api/marketplace-offering-users/{uuid}/checklist_review/: get: operationId: marketplace_offering_users_checklist_review_retrieve description: Get checklist with questions and existing answers including review logic (reviewers only). parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-offering-users security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ChecklistReviewerResponse' description: '' '400': content: application/json: schema: description: No checklist configured description: '' '404': content: application/json: schema: description: Object not found description: '' x-permissions: - permission: OFFERING.UPDATE_USER scopes: - offering.customer /api/marketplace-offering-users/{uuid}/completion_review_status/: get: operationId: marketplace_offering_users_completion_review_status_retrieve description: Get checklist completion status with review triggers (reviewers only). parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-offering-users security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ChecklistCompletionReviewer' description: '' '400': content: application/json: schema: description: No checklist configured description: '' '404': content: application/json: schema: description: Object not found description: '' x-permissions: - permission: OFFERING.UPDATE_USER scopes: - offering.customer /api/marketplace-offering-users/{uuid}/completion_status/: get: operationId: marketplace_offering_users_completion_status_retrieve description: Get checklist completion status. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-offering-users security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ChecklistCompletion' description: '' '400': content: application/json: schema: description: No checklist configured description: '' '404': content: application/json: schema: description: Object not found description: '' /api/marketplace-offering-users/{uuid}/request_deletion/: post: operationId: marketplace_offering_users_request_deletion description: Action to request deletion of an offering user account. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-offering-users security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body x-permissions: - permission: OFFERING.UPDATE_USER scopes: - offering.customer /api/marketplace-offering-users/{uuid}/set_deleted/: post: operationId: marketplace_offering_users_set_deleted description: Action to mark an offering user as successfully deleted. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-offering-users security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body x-permissions: - permission: OFFERING.UPDATE_USER scopes: - offering.customer /api/marketplace-offering-users/{uuid}/set_deleting/: post: operationId: marketplace_offering_users_set_deleting description: Action to begin the deletion process for an offering user. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-offering-users security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body x-permissions: - permission: OFFERING.UPDATE_USER scopes: - offering.customer /api/marketplace-offering-users/{uuid}/set_error_creating/: post: operationId: marketplace_offering_users_set_error_creating parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-offering-users security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/marketplace-offering-users/{uuid}/set_error_deleting/: post: operationId: marketplace_offering_users_set_error_deleting parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-offering-users security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/marketplace-offering-users/{uuid}/set_ok/: post: operationId: marketplace_offering_users_set_ok parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-offering-users security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/marketplace-offering-users/{uuid}/set_pending_account_linking/: post: operationId: marketplace_offering_users_set_pending_account_linking parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-offering-users requestBody: content: application/json: schema: $ref: '#/components/schemas/OfferingUserStateTransitionRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body x-permissions: - permission: OFFERING.UPDATE_USER scopes: - offering.customer /api/marketplace-offering-users/{uuid}/set_pending_additional_validation/: post: operationId: marketplace_offering_users_set_pending_additional_validation parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-offering-users requestBody: content: application/json: schema: $ref: '#/components/schemas/OfferingUserStateTransitionRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body x-permissions: - permission: OFFERING.UPDATE_USER scopes: - offering.customer /api/marketplace-offering-users/{uuid}/set_validation_complete/: post: operationId: marketplace_offering_users_set_validation_complete parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-offering-users security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body x-permissions: - permission: OFFERING.UPDATE_USER scopes: - offering.customer /api/marketplace-offering-users/{uuid}/submit_answers/: post: operationId: marketplace_offering_users_submit_answers description: Submit checklist answers. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-offering-users requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/AnswerSubmitRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/AnswerSubmitResponse' description: '' '400': content: application/json: schema: description: Validation error or no checklist configured description: '' '404': content: application/json: schema: description: Object not found description: '' /api/marketplace-offering-users/{uuid}/update_comments/: patch: operationId: marketplace_offering_users_update_comments_partial_update description: Action for service providers to update comment and comment URL fields. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-offering-users requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedOfferingUserServiceProviderCommentRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OfferingUserServiceProviderComment' description: '' /api/marketplace-offering-users/{uuid}/update_restricted/: post: operationId: marketplace_offering_users_update_restricted parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-offering-users requestBody: content: application/json: schema: $ref: '#/components/schemas/OfferingUserUpdateRestrictionRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/marketplace-orders/: get: operationId: marketplace_orders_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: can_approve_as_consumer schema: type: boolean - in: query name: can_approve_as_provider schema: type: boolean - in: query name: category_uuid schema: type: string format: uuid - in: query name: created schema: type: string format: date-time description: Created after - in: query name: customer_uuid schema: type: string format: uuid - in: query name: field schema: type: array items: type: string enum: - accepting_terms_of_service - activation_price - attributes - backend_id - callback_url - can_terminate - category_icon - category_title - category_uuid - completed_at - consumer_reviewed_at - consumer_reviewed_by - consumer_reviewed_by_full_name - consumer_reviewed_by_username - cost - created - created_by_civil_number - created_by_full_name - created_by_username - customer_name - customer_slug - customer_uuid - error_message - error_traceback - fixed_price - issue - limits - marketplace_resource_uuid - modified - new_cost_estimate - new_plan_name - new_plan_uuid - offering - offering_billable - offering_description - offering_image - offering_name - offering_plugin_options - offering_shared - offering_thumbnail - offering_type - offering_uuid - old_cost_estimate - old_plan_name - old_plan_uuid - output - plan - plan_description - plan_name - plan_unit - plan_uuid - project_description - project_name - project_slug - project_uuid - provider_name - provider_reviewed_at - provider_reviewed_by - provider_reviewed_by_full_name - provider_reviewed_by_username - provider_uuid - resource_name - resource_type - resource_uuid - state - termination_comment - type - uuid - in: query name: modified schema: type: string format: date-time description: Modified after - in: query name: o schema: type: array items: type: string enum: - -consumer_reviewed_at - -cost - -created - -state - consumer_reviewed_at - cost - created - state description: |+ Ordering explode: false style: form - in: query name: offering schema: type: string - in: query name: offering_slug schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: offering_type schema: type: array items: type: string explode: true style: form - in: query name: offering_uuid schema: type: string format: uuid - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: parent_offering_uuid schema: type: string format: uuid - in: query name: project_uuid schema: type: string format: uuid - in: query name: provider_uuid schema: type: string format: uuid - in: query name: query schema: type: string description: Search by order UUID, project name or resource name - in: query name: resource schema: type: string - in: query name: resource_uuid schema: type: string format: uuid - in: query name: service_manager_uuid schema: type: string format: uuid - in: query name: state schema: type: array items: type: string enum: - canceled - done - erred - executing - pending-consumer - pending-project - pending-provider - rejected explode: true style: form - in: query name: type schema: type: array items: type: string enum: - Create - Terminate - Update explode: true style: form tags: - marketplace-orders security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/OrderDetails' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' post: operationId: marketplace_orders_create tags: - marketplace-orders requestBody: content: application/json: schema: $ref: '#/components/schemas/OrderCreateRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/OrderCreate' description: '' head: operationId: marketplace_orders_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: can_approve_as_consumer schema: type: boolean - in: query name: can_approve_as_provider schema: type: boolean - in: query name: category_uuid schema: type: string format: uuid - in: query name: created schema: type: string format: date-time description: Created after - in: query name: customer_uuid schema: type: string format: uuid - in: query name: modified schema: type: string format: date-time description: Modified after - in: query name: o schema: type: array items: type: string enum: - -consumer_reviewed_at - -cost - -created - -state - consumer_reviewed_at - cost - created - state description: |+ Ordering explode: false style: form - in: query name: offering schema: type: string - in: query name: offering_slug schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: offering_type schema: type: array items: type: string explode: true style: form - in: query name: offering_uuid schema: type: string format: uuid - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: parent_offering_uuid schema: type: string format: uuid - in: query name: project_uuid schema: type: string format: uuid - in: query name: provider_uuid schema: type: string format: uuid - in: query name: query schema: type: string description: Search by order UUID, project name or resource name - in: query name: resource schema: type: string - in: query name: resource_uuid schema: type: string format: uuid - in: query name: service_manager_uuid schema: type: string format: uuid - in: query name: state schema: type: array items: type: string enum: - canceled - done - erred - executing - pending-consumer - pending-project - pending-provider - rejected explode: true style: form - in: query name: type schema: type: array items: type: string enum: - Create - Terminate - Update explode: true style: form tags: - marketplace-orders security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/marketplace-orders/{uuid}/: get: operationId: marketplace_orders_retrieve parameters: - in: query name: field schema: type: array items: type: string enum: - accepting_terms_of_service - activation_price - attributes - backend_id - callback_url - can_terminate - category_icon - category_title - category_uuid - completed_at - consumer_reviewed_at - consumer_reviewed_by - consumer_reviewed_by_full_name - consumer_reviewed_by_username - cost - created - created_by_civil_number - created_by_full_name - created_by_username - customer_name - customer_slug - customer_uuid - error_message - error_traceback - fixed_price - issue - limits - marketplace_resource_uuid - modified - new_cost_estimate - new_plan_name - new_plan_uuid - offering - offering_billable - offering_description - offering_image - offering_name - offering_plugin_options - offering_shared - offering_thumbnail - offering_type - offering_uuid - old_cost_estimate - old_plan_name - old_plan_uuid - output - plan - plan_description - plan_name - plan_unit - plan_uuid - project_description - project_name - project_slug - project_uuid - provider_name - provider_reviewed_at - provider_reviewed_by - provider_reviewed_by_full_name - provider_reviewed_by_username - provider_uuid - resource_name - resource_type - resource_uuid - state - termination_comment - type - uuid - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-orders security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OrderDetails' description: '' delete: operationId: marketplace_orders_destroy parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-orders security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '204': description: No response body x-permissions: - permission: ORDER.DESTROY scopes: - project - project.customer /api/marketplace-orders/{uuid}/approve_by_consumer/: post: operationId: marketplace_orders_approve_by_consumer parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-orders security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body x-permissions: - permission: ORDER.APPROVE scopes: - project - project.customer /api/marketplace-orders/{uuid}/approve_by_provider/: post: operationId: marketplace_orders_approve_by_provider parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-orders security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body x-permissions: - permission: ORDER.APPROVE scopes: - offering.customer /api/marketplace-orders/{uuid}/cancel/: post: operationId: marketplace_orders_cancel parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-orders security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body x-permissions: - permission: ORDER.CANCEL scopes: - project - project.customer /api/marketplace-orders/{uuid}/offering/: get: operationId: marketplace_orders_offering_retrieve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-orders security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PublicOfferingDetails' description: '' /api/marketplace-orders/{uuid}/reject_by_consumer/: post: operationId: marketplace_orders_reject_by_consumer parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-orders security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/marketplace-orders/{uuid}/reject_by_provider/: post: operationId: marketplace_orders_reject_by_provider parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-orders security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body x-permissions: - permission: ORDER.REJECT scopes: - offering.customer /api/marketplace-orders/{uuid}/set_state_done/: post: operationId: marketplace_orders_set_state_done parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-orders security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body x-permissions: - permission: ORDER.APPROVE scopes: - offering.customer /api/marketplace-orders/{uuid}/set_state_erred/: post: operationId: marketplace_orders_set_state_erred parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-orders requestBody: content: application/json: schema: $ref: '#/components/schemas/OrderSetStateErredRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body x-permissions: - permission: ORDER.APPROVE scopes: - offering.customer - offering.customer.serviceprovider /api/marketplace-orders/{uuid}/set_state_executing/: post: operationId: marketplace_orders_set_state_executing parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-orders security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body x-permissions: - permission: ORDER.APPROVE scopes: - offering.customer /api/marketplace-orders/{uuid}/unlink/: post: operationId: marketplace_orders_unlink parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-orders security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '403': description: No response body '204': description: No response body /api/marketplace-plan-components/: get: operationId: marketplace_plan_components_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: archived schema: type: boolean - in: query name: offering_uuid schema: type: string format: uuid description: Offering UUID - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: plan_uuid schema: type: string format: uuid description: Plan UUID - in: query name: shared schema: type: boolean tags: - marketplace-plan-components security: - tokenAuth: [] - waldurOIDCAuth: [] - {} responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/PlanComponent' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' head: operationId: marketplace_plan_components_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: archived schema: type: boolean - in: query name: offering_uuid schema: type: string format: uuid description: Offering UUID - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: plan_uuid schema: type: string format: uuid description: Plan UUID - in: query name: shared schema: type: boolean tags: - marketplace-plan-components security: - tokenAuth: [] - waldurOIDCAuth: [] - {} responses: '200': description: No response body /api/marketplace-plan-components/{id}/: get: operationId: marketplace_plan_components_retrieve parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this plan component. required: true tags: - marketplace-plan-components security: - tokenAuth: [] - waldurOIDCAuth: [] - {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/PlanComponent' description: '' /api/marketplace-plans/: get: operationId: marketplace_plans_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: offering schema: type: string - in: query name: offering_slug schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: offering_uuid schema: type: string format: uuid - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: parent_offering_uuid schema: type: string format: uuid tags: - marketplace-plans security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/ProviderPlanDetails' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' post: operationId: marketplace_plans_create tags: - marketplace-plans requestBody: content: application/json: schema: $ref: '#/components/schemas/ProviderPlanDetailsRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/ProviderPlanDetails' description: '' head: operationId: marketplace_plans_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: offering schema: type: string - in: query name: offering_slug schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: offering_uuid schema: type: string format: uuid - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: parent_offering_uuid schema: type: string format: uuid tags: - marketplace-plans security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/marketplace-plans/{uuid}/: get: operationId: marketplace_plans_retrieve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-plans security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ProviderPlanDetails' description: '' put: operationId: marketplace_plans_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-plans requestBody: content: application/json: schema: $ref: '#/components/schemas/ProviderPlanDetailsRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ProviderPlanDetails' description: '' x-permissions: - permission: OFFERING.UPDATE_PLAN scopes: - offering.customer patch: operationId: marketplace_plans_partial_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-plans requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedProviderPlanDetailsRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ProviderPlanDetails' description: '' x-permissions: - permission: OFFERING.UPDATE_PLAN scopes: - offering.customer delete: operationId: marketplace_plans_destroy parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-plans security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '204': description: No response body /api/marketplace-plans/{uuid}/archive/: post: operationId: marketplace_plans_archive parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-plans security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body x-permissions: - permission: OFFERING.ARCHIVE_PLAN scopes: - offering.customer /api/marketplace-plans/{uuid}/delete_organization_groups/: post: operationId: marketplace_plans_delete_organization_groups parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-plans security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body x-permissions: - permission: OFFERING.UPDATE_PLAN scopes: - offering.customer /api/marketplace-plans/{uuid}/update_organization_groups/: post: operationId: marketplace_plans_update_organization_groups parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-plans requestBody: content: application/json: schema: $ref: '#/components/schemas/OrganizationGroupsRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body x-permissions: - permission: OFFERING.UPDATE_PLAN scopes: - offering.customer /api/marketplace-plans/{uuid}/update_prices/: post: operationId: marketplace_plans_update_prices parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-plans requestBody: content: application/json: schema: $ref: '#/components/schemas/PricesUpdateRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body x-permissions: - permission: OFFERING.UPDATE_PLAN scopes: - offering.customer /api/marketplace-plans/{uuid}/update_quotas/: post: operationId: marketplace_plans_update_quotas parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-plans requestBody: content: application/json: schema: $ref: '#/components/schemas/QuotasUpdateRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body x-permissions: - permission: OFFERING.UPDATE_PLAN scopes: - offering.customer /api/marketplace-plans/usage_stats/: get: operationId: marketplace_plans_usage_stats_list parameters: - in: query name: customer_provider_uuid schema: type: string - in: query name: o schema: type: string - in: query name: offering schema: type: string - in: query name: offering_slug schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: offering_uuid schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: parent_offering_uuid schema: type: string format: uuid tags: - marketplace-plans security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/PlanUsageResponse' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' head: operationId: marketplace_plans_usage_stats_count parameters: - in: query name: customer_provider_uuid schema: type: string - in: query name: o schema: type: string - in: query name: offering schema: type: string - in: query name: offering_slug schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: offering_uuid schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: parent_offering_uuid schema: type: string format: uuid tags: - marketplace-plans security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body description: Get number of items in the collection matching the request parameters. /api/marketplace-plugins/: get: operationId: marketplace_plugins_list tags: - marketplace-plugins responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/PluginOfferingType' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' /api/marketplace-project-estimated-cost-policies/: get: operationId: marketplace_project_estimated_cost_policies_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: customer schema: type: string - in: query name: customer_uuid schema: type: string format: uuid - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: project schema: type: string - in: query name: project_uuid schema: type: string format: uuid - in: query name: scope schema: type: string - in: query name: scope_uuid schema: type: string format: uuid tags: - marketplace-project-estimated-cost-policies security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/ProjectEstimatedCostPolicy' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' post: operationId: marketplace_project_estimated_cost_policies_create tags: - marketplace-project-estimated-cost-policies requestBody: content: application/json: schema: $ref: '#/components/schemas/ProjectEstimatedCostPolicyRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/ProjectEstimatedCostPolicy' description: '' head: operationId: marketplace_project_estimated_cost_policies_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: customer schema: type: string - in: query name: customer_uuid schema: type: string format: uuid - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: project schema: type: string - in: query name: project_uuid schema: type: string format: uuid - in: query name: scope schema: type: string - in: query name: scope_uuid schema: type: string format: uuid tags: - marketplace-project-estimated-cost-policies security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/marketplace-project-estimated-cost-policies/{uuid}/: get: operationId: marketplace_project_estimated_cost_policies_retrieve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-project-estimated-cost-policies security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ProjectEstimatedCostPolicy' description: '' put: operationId: marketplace_project_estimated_cost_policies_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-project-estimated-cost-policies requestBody: content: application/json: schema: $ref: '#/components/schemas/ProjectEstimatedCostPolicyRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ProjectEstimatedCostPolicy' description: '' patch: operationId: marketplace_project_estimated_cost_policies_partial_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-project-estimated-cost-policies requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedProjectEstimatedCostPolicyRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ProjectEstimatedCostPolicy' description: '' delete: operationId: marketplace_project_estimated_cost_policies_destroy parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-project-estimated-cost-policies security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '204': description: No response body /api/marketplace-project-estimated-cost-policies/actions/: get: operationId: marketplace_project_estimated_cost_policies_actions_retrieve tags: - marketplace-project-estimated-cost-policies security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ProjectEstimatedCostPolicy' description: '' head: operationId: marketplace_project_estimated_cost_policies_actions_count tags: - marketplace-project-estimated-cost-policies security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body description: Get number of items in the collection matching the request parameters. /api/marketplace-project-service-accounts/: get: operationId: marketplace_project_service_accounts_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: email schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: project schema: type: string - in: query name: project_uuid schema: type: string format: uuid - in: query name: state schema: type: array items: type: string enum: - Closed - Erred - OK explode: true style: form - in: query name: username schema: type: string tags: - marketplace-project-service-accounts security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/ProjectServiceAccount' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' post: operationId: marketplace_project_service_accounts_create tags: - marketplace-project-service-accounts requestBody: content: application/json: schema: $ref: '#/components/schemas/ProjectServiceAccountRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/ProjectServiceAccount' description: '' head: operationId: marketplace_project_service_accounts_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: email schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: project schema: type: string - in: query name: project_uuid schema: type: string format: uuid - in: query name: state schema: type: array items: type: string enum: - Closed - Erred - OK explode: true style: form - in: query name: username schema: type: string tags: - marketplace-project-service-accounts security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/marketplace-project-service-accounts/{uuid}/: get: operationId: marketplace_project_service_accounts_retrieve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-project-service-accounts security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ProjectServiceAccount' description: '' put: operationId: marketplace_project_service_accounts_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-project-service-accounts requestBody: content: application/json: schema: $ref: '#/components/schemas/ProjectServiceAccountRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ProjectServiceAccount' description: '' x-permissions: - permission: SERVICE_ACCOUNT.MANAGE scopes: - project - project.customer patch: operationId: marketplace_project_service_accounts_partial_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-project-service-accounts requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedProjectServiceAccountRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ProjectServiceAccount' description: '' x-permissions: - permission: SERVICE_ACCOUNT.MANAGE scopes: - project - project.customer delete: operationId: marketplace_project_service_accounts_destroy parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-project-service-accounts security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '204': description: No response body x-permissions: - permission: SERVICE_ACCOUNT.MANAGE scopes: - project - project.customer /api/marketplace-project-service-accounts/{uuid}/rotate_api_key/: post: operationId: marketplace_project_service_accounts_rotate_api_key parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-project-service-accounts security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ProjectServiceAccount' description: '' x-permissions: - permission: SERVICE_ACCOUNT.MANAGE scopes: - project - project.customer /api/marketplace-project-update-requests/: get: operationId: marketplace_project_update_requests_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: customer_uuid schema: type: string format: uuid - in: query name: offering_customer_uuid schema: type: string format: uuid - in: query name: offering_uuid schema: type: string format: uuid - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: project_uuid schema: type: string format: uuid - in: query name: state schema: type: array items: type: string enum: - approved - canceled - draft - pending - rejected explode: true style: form tags: - marketplace-project-update-requests security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/RemoteProjectUpdateRequest' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' head: operationId: marketplace_project_update_requests_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: customer_uuid schema: type: string format: uuid - in: query name: offering_customer_uuid schema: type: string format: uuid - in: query name: offering_uuid schema: type: string format: uuid - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: project_uuid schema: type: string format: uuid - in: query name: state schema: type: array items: type: string enum: - approved - canceled - draft - pending - rejected explode: true style: form tags: - marketplace-project-update-requests security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/marketplace-project-update-requests/{uuid}/: get: operationId: marketplace_project_update_requests_retrieve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-project-update-requests security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RemoteProjectUpdateRequest' description: '' /api/marketplace-project-update-requests/{uuid}/approve/: post: operationId: marketplace_project_update_requests_approve description: Approve project update request parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-project-update-requests requestBody: content: application/json: schema: $ref: '#/components/schemas/ReviewCommentRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/marketplace-project-update-requests/{uuid}/reject/: post: operationId: marketplace_project_update_requests_reject description: Reject project update request parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-project-update-requests requestBody: content: application/json: schema: $ref: '#/components/schemas/ReviewCommentRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/marketplace-provider-offerings/: get: operationId: marketplace_provider_offerings_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: accessible_via_calls schema: type: boolean description: Accessible via calls - in: query name: allowed_customer_uuid schema: type: string format: uuid description: Allowed customer UUID - in: query name: attributes schema: type: string - in: query name: billable schema: type: boolean - in: query name: category_group_uuid schema: type: string format: uuid - in: query name: category_uuid schema: type: string format: uuid - in: query name: created schema: type: string format: date-time description: Created after - in: query name: customer schema: type: string - in: query name: customer_uuid schema: type: string format: uuid - in: query name: description schema: type: string - in: query name: field schema: type: array items: type: string enum: - access_url - attributes - backend_id - backend_metadata - billable - category - category_title - category_uuid - citation_count - components - country - created - customer - customer_name - customer_uuid - datacite_doi - description - endpoints - files - full_description - getting_started - google_calendar_is_public - google_calendar_link - has_compliance_requirements - image - integration_guide - integration_status - latitude - longitude - name - options - order_count - organization_groups - parent_description - parent_name - parent_uuid - paused_reason - plans - plugin_options - privacy_policy_link - project - project_name - project_uuid - quotas - resource_options - roles - scope - scope_error_message - scope_name - scope_state - scope_uuid - screenshots - secret_options - service_attributes - shared - slug - state - thumbnail - total_cost - total_cost_estimated - total_customers - type - url - uuid - vendor_details - in: query name: keyword schema: type: string description: Keyword - in: query name: modified schema: type: string format: date-time description: Modified after - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - in: query name: o schema: type: array items: type: string enum: - -created - -name - -state - -total_cost - -total_cost_estimated - -total_customers - -type - created - name - state - total_cost - total_cost_estimated - total_customers - type description: |+ Ordering explode: false style: form - in: query name: organization_group_uuid schema: type: array items: type: string format: uuid explode: true style: form - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: parent_uuid schema: type: string format: uuid - in: query name: project_uuid schema: type: string format: uuid description: Project UUID - in: query name: resource_customer_uuid schema: type: string format: uuid description: Resource customer UUID - in: query name: resource_project_uuid schema: type: string format: uuid description: Resource project UUID - in: query name: scope_uuid schema: type: string description: Scope UUID - in: query name: service_manager_uuid schema: type: string format: uuid description: Service manager UUID - in: query name: shared schema: type: boolean - in: query name: state schema: type: array items: type: string enum: - Active - Archived - Draft - Paused explode: true style: form - in: query name: type schema: type: array items: type: string explode: true style: form - in: query name: uuid_list schema: type: string description: Comma-separated offering UUIDs tags: - marketplace-provider-offerings security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/ProviderOfferingDetails' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' post: operationId: marketplace_provider_offerings_create tags: - marketplace-provider-offerings requestBody: content: application/json: schema: $ref: '#/components/schemas/OfferingCreateRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/OfferingCreate' description: '' head: operationId: marketplace_provider_offerings_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: accessible_via_calls schema: type: boolean description: Accessible via calls - in: query name: allowed_customer_uuid schema: type: string format: uuid description: Allowed customer UUID - in: query name: attributes schema: type: string - in: query name: billable schema: type: boolean - in: query name: category_group_uuid schema: type: string format: uuid - in: query name: category_uuid schema: type: string format: uuid - in: query name: created schema: type: string format: date-time description: Created after - in: query name: customer schema: type: string - in: query name: customer_uuid schema: type: string format: uuid - in: query name: description schema: type: string - in: query name: keyword schema: type: string description: Keyword - in: query name: modified schema: type: string format: date-time description: Modified after - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - in: query name: o schema: type: array items: type: string enum: - -created - -name - -state - -total_cost - -total_cost_estimated - -total_customers - -type - created - name - state - total_cost - total_cost_estimated - total_customers - type description: |+ Ordering explode: false style: form - in: query name: organization_group_uuid schema: type: array items: type: string format: uuid explode: true style: form - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: parent_uuid schema: type: string format: uuid - in: query name: project_uuid schema: type: string format: uuid description: Project UUID - in: query name: resource_customer_uuid schema: type: string format: uuid description: Resource customer UUID - in: query name: resource_project_uuid schema: type: string format: uuid description: Resource project UUID - in: query name: scope_uuid schema: type: string description: Scope UUID - in: query name: service_manager_uuid schema: type: string format: uuid description: Service manager UUID - in: query name: shared schema: type: boolean - in: query name: state schema: type: array items: type: string enum: - Active - Archived - Draft - Paused explode: true style: form - in: query name: type schema: type: array items: type: string explode: true style: form - in: query name: uuid_list schema: type: string description: Comma-separated offering UUIDs tags: - marketplace-provider-offerings security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/marketplace-provider-offerings/{uuid}/: get: operationId: marketplace_provider_offerings_retrieve parameters: - in: query name: field schema: type: array items: type: string enum: - access_url - attributes - backend_id - backend_metadata - billable - category - category_title - category_uuid - citation_count - components - country - created - customer - customer_name - customer_uuid - datacite_doi - description - endpoints - files - full_description - getting_started - google_calendar_is_public - google_calendar_link - has_compliance_requirements - image - integration_guide - integration_status - latitude - longitude - name - options - order_count - organization_groups - parent_description - parent_name - parent_uuid - paused_reason - plans - plugin_options - privacy_policy_link - project - project_name - project_uuid - quotas - resource_options - roles - scope - scope_error_message - scope_name - scope_state - scope_uuid - screenshots - secret_options - service_attributes - shared - slug - state - thumbnail - total_cost - total_cost_estimated - total_customers - type - url - uuid - vendor_details - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-provider-offerings security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ProviderOfferingDetails' description: '' delete: operationId: marketplace_provider_offerings_destroy parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-provider-offerings security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '204': description: No response body x-permissions: - permission: OFFERING.DELETE scopes: - customer /api/marketplace-provider-offerings/{uuid}/activate/: post: operationId: marketplace_provider_offerings_activate parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-provider-offerings security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/DetailState' description: '' /api/marketplace-provider-offerings/{uuid}/add_endpoint/: post: operationId: marketplace_provider_offerings_add_endpoint description: Add endpoint to offering. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-provider-offerings requestBody: content: application/json: schema: $ref: '#/components/schemas/NestedEndpointRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/EndpointUUID' description: '' x-permissions: - permission: OFFERING.ADD_ENDPOINT scopes: - '*' - customer - customer.serviceprovider /api/marketplace-provider-offerings/{uuid}/add_user/: post: operationId: marketplace_provider_offerings_add_user parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-provider-offerings requestBody: content: application/json: schema: $ref: '#/components/schemas/UserRoleCreateRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/UserRoleExpirationTime' description: '' /api/marketplace-provider-offerings/{uuid}/archive/: post: operationId: marketplace_provider_offerings_archive parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-provider-offerings security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/DetailState' description: '' x-permissions: - permission: OFFERING.ARCHIVE scopes: - '*' - customer - customer.serviceprovider /api/marketplace-provider-offerings/{uuid}/component_stats/: get: operationId: marketplace_provider_offerings_component_stats_list description: Get statistics for offering components. parameters: - in: query name: accessible_via_calls schema: type: boolean description: Accessible via calls - in: query name: allowed_customer_uuid schema: type: string format: uuid description: Allowed customer UUID - in: query name: attributes schema: type: string - in: query name: billable schema: type: boolean - in: query name: category_group_uuid schema: type: string format: uuid - in: query name: category_uuid schema: type: string format: uuid - in: query name: created schema: type: string format: date-time description: Created after - in: query name: customer schema: type: string - in: query name: customer_uuid schema: type: string format: uuid - in: query name: description schema: type: string - in: query name: end schema: type: string description: End date in format YYYY-MM. - in: query name: keyword schema: type: string description: Keyword - in: query name: modified schema: type: string format: date-time description: Modified after - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - in: query name: o schema: type: array items: type: string enum: - -created - -name - -state - -total_cost - -total_cost_estimated - -total_customers - -type - created - name - state - total_cost - total_cost_estimated - total_customers - type description: |+ Ordering explode: false style: form - in: query name: organization_group_uuid schema: type: array items: type: string format: uuid explode: true style: form - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: parent_uuid schema: type: string format: uuid - in: query name: project_uuid schema: type: string format: uuid description: Project UUID - in: query name: resource_customer_uuid schema: type: string format: uuid description: Resource customer UUID - in: query name: resource_project_uuid schema: type: string format: uuid description: Resource project UUID - in: query name: scope_uuid schema: type: string description: Scope UUID - in: query name: service_manager_uuid schema: type: string format: uuid description: Service manager UUID - in: query name: shared schema: type: boolean - in: query name: start schema: type: string description: Start date in format YYYY-MM. - in: query name: state schema: type: array items: type: string enum: - Active - Archived - Draft - Paused explode: true style: form - in: query name: type schema: type: array items: type: string explode: true style: form - in: path name: uuid schema: type: string format: uuid required: true - in: query name: uuid_list schema: type: string description: Comma-separated offering UUIDs tags: - marketplace-provider-offerings security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/OfferingComponentStat' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' /api/marketplace-provider-offerings/{uuid}/costs/: get: operationId: marketplace_provider_offerings_costs_list description: Get costs for offering. parameters: - in: query name: accessible_via_calls schema: type: boolean description: Accessible via calls - in: query name: accounting_is_running schema: type: boolean - in: query name: allowed_customer_uuid schema: type: string format: uuid description: Allowed customer UUID - in: query name: attributes schema: type: string - in: query name: billable schema: type: boolean - in: query name: category_group_uuid schema: type: string format: uuid - in: query name: category_uuid schema: type: string format: uuid - in: query name: created schema: type: string format: date-time description: Created after - in: query name: customer schema: type: string - in: query name: customer_uuid schema: type: string format: uuid - in: query name: description schema: type: string - in: query name: end schema: type: string description: End date in format YYYY-MM. - in: query name: keyword schema: type: string description: Keyword - in: query name: modified schema: type: string format: date-time description: Modified after - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - in: query name: o schema: type: array items: type: string enum: - -created - -name - -state - -total_cost - -total_cost_estimated - -total_customers - -type - created - name - state - total_cost - total_cost_estimated - total_customers - type description: |+ Ordering explode: false style: form - in: query name: organization_group_uuid schema: type: array items: type: string format: uuid explode: true style: form - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: parent_uuid schema: type: string format: uuid - in: query name: project_uuid schema: type: string format: uuid description: Project UUID - in: query name: resource_customer_uuid schema: type: string format: uuid description: Resource customer UUID - in: query name: resource_project_uuid schema: type: string format: uuid description: Resource project UUID - in: query name: scope_uuid schema: type: string description: Scope UUID - in: query name: service_manager_uuid schema: type: string format: uuid description: Service manager UUID - in: query name: shared schema: type: boolean - in: query name: start schema: type: string description: Start date in format YYYY-MM. - in: query name: state schema: type: array items: type: string enum: - Active - Archived - Draft - Paused explode: true style: form - in: query name: type schema: type: array items: type: string explode: true style: form - in: path name: uuid schema: type: string format: uuid required: true - in: query name: uuid_list schema: type: string description: Comma-separated offering UUIDs tags: - marketplace-provider-offerings security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/ProviderOfferingCosts' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' /api/marketplace-provider-offerings/{uuid}/create_offering_component/: post: operationId: marketplace_provider_offerings_create_offering_component parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-provider-offerings requestBody: content: application/json: schema: $ref: '#/components/schemas/OfferingComponentRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body x-permissions: - permission: OFFERING.UPDATE_COMPONENTS scopes: - '*' - customer - customer.serviceprovider /api/marketplace-provider-offerings/{uuid}/customers/: get: operationId: marketplace_provider_offerings_customers_list description: Get customers for offering. parameters: - in: query name: accessible_via_calls schema: type: boolean description: Accessible via calls - in: query name: allowed_customer_uuid schema: type: string format: uuid description: Allowed customer UUID - in: query name: attributes schema: type: string - in: query name: billable schema: type: boolean - in: query name: category_group_uuid schema: type: string format: uuid - in: query name: category_uuid schema: type: string format: uuid - in: query name: created schema: type: string format: date-time description: Created after - in: query name: customer schema: type: string - in: query name: customer_uuid schema: type: string format: uuid - in: query name: description schema: type: string - in: query name: keyword schema: type: string description: Keyword - in: query name: modified schema: type: string format: date-time description: Modified after - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - in: query name: o schema: type: array items: type: string enum: - -created - -name - -state - -total_cost - -total_cost_estimated - -total_customers - -type - created - name - state - total_cost - total_cost_estimated - total_customers - type description: |+ Ordering explode: false style: form - in: query name: organization_group_uuid schema: type: array items: type: string format: uuid explode: true style: form - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: parent_uuid schema: type: string format: uuid - in: query name: project_uuid schema: type: string format: uuid description: Project UUID - in: query name: resource_customer_uuid schema: type: string format: uuid description: Resource customer UUID - in: query name: resource_project_uuid schema: type: string format: uuid description: Resource project UUID - in: query name: scope_uuid schema: type: string description: Scope UUID - in: query name: service_manager_uuid schema: type: string format: uuid description: Service manager UUID - in: query name: shared schema: type: boolean - in: query name: state schema: type: array items: type: string enum: - Active - Archived - Draft - Paused explode: true style: form - in: query name: type schema: type: array items: type: string explode: true style: form - in: path name: uuid schema: type: string format: uuid required: true - in: query name: uuid_list schema: type: string description: Comma-separated offering UUIDs tags: - marketplace-provider-offerings security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/ProviderOfferingCustomer' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' /api/marketplace-provider-offerings/{uuid}/delete_endpoint/: post: operationId: marketplace_provider_offerings_delete_endpoint description: Delete endpoint from offering. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-provider-offerings requestBody: content: application/json: schema: $ref: '#/components/schemas/EndpointUUIDRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '204': description: No response body x-permissions: - permission: OFFERING.DELETE_ENDPOINT scopes: - '*' - customer - customer.serviceprovider /api/marketplace-provider-offerings/{uuid}/delete_image/: post: operationId: marketplace_provider_offerings_delete_image description: Delete offering image. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-provider-offerings security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/marketplace-provider-offerings/{uuid}/delete_organization_groups/: post: operationId: marketplace_provider_offerings_delete_organization_groups description: Delete organization groups for offering. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-provider-offerings security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/marketplace-provider-offerings/{uuid}/delete_thumbnail/: post: operationId: marketplace_provider_offerings_delete_thumbnail description: Delete offering thumbnail. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-provider-offerings security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '204': description: No response body /api/marketplace-provider-offerings/{uuid}/delete_user/: post: operationId: marketplace_provider_offerings_delete_user parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-provider-offerings requestBody: content: application/json: schema: $ref: '#/components/schemas/UserRoleDeleteRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/marketplace-provider-offerings/{uuid}/draft/: post: operationId: marketplace_provider_offerings_draft parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-provider-offerings security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/DetailState' description: '' /api/marketplace-provider-offerings/{uuid}/glauth_users_config/: get: operationId: marketplace_provider_offerings_glauth_users_config_retrieve description: |- This endpoint provides a config file for GLauth Example: https://github.com/glauth/glauth/blob/master/v2/sample-simple.cfg It is assumed that the config is used by an external agent, which synchronizes data from Waldur to GLauth parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-provider-offerings security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: text/plain: schema: type: string description: '' /api/marketplace-provider-offerings/{uuid}/import_resource/: post: operationId: marketplace_provider_offerings_import_resource parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-provider-offerings requestBody: content: application/json: schema: $ref: '#/components/schemas/ImportResourceRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Resource' description: '' /api/marketplace-provider-offerings/{uuid}/importable_resources/: get: operationId: marketplace_provider_offerings_importable_resources_list description: List importable resources for offering. parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-provider-offerings security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/ImportableResource' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' /api/marketplace-provider-offerings/{uuid}/list_customer_projects/: get: operationId: marketplace_provider_offerings_list_customer_projects_list parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-provider-offerings security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/Project' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' /api/marketplace-provider-offerings/{uuid}/list_customer_service_accounts/: get: operationId: marketplace_provider_offerings_list_customer_service_accounts_retrieve parameters: - in: query name: field schema: type: array items: type: string enum: - access_url - attributes - backend_id - backend_metadata - billable - category - category_title - category_uuid - citation_count - components - country - created - customer - customer_name - customer_uuid - datacite_doi - description - endpoints - files - full_description - getting_started - google_calendar_is_public - google_calendar_link - has_compliance_requirements - image - integration_guide - integration_status - latitude - longitude - name - options - order_count - organization_groups - parent_description - parent_name - parent_uuid - paused_reason - plans - plugin_options - privacy_policy_link - project - project_name - project_uuid - quotas - resource_options - roles - scope - scope_error_message - scope_name - scope_state - scope_uuid - screenshots - secret_options - service_attributes - shared - slug - state - thumbnail - total_cost - total_cost_estimated - total_customers - type - url - uuid - vendor_details - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-provider-offerings security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ProviderOfferingDetails' description: '' /api/marketplace-provider-offerings/{uuid}/list_customer_users/: get: operationId: marketplace_provider_offerings_list_customer_users_list parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-provider-offerings security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/User' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' /api/marketplace-provider-offerings/{uuid}/list_project_service_accounts/: get: operationId: marketplace_provider_offerings_list_project_service_accounts_retrieve parameters: - in: query name: field schema: type: array items: type: string enum: - access_url - attributes - backend_id - backend_metadata - billable - category - category_title - category_uuid - citation_count - components - country - created - customer - customer_name - customer_uuid - datacite_doi - description - endpoints - files - full_description - getting_started - google_calendar_is_public - google_calendar_link - has_compliance_requirements - image - integration_guide - integration_status - latitude - longitude - name - options - order_count - organization_groups - parent_description - parent_name - parent_uuid - paused_reason - plans - plugin_options - privacy_policy_link - project - project_name - project_uuid - quotas - resource_options - roles - scope - scope_error_message - scope_name - scope_state - scope_uuid - screenshots - secret_options - service_attributes - shared - slug - state - thumbnail - total_cost - total_cost_estimated - total_customers - type - url - uuid - vendor_details - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-provider-offerings security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ProviderOfferingDetails' description: '' /api/marketplace-provider-offerings/{uuid}/list_users/: get: operationId: marketplace_provider_offerings_list_users_list parameters: - in: query name: field schema: type: array items: type: string enum: - created - created_by_full_name - created_by_uuid - expiration_time - role_name - role_uuid - user_email - user_full_name - user_image - user_username - user_uuid - uuid description: Fields to include in response - in: query name: full_name schema: type: string description: User full name - in: query name: native_name schema: type: string description: User native name - in: query name: o schema: type: array items: type: string enum: - created - email - expiration_time - full_name - native_name - role - username description: Ordering fields - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: role schema: type: string format: uuid description: Role UUID or name - in: query name: search_string schema: type: string description: Search string for user - in: query name: user schema: type: string format: uuid description: User UUID - in: query name: user_slug schema: type: string description: User slug - in: query name: user_url schema: type: string description: User URL - in: query name: username schema: type: string description: User username - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-provider-offerings security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/UserRoleDetails' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' /api/marketplace-provider-offerings/{uuid}/move_offering/: post: operationId: marketplace_provider_offerings_move_offering parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-provider-offerings requestBody: content: application/json: schema: $ref: '#/components/schemas/MoveOfferingRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PublicOfferingDetails' description: '' /api/marketplace-provider-offerings/{uuid}/orders/: get: operationId: marketplace_provider_offerings_orders_list parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-provider-offerings security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/OrderDetails' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' /api/marketplace-provider-offerings/{uuid}/orders/{order_uuid}/: get: operationId: marketplace_provider_offerings_orders_retrieve parameters: - in: path name: order_uuid schema: type: string pattern: ^[a-f0-9]+$ required: true - in: path name: uuid schema: type: string pattern: ^[a-f0-9]+$ required: true tags: - marketplace-provider-offerings security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OrderDetails' description: '' /api/marketplace-provider-offerings/{uuid}/pause/: post: operationId: marketplace_provider_offerings_pause parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-provider-offerings requestBody: content: application/json: schema: $ref: '#/components/schemas/OfferingPauseRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/DetailState' description: '' x-permissions: - permission: OFFERING.PAUSE scopes: - '*' - customer - customer.serviceprovider /api/marketplace-provider-offerings/{uuid}/refresh_offering_usernames/: post: operationId: marketplace_provider_offerings_refresh_offering_usernames description: Refresh offering user usernames. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-provider-offerings requestBody: content: application/json: schema: $ref: '#/components/schemas/ProviderOfferingDetailsRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ResourceResponseStatus' description: '' x-permissions: - permission: OFFERING.UPDATE_INTEGRATION scopes: - '*' - customer - customer.serviceprovider /api/marketplace-provider-offerings/{uuid}/remove_offering_component/: post: operationId: marketplace_provider_offerings_remove_offering_component parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-provider-offerings requestBody: content: application/json: schema: $ref: '#/components/schemas/RemoveOfferingComponentRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body x-permissions: - permission: OFFERING.UPDATE_COMPONENTS scopes: - '*' - customer - customer.serviceprovider /api/marketplace-provider-offerings/{uuid}/set_backend_metadata/: post: operationId: marketplace_provider_offerings_set_backend_metadata parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-provider-offerings requestBody: content: application/json: schema: $ref: '#/components/schemas/OfferingBackendMetadataRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body x-permissions: - permission: OFFERING.UPDATE scopes: - '*' - customer - customer.serviceprovider /api/marketplace-provider-offerings/{uuid}/stats/: get: operationId: marketplace_provider_offerings_stats_retrieve parameters: - in: query name: field schema: type: array items: type: string enum: - access_url - attributes - backend_id - backend_metadata - billable - category - category_title - category_uuid - citation_count - components - country - created - customer - customer_name - customer_uuid - datacite_doi - description - endpoints - files - full_description - getting_started - google_calendar_is_public - google_calendar_link - has_compliance_requirements - image - integration_guide - integration_status - latitude - longitude - name - options - order_count - organization_groups - parent_description - parent_name - parent_uuid - paused_reason - plans - plugin_options - privacy_policy_link - project - project_name - project_uuid - quotas - resource_options - roles - scope - scope_error_message - scope_name - scope_state - scope_uuid - screenshots - secret_options - service_attributes - shared - slug - state - thumbnail - total_cost - total_cost_estimated - total_customers - type - url - uuid - vendor_details - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-provider-offerings security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ProviderOfferingDetails' description: '' /api/marketplace-provider-offerings/{uuid}/sync/: post: operationId: marketplace_provider_offerings_sync parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-provider-offerings security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body x-permissions: - permission: OFFERING.UPDATE_COMPONENTS scopes: - '*' - customer - customer.serviceprovider /api/marketplace-provider-offerings/{uuid}/unpause/: post: operationId: marketplace_provider_offerings_unpause parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-provider-offerings security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/DetailState' description: '' x-permissions: - permission: OFFERING.UNPAUSE scopes: - '*' - customer - customer.serviceprovider /api/marketplace-provider-offerings/{uuid}/update_attributes/: post: operationId: marketplace_provider_offerings_update_attributes description: Update offering attributes. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-provider-offerings requestBody: content: application/json: schema: type: object additionalProperties: {} security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body x-permissions: - permission: OFFERING.UPDATE_ATTRIBUTES scopes: - '*' - customer - customer.serviceprovider /api/marketplace-provider-offerings/{uuid}/update_description/: post: operationId: marketplace_provider_offerings_update_description parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-provider-offerings requestBody: content: application/json: schema: $ref: '#/components/schemas/OfferingDescriptionUpdateRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body x-permissions: - permission: OFFERING.UPDATE_DESCRIPTION scopes: - '*' - customer - customer.serviceprovider /api/marketplace-provider-offerings/{uuid}/update_image/: post: operationId: marketplace_provider_offerings_update_image description: Update offering image. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-provider-offerings requestBody: content: application/json: schema: $ref: '#/components/schemas/OfferingImageRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ProviderOfferingDetails' description: '' /api/marketplace-provider-offerings/{uuid}/update_integration/: post: operationId: marketplace_provider_offerings_update_integration parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-provider-offerings requestBody: content: application/json: schema: $ref: '#/components/schemas/OfferingIntegrationUpdateRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body x-permissions: - permission: OFFERING.UPDATE_INTEGRATION scopes: - '*' - customer - customer.serviceprovider /api/marketplace-provider-offerings/{uuid}/update_location/: post: operationId: marketplace_provider_offerings_update_location parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-provider-offerings requestBody: content: application/json: schema: $ref: '#/components/schemas/OfferingLocationUpdateRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body x-permissions: - permission: OFFERING.UPDATE_LOCATION scopes: - '*' - customer - customer.serviceprovider /api/marketplace-provider-offerings/{uuid}/update_offering_component/: post: operationId: marketplace_provider_offerings_update_offering_component parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-provider-offerings requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateOfferingComponentRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body x-permissions: - permission: OFFERING.UPDATE_COMPONENTS scopes: - '*' - customer - customer.serviceprovider /api/marketplace-provider-offerings/{uuid}/update_options/: post: operationId: marketplace_provider_offerings_update_options parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-provider-offerings requestBody: content: application/json: schema: $ref: '#/components/schemas/OfferingOptionsUpdateRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body x-permissions: - permission: OFFERING.UPDATE_OPTIONS scopes: - '*' - customer - customer.serviceprovider /api/marketplace-provider-offerings/{uuid}/update_organization_groups/: post: operationId: marketplace_provider_offerings_update_organization_groups description: Update organization groups for offering. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-provider-offerings requestBody: content: application/json: schema: $ref: '#/components/schemas/OrganizationGroupsRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/marketplace-provider-offerings/{uuid}/update_overview/: post: operationId: marketplace_provider_offerings_update_overview parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-provider-offerings requestBody: content: application/json: schema: $ref: '#/components/schemas/OfferingOverviewUpdateRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/marketplace-provider-offerings/{uuid}/update_resource_options/: post: operationId: marketplace_provider_offerings_update_resource_options parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-provider-offerings requestBody: content: application/json: schema: $ref: '#/components/schemas/OfferingResourceOptionsUpdateRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body x-permissions: - permission: OFFERING.UPDATE_OPTIONS scopes: - '*' - customer - customer.serviceprovider /api/marketplace-provider-offerings/{uuid}/update_thumbnail/: post: operationId: marketplace_provider_offerings_update_thumbnail description: Update offering thumbnail. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-provider-offerings requestBody: content: application/json: schema: $ref: '#/components/schemas/OfferingThumbnailRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/marketplace-provider-offerings/{uuid}/update_user/: post: operationId: marketplace_provider_offerings_update_user parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-provider-offerings requestBody: content: application/json: schema: $ref: '#/components/schemas/UserRoleUpdateRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/UserRoleExpirationTime' description: '' /api/marketplace-provider-offerings/{uuid}/user_has_resource_access/: get: operationId: marketplace_provider_offerings_user_has_resource_access_retrieve description: Check if user has access to offering. parameters: - in: query name: field schema: type: array items: type: string enum: - access_url - attributes - backend_id - backend_metadata - billable - category - category_title - category_uuid - citation_count - components - country - created - customer - customer_name - customer_uuid - datacite_doi - description - endpoints - files - full_description - getting_started - google_calendar_is_public - google_calendar_link - has_compliance_requirements - image - integration_guide - integration_status - latitude - longitude - name - options - order_count - organization_groups - parent_description - parent_name - parent_uuid - paused_reason - plans - plugin_options - privacy_policy_link - project - project_name - project_uuid - quotas - resource_options - roles - scope - scope_error_message - scope_name - scope_state - scope_uuid - screenshots - secret_options - service_attributes - shared - slug - state - thumbnail - total_cost - total_cost_estimated - total_customers - type - url - uuid - vendor_details - in: query name: username schema: type: string description: Username of the user to check. required: true - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-provider-offerings security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ProviderOfferingDetails' description: '' /api/marketplace-provider-offerings/groups/: get: operationId: marketplace_provider_offerings_groups_list parameters: - in: query name: accessible_via_calls schema: type: boolean description: Accessible via calls - in: query name: allowed_customer_uuid schema: type: string format: uuid description: Allowed customer UUID - in: query name: attributes schema: type: string - in: query name: billable schema: type: boolean - in: query name: category_group_uuid schema: type: string format: uuid - in: query name: category_uuid schema: type: string format: uuid - in: query name: created schema: type: string format: date-time description: Created after - in: query name: customer schema: type: string - in: query name: customer_uuid schema: type: string format: uuid - in: query name: description schema: type: string - in: query name: keyword schema: type: string description: Keyword - in: query name: modified schema: type: string format: date-time description: Modified after - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - in: query name: o schema: type: array items: type: string enum: - -created - -name - -state - -total_cost - -total_cost_estimated - -total_customers - -type - created - name - state - total_cost - total_cost_estimated - total_customers - type description: |+ Ordering explode: false style: form - in: query name: organization_group_uuid schema: type: array items: type: string format: uuid explode: true style: form - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: parent_uuid schema: type: string format: uuid - in: query name: project_uuid schema: type: string format: uuid description: Project UUID - in: query name: resource_customer_uuid schema: type: string format: uuid description: Resource customer UUID - in: query name: resource_project_uuid schema: type: string format: uuid description: Resource project UUID - in: query name: scope_uuid schema: type: string description: Scope UUID - in: query name: service_manager_uuid schema: type: string format: uuid description: Service manager UUID - in: query name: shared schema: type: boolean - in: query name: state schema: type: array items: type: string enum: - Active - Archived - Draft - Paused explode: true style: form - in: query name: type schema: type: array items: type: string explode: true style: form - in: query name: uuid_list schema: type: string description: Comma-separated offering UUIDs tags: - marketplace-provider-offerings security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/OfferingGroups' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' head: operationId: marketplace_provider_offerings_groups_count parameters: - in: query name: accessible_via_calls schema: type: boolean description: Accessible via calls - in: query name: allowed_customer_uuid schema: type: string format: uuid description: Allowed customer UUID - in: query name: attributes schema: type: string - in: query name: billable schema: type: boolean - in: query name: category_group_uuid schema: type: string format: uuid - in: query name: category_uuid schema: type: string format: uuid - in: query name: created schema: type: string format: date-time description: Created after - in: query name: customer schema: type: string - in: query name: customer_uuid schema: type: string format: uuid - in: query name: description schema: type: string - in: query name: keyword schema: type: string description: Keyword - in: query name: modified schema: type: string format: date-time description: Modified after - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - in: query name: o schema: type: array items: type: string enum: - -created - -name - -state - -total_cost - -total_cost_estimated - -total_customers - -type - created - name - state - total_cost - total_cost_estimated - total_customers - type description: |+ Ordering explode: false style: form - in: query name: organization_group_uuid schema: type: array items: type: string format: uuid explode: true style: form - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: parent_uuid schema: type: string format: uuid - in: query name: project_uuid schema: type: string format: uuid description: Project UUID - in: query name: resource_customer_uuid schema: type: string format: uuid description: Resource customer UUID - in: query name: resource_project_uuid schema: type: string format: uuid description: Resource project UUID - in: query name: scope_uuid schema: type: string description: Scope UUID - in: query name: service_manager_uuid schema: type: string format: uuid description: Service manager UUID - in: query name: shared schema: type: boolean - in: query name: state schema: type: array items: type: string enum: - Active - Archived - Draft - Paused explode: true style: form - in: query name: type schema: type: array items: type: string explode: true style: form - in: query name: uuid_list schema: type: string description: Comma-separated offering UUIDs tags: - marketplace-provider-offerings security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body description: Get number of items in the collection matching the request parameters. /api/marketplace-provider-resources/: get: operationId: marketplace_provider_resources_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: backend_id schema: type: string description: Backend ID - in: query name: category_uuid schema: type: string format: uuid - in: query name: created schema: type: string format: date-time description: Created after - in: query name: customer schema: type: string - in: query name: customer_uuid schema: type: string format: uuid - in: query name: downscaled schema: type: boolean - in: query name: field schema: type: array items: type: string enum: - attributes - available_actions - backend_id - backend_metadata - can_terminate - category_icon - category_title - category_uuid - created - creation_order - current_usages - customer_name - customer_slug - customer_uuid - description - downscaled - effective_id - end_date - end_date_requested_by - endpoints - error_message - error_traceback - is_limit_based - is_usage_based - last_sync - limit_usage - limits - modified - name - offering - offering_billable - offering_customer_uuid - offering_description - offering_image - offering_name - offering_plugin_options - offering_shared - offering_slug - offering_thumbnail - offering_type - offering_uuid - options - order_in_progress - parent_name - parent_offering_name - parent_offering_slug - parent_offering_uuid - parent_uuid - paused - plan - plan_description - plan_name - plan_unit - plan_uuid - project - project_description - project_end_date - project_end_date_requested_by - project_name - project_slug - project_uuid - provider_name - provider_uuid - report - resource_type - resource_uuid - restrict_member_access - scope - service_settings_uuid - slug - state - url - user_requires_reconsent - username - uuid - in: query name: has_terminate_date schema: type: boolean description: Has termination date - in: query name: lexis_links_supported schema: type: boolean description: LEXIS links supported - in: query name: modified schema: type: string format: date-time description: Modified after - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - in: query name: o schema: type: array items: type: string enum: - -created - -name - -project_name - -state - created - name - project_name - state description: |+ Ordering explode: false style: form - in: query name: offering schema: type: string - in: query name: offering_billable schema: type: string format: uuid - in: query name: offering_shared schema: type: boolean description: Offering shared - in: query name: offering_slug schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: offering_type schema: type: string - in: query name: offering_uuid schema: type: array items: type: string format: uuid description: Multiple values may be separated by commas. explode: false style: form - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: parent_offering_uuid schema: type: string format: uuid - in: query name: paused schema: type: boolean - in: query name: project_name schema: type: string - in: query name: project_uuid schema: type: string format: uuid - in: query name: provider_uuid schema: type: string format: uuid - in: query name: query schema: type: string description: Search by resource UUID, name, backend ID, effective ID, IPs or hypervisor - in: query name: restrict_member_access schema: type: boolean - in: query name: runtime_state schema: type: string description: Runtime state - in: query name: service_manager_uuid schema: type: string format: uuid description: Service Manager UUID - in: query name: state schema: type: array items: type: string enum: - Creating - Erred - OK - Terminated - Terminating - Updating explode: true style: form - in: query name: visible_to_username schema: type: string description: Visible to username tags: - marketplace-provider-resources security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/Resource' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' head: operationId: marketplace_provider_resources_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: backend_id schema: type: string description: Backend ID - in: query name: category_uuid schema: type: string format: uuid - in: query name: created schema: type: string format: date-time description: Created after - in: query name: customer schema: type: string - in: query name: customer_uuid schema: type: string format: uuid - in: query name: downscaled schema: type: boolean - in: query name: has_terminate_date schema: type: boolean description: Has termination date - in: query name: lexis_links_supported schema: type: boolean description: LEXIS links supported - in: query name: modified schema: type: string format: date-time description: Modified after - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - in: query name: o schema: type: array items: type: string enum: - -created - -name - -project_name - -state - created - name - project_name - state description: |+ Ordering explode: false style: form - in: query name: offering schema: type: string - in: query name: offering_billable schema: type: string format: uuid - in: query name: offering_shared schema: type: boolean description: Offering shared - in: query name: offering_slug schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: offering_type schema: type: string - in: query name: offering_uuid schema: type: array items: type: string format: uuid description: Multiple values may be separated by commas. explode: false style: form - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: parent_offering_uuid schema: type: string format: uuid - in: query name: paused schema: type: boolean - in: query name: project_name schema: type: string - in: query name: project_uuid schema: type: string format: uuid - in: query name: provider_uuid schema: type: string format: uuid - in: query name: query schema: type: string description: Search by resource UUID, name, backend ID, effective ID, IPs or hypervisor - in: query name: restrict_member_access schema: type: boolean - in: query name: runtime_state schema: type: string description: Runtime state - in: query name: service_manager_uuid schema: type: string format: uuid description: Service Manager UUID - in: query name: state schema: type: array items: type: string enum: - Creating - Erred - OK - Terminated - Terminating - Updating explode: true style: form - in: query name: visible_to_username schema: type: string description: Visible to username tags: - marketplace-provider-resources security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/marketplace-provider-resources/{uuid}/: get: operationId: marketplace_provider_resources_retrieve parameters: - in: query name: field schema: type: array items: type: string enum: - attributes - available_actions - backend_id - backend_metadata - can_terminate - category_icon - category_title - category_uuid - created - creation_order - current_usages - customer_name - customer_slug - customer_uuid - description - downscaled - effective_id - end_date - end_date_requested_by - endpoints - error_message - error_traceback - is_limit_based - is_usage_based - last_sync - limit_usage - limits - modified - name - offering - offering_billable - offering_customer_uuid - offering_description - offering_image - offering_name - offering_plugin_options - offering_shared - offering_slug - offering_thumbnail - offering_type - offering_uuid - options - order_in_progress - parent_name - parent_offering_name - parent_offering_slug - parent_offering_uuid - parent_uuid - paused - plan - plan_description - plan_name - plan_unit - plan_uuid - project - project_description - project_end_date - project_end_date_requested_by - project_name - project_slug - project_uuid - provider_name - provider_uuid - report - resource_type - resource_uuid - restrict_member_access - scope - service_settings_uuid - slug - state - url - user_requires_reconsent - username - uuid - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-provider-resources security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Resource' description: '' put: operationId: marketplace_provider_resources_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-provider-resources requestBody: content: application/json: schema: $ref: '#/components/schemas/ResourceUpdateRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ResourceUpdate' description: '' patch: operationId: marketplace_provider_resources_partial_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-provider-resources requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedResourceUpdateRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ResourceUpdate' description: '' /api/marketplace-provider-resources/{uuid}/details/: get: operationId: marketplace_provider_resources_details_retrieve parameters: - in: query name: field schema: type: array items: type: string enum: - attributes - available_actions - backend_id - backend_metadata - can_terminate - category_icon - category_title - category_uuid - created - creation_order - current_usages - customer_name - customer_slug - customer_uuid - description - downscaled - effective_id - end_date - end_date_requested_by - endpoints - error_message - error_traceback - is_limit_based - is_usage_based - last_sync - limit_usage - limits - modified - name - offering - offering_billable - offering_customer_uuid - offering_description - offering_image - offering_name - offering_plugin_options - offering_shared - offering_slug - offering_thumbnail - offering_type - offering_uuid - options - order_in_progress - parent_name - parent_offering_name - parent_offering_slug - parent_offering_uuid - parent_uuid - paused - plan - plan_description - plan_name - plan_unit - plan_uuid - project - project_description - project_end_date - project_end_date_requested_by - project_name - project_slug - project_uuid - provider_name - provider_uuid - report - resource_type - resource_uuid - restrict_member_access - scope - service_settings_uuid - slug - state - url - user_requires_reconsent - username - uuid - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-provider-resources security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Resource' description: '' /api/marketplace-provider-resources/{uuid}/glauth_users_config/: get: operationId: marketplace_provider_resources_glauth_users_config_retrieve description: "\n This endpoint provides a config file for GLauth.\n \ \ Example: https://github.com/glauth/glauth/blob/master/v2/sample-simple.cfg\n\ \ It is assumed that the config is used by an external agent,\n \ \ which synchronizes data from Waldur to GLauth.\n " parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-provider-resources security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: text/plain: schema: type: string description: '' /api/marketplace-provider-resources/{uuid}/move_resource/: post: operationId: marketplace_provider_resources_move_resource description: Move resource to another project. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-provider-resources security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Resource' description: '' /api/marketplace-provider-resources/{uuid}/offering/: get: operationId: marketplace_provider_resources_offering_retrieve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-provider-resources security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PublicOfferingDetails' description: '' /api/marketplace-provider-resources/{uuid}/offering_for_subresources/: get: operationId: marketplace_provider_resources_offering_for_subresources_list parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-provider-resources security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/SubresourceOffering' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' /api/marketplace-provider-resources/{uuid}/plan_periods/: get: operationId: marketplace_provider_resources_plan_periods_list parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-provider-resources security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/ResourcePlanPeriod' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' /api/marketplace-provider-resources/{uuid}/pull/: post: operationId: marketplace_provider_resources_pull description: Starts process of pulling a resource parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-provider-resources security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: object additionalProperties: type: string description: '' /api/marketplace-provider-resources/{uuid}/refresh_last_sync/: post: operationId: marketplace_provider_resources_refresh_last_sync description: Refresh the last sync time for a resource. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-provider-resources security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body x-permissions: - permission: RESOURCE.SET_STATE scopes: - offering.customer /api/marketplace-provider-resources/{uuid}/set_as_erred/: post: operationId: marketplace_provider_resources_set_as_erred description: Set the resource as erred. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-provider-resources requestBody: content: application/json: schema: $ref: '#/components/schemas/ResourceSetStateErredRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body x-permissions: - permission: RESOURCE.SET_STATE scopes: - offering.customer /api/marketplace-provider-resources/{uuid}/set_as_ok/: post: operationId: marketplace_provider_resources_set_as_ok description: Set the resource as OK. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-provider-resources security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/marketplace-provider-resources/{uuid}/set_backend_id/: post: operationId: marketplace_provider_resources_set_backend_id description: Set resource backend ID. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-provider-resources requestBody: content: application/json: schema: $ref: '#/components/schemas/ResourceBackendIDRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ResourceResponseStatus' description: '' x-permissions: - permission: RESOURCE.SET_BACKEND_ID scopes: - offering - offering.customer /api/marketplace-provider-resources/{uuid}/set_backend_metadata/: post: operationId: marketplace_provider_resources_set_backend_metadata parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-provider-resources requestBody: content: application/json: schema: $ref: '#/components/schemas/ResourceBackendMetadataRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ResourceResponseStatus' description: '' x-permissions: - permission: RESOURCE.SET_BACKEND_METADATA scopes: - offering.customer /api/marketplace-provider-resources/{uuid}/set_end_date_by_provider/: post: operationId: marketplace_provider_resources_set_end_date_by_provider parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-provider-resources requestBody: content: application/json: schema: $ref: '#/components/schemas/ResourceEndDateByProviderRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Resource' description: '' /api/marketplace-provider-resources/{uuid}/set_end_date_by_staff/: post: operationId: marketplace_provider_resources_set_end_date_by_staff description: Set end date of the resource by staff. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-provider-resources requestBody: content: application/json: schema: $ref: '#/components/schemas/ResourceEndDateByProviderRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/marketplace-provider-resources/{uuid}/set_limits/: post: operationId: marketplace_provider_resources_set_limits parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-provider-resources requestBody: content: application/json: schema: $ref: '#/components/schemas/ResourceSetLimitsRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ResourceResponseStatus' description: '' /api/marketplace-provider-resources/{uuid}/set_slug/: post: operationId: marketplace_provider_resources_set_slug description: Set slug for resource. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-provider-resources requestBody: content: application/json: schema: $ref: '#/components/schemas/ResourceSlugRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/marketplace-provider-resources/{uuid}/submit_report/: post: operationId: marketplace_provider_resources_submit_report description: Submit resource report. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-provider-resources requestBody: content: application/json: schema: $ref: '#/components/schemas/ResourceReportRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ResourceResponseStatus' description: '' x-permissions: - permission: RESOURCE.SUBMIT_REPORT scopes: - offering.customer /api/marketplace-provider-resources/{uuid}/team/: get: operationId: marketplace_provider_resources_team_list description: Return users connected to the project. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-provider-resources security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/ProjectUser' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' /api/marketplace-provider-resources/{uuid}/terminate/: post: operationId: marketplace_provider_resources_terminate description: Create marketplace order for resource termination. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-provider-resources requestBody: content: application/json: schema: $ref: '#/components/schemas/ResourceTerminateRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OrderUUID' description: '' x-permissions: - permission: RESOURCE.TERMINATE scopes: - project - project.customer - offering.customer /api/marketplace-provider-resources/{uuid}/unlink/: post: operationId: marketplace_provider_resources_unlink description: |- Delete marketplace resource and related plugin resource from the database without scheduling operations on backend and without checking current state of the resource. It is intended to be used for removing resource stuck in transitioning state. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-provider-resources security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/marketplace-public-api/check_signature/: post: operationId: marketplace_public_api_check_signature tags: - marketplace-public-api requestBody: content: application/json: schema: $ref: '#/components/schemas/ServiceProviderSignatureRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ServiceProviderSignature' description: '' /api/marketplace-public-api/set_usage/: post: operationId: marketplace_public_api_set_usage tags: - marketplace-public-api requestBody: content: application/json: schema: $ref: '#/components/schemas/ServiceProviderSignatureRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ServiceProviderSignature' description: '' /api/marketplace-public-offerings/: get: operationId: marketplace_public_offerings_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: accessible_via_calls schema: type: boolean description: Accessible via calls - in: query name: allowed_customer_uuid schema: type: string format: uuid description: Allowed customer UUID - in: query name: attributes schema: type: string - in: query name: billable schema: type: boolean - in: query name: category_group_uuid schema: type: string format: uuid - in: query name: category_uuid schema: type: string format: uuid - in: query name: created schema: type: string format: date-time description: Created after - in: query name: customer schema: type: string - in: query name: customer_uuid schema: type: string format: uuid - in: query name: description schema: type: string - in: query name: field schema: type: array items: type: string enum: - access_url - attributes - backend_id - backend_metadata - billable - category - category_title - category_uuid - citation_count - components - country - created - customer - customer_name - customer_uuid - datacite_doi - description - endpoints - files - full_description - getting_started - google_calendar_is_public - google_calendar_link - has_compliance_requirements - image - integration_guide - latitude - longitude - name - options - order_count - organization_groups - parent_description - parent_name - parent_uuid - paused_reason - plans - plugin_options - privacy_policy_link - project - project_name - project_uuid - promotion_campaigns - quotas - resource_options - roles - scope - scope_error_message - scope_name - scope_state - scope_uuid - screenshots - shared - slug - state - thumbnail - total_cost - total_cost_estimated - total_customers - type - url - uuid - vendor_details - in: query name: keyword schema: type: string description: Keyword - in: query name: modified schema: type: string format: date-time description: Modified after - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - in: query name: o schema: type: array items: type: string enum: - -created - -name - -state - -total_cost - -total_cost_estimated - -total_customers - -type - created - name - state - total_cost - total_cost_estimated - total_customers - type description: |+ Ordering explode: false style: form - in: query name: organization_group_uuid schema: type: array items: type: string format: uuid explode: true style: form - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: parent_uuid schema: type: string format: uuid - in: query name: project_uuid schema: type: string format: uuid description: Project UUID - in: query name: resource_customer_uuid schema: type: string format: uuid description: Resource customer UUID - in: query name: resource_project_uuid schema: type: string format: uuid description: Resource project UUID - in: query name: scope_uuid schema: type: string description: Scope UUID - in: query name: service_manager_uuid schema: type: string format: uuid description: Service manager UUID - in: query name: shared schema: type: boolean - in: query name: state schema: type: array items: type: string enum: - Active - Archived - Draft - Paused explode: true style: form - in: query name: type schema: type: array items: type: string explode: true style: form - in: query name: uuid_list schema: type: string description: Comma-separated offering UUIDs tags: - marketplace-public-offerings security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/PublicOfferingDetails' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' head: operationId: marketplace_public_offerings_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: accessible_via_calls schema: type: boolean description: Accessible via calls - in: query name: allowed_customer_uuid schema: type: string format: uuid description: Allowed customer UUID - in: query name: attributes schema: type: string - in: query name: billable schema: type: boolean - in: query name: category_group_uuid schema: type: string format: uuid - in: query name: category_uuid schema: type: string format: uuid - in: query name: created schema: type: string format: date-time description: Created after - in: query name: customer schema: type: string - in: query name: customer_uuid schema: type: string format: uuid - in: query name: description schema: type: string - in: query name: keyword schema: type: string description: Keyword - in: query name: modified schema: type: string format: date-time description: Modified after - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - in: query name: o schema: type: array items: type: string enum: - -created - -name - -state - -total_cost - -total_cost_estimated - -total_customers - -type - created - name - state - total_cost - total_cost_estimated - total_customers - type description: |+ Ordering explode: false style: form - in: query name: organization_group_uuid schema: type: array items: type: string format: uuid explode: true style: form - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: parent_uuid schema: type: string format: uuid - in: query name: project_uuid schema: type: string format: uuid description: Project UUID - in: query name: resource_customer_uuid schema: type: string format: uuid description: Resource customer UUID - in: query name: resource_project_uuid schema: type: string format: uuid description: Resource project UUID - in: query name: scope_uuid schema: type: string description: Scope UUID - in: query name: service_manager_uuid schema: type: string format: uuid description: Service manager UUID - in: query name: shared schema: type: boolean - in: query name: state schema: type: array items: type: string enum: - Active - Archived - Draft - Paused explode: true style: form - in: query name: type schema: type: array items: type: string explode: true style: form - in: query name: uuid_list schema: type: string description: Comma-separated offering UUIDs tags: - marketplace-public-offerings security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/marketplace-public-offerings/{uuid}/: get: operationId: marketplace_public_offerings_retrieve parameters: - in: query name: field schema: type: array items: type: string enum: - access_url - attributes - backend_id - backend_metadata - billable - category - category_title - category_uuid - citation_count - components - country - created - customer - customer_name - customer_uuid - datacite_doi - description - endpoints - files - full_description - getting_started - google_calendar_is_public - google_calendar_link - has_compliance_requirements - image - integration_guide - latitude - longitude - name - options - order_count - organization_groups - parent_description - parent_name - parent_uuid - paused_reason - plans - plugin_options - privacy_policy_link - project - project_name - project_uuid - promotion_campaigns - quotas - resource_options - roles - scope - scope_error_message - scope_name - scope_state - scope_uuid - screenshots - shared - slug - state - thumbnail - total_cost - total_cost_estimated - total_customers - type - url - uuid - vendor_details - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-public-offerings security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PublicOfferingDetails' description: '' /api/marketplace-public-offerings/{uuid}/plans/: get: operationId: marketplace_public_offerings_plans_list parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-public-offerings security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/BasePublicPlan' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' /api/marketplace-public-offerings/{uuid}/plans/{plan_uuid}/: get: operationId: marketplace_public_offerings_plans_retrieve parameters: - in: path name: plan_uuid schema: type: string pattern: ^[a-f0-9]+$ required: true - in: path name: uuid schema: type: string pattern: ^[a-f0-9]+$ required: true tags: - marketplace-public-offerings security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/BasePublicPlan' description: '' /api/marketplace-related-customers/{customer_uuid}/: get: operationId: marketplace_related_customers_list parameters: - in: path name: customer_uuid schema: type: string pattern: ^[a-f0-9]+$ required: true - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - marketplace-related-customers security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/BasicCustomer' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' /api/marketplace-remote-synchronisations/: get: operationId: marketplace_remote_synchronisations_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - marketplace-remote-synchronisations security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/RemoteSynchronisation' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' post: operationId: marketplace_remote_synchronisations_create tags: - marketplace-remote-synchronisations requestBody: content: application/json: schema: $ref: '#/components/schemas/RemoteSynchronisationRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/RemoteSynchronisation' description: '' head: operationId: marketplace_remote_synchronisations_count description: Get number of items in the collection matching the request parameters. parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - marketplace-remote-synchronisations security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/marketplace-remote-synchronisations/{uuid}/: get: operationId: marketplace_remote_synchronisations_retrieve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-remote-synchronisations security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RemoteSynchronisation' description: '' put: operationId: marketplace_remote_synchronisations_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-remote-synchronisations requestBody: content: application/json: schema: $ref: '#/components/schemas/RemoteSynchronisationRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RemoteSynchronisation' description: '' patch: operationId: marketplace_remote_synchronisations_partial_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-remote-synchronisations requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedRemoteSynchronisationRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RemoteSynchronisation' description: '' delete: operationId: marketplace_remote_synchronisations_destroy parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-remote-synchronisations security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '204': description: No response body /api/marketplace-remote-synchronisations/{uuid}/run_synchronisation/: post: operationId: marketplace_remote_synchronisations_run_synchronisation parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-remote-synchronisations security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RemoteSynchronisation' description: '' /api/marketplace-resource-offerings/{category_uuid}/: get: operationId: marketplace_resource_offerings_list parameters: - in: path name: category_uuid schema: type: string pattern: ^[a-f0-9]+$ required: true - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - marketplace-resource-offerings security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/ResourceOffering' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' /api/marketplace-resource-users/: get: operationId: marketplace_resource_users_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: resource schema: type: string - in: query name: resource_uuid schema: type: string format: uuid - in: query name: role_name schema: type: string - in: query name: role_uuid schema: type: string format: uuid - in: query name: user_uuid schema: type: string format: uuid tags: - marketplace-resource-users security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/ResourceUser' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' post: operationId: marketplace_resource_users_create tags: - marketplace-resource-users requestBody: content: application/json: schema: $ref: '#/components/schemas/ResourceUserRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/ResourceUser' description: '' head: operationId: marketplace_resource_users_count description: Get number of items in the collection matching the request parameters. parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: resource schema: type: string - in: query name: resource_uuid schema: type: string format: uuid - in: query name: role_name schema: type: string - in: query name: role_uuid schema: type: string format: uuid - in: query name: user_uuid schema: type: string format: uuid tags: - marketplace-resource-users security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/marketplace-resource-users/{uuid}/: get: operationId: marketplace_resource_users_retrieve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-resource-users security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ResourceUser' description: '' delete: operationId: marketplace_resource_users_destroy parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-resource-users security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '204': description: No response body /api/marketplace-resources/: get: operationId: marketplace_resources_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: backend_id schema: type: string description: Backend ID - in: query name: category_uuid schema: type: string format: uuid - in: query name: created schema: type: string format: date-time description: Created after - in: query name: customer schema: type: string - in: query name: customer_uuid schema: type: string format: uuid - in: query name: downscaled schema: type: boolean - in: query name: field schema: type: array items: type: string enum: - attributes - available_actions - backend_id - backend_metadata - can_terminate - category_icon - category_title - category_uuid - created - creation_order - current_usages - customer_name - customer_slug - customer_uuid - description - downscaled - effective_id - end_date - end_date_requested_by - endpoints - error_message - error_traceback - is_limit_based - is_usage_based - last_sync - limit_usage - limits - modified - name - offering - offering_billable - offering_customer_uuid - offering_description - offering_image - offering_name - offering_plugin_options - offering_shared - offering_slug - offering_thumbnail - offering_type - offering_uuid - options - order_in_progress - parent_name - parent_offering_name - parent_offering_slug - parent_offering_uuid - parent_uuid - paused - plan - plan_description - plan_name - plan_unit - plan_uuid - project - project_description - project_end_date - project_end_date_requested_by - project_name - project_slug - project_uuid - provider_name - provider_uuid - report - resource_type - resource_uuid - restrict_member_access - scope - service_settings_uuid - slug - state - url - user_requires_reconsent - username - uuid - in: query name: has_terminate_date schema: type: boolean description: Has termination date - in: query name: lexis_links_supported schema: type: boolean description: LEXIS links supported - in: query name: modified schema: type: string format: date-time description: Modified after - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - in: query name: o schema: type: array items: type: string enum: - -created - -name - -project_name - -state - created - name - project_name - state description: |+ Ordering explode: false style: form - in: query name: offering schema: type: string - in: query name: offering_billable schema: type: string format: uuid - in: query name: offering_shared schema: type: boolean description: Offering shared - in: query name: offering_slug schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: offering_type schema: type: string - in: query name: offering_uuid schema: type: array items: type: string format: uuid description: Multiple values may be separated by commas. explode: false style: form - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: parent_offering_uuid schema: type: string format: uuid - in: query name: paused schema: type: boolean - in: query name: project_name schema: type: string - in: query name: project_uuid schema: type: string format: uuid - in: query name: provider_uuid schema: type: string format: uuid - in: query name: query schema: type: string description: Search by resource UUID, name, backend ID, effective ID, IPs or hypervisor - in: query name: restrict_member_access schema: type: boolean - in: query name: runtime_state schema: type: string description: Runtime state - in: query name: service_manager_uuid schema: type: string format: uuid description: Service Manager UUID - in: query name: state schema: type: array items: type: string enum: - Creating - Erred - OK - Terminated - Terminating - Updating explode: true style: form - in: query name: visible_to_username schema: type: string description: Visible to username tags: - marketplace-resources security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/Resource' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' head: operationId: marketplace_resources_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: backend_id schema: type: string description: Backend ID - in: query name: category_uuid schema: type: string format: uuid - in: query name: created schema: type: string format: date-time description: Created after - in: query name: customer schema: type: string - in: query name: customer_uuid schema: type: string format: uuid - in: query name: downscaled schema: type: boolean - in: query name: has_terminate_date schema: type: boolean description: Has termination date - in: query name: lexis_links_supported schema: type: boolean description: LEXIS links supported - in: query name: modified schema: type: string format: date-time description: Modified after - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - in: query name: o schema: type: array items: type: string enum: - -created - -name - -project_name - -state - created - name - project_name - state description: |+ Ordering explode: false style: form - in: query name: offering schema: type: string - in: query name: offering_billable schema: type: string format: uuid - in: query name: offering_shared schema: type: boolean description: Offering shared - in: query name: offering_slug schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: offering_type schema: type: string - in: query name: offering_uuid schema: type: array items: type: string format: uuid description: Multiple values may be separated by commas. explode: false style: form - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: parent_offering_uuid schema: type: string format: uuid - in: query name: paused schema: type: boolean - in: query name: project_name schema: type: string - in: query name: project_uuid schema: type: string format: uuid - in: query name: provider_uuid schema: type: string format: uuid - in: query name: query schema: type: string description: Search by resource UUID, name, backend ID, effective ID, IPs or hypervisor - in: query name: restrict_member_access schema: type: boolean - in: query name: runtime_state schema: type: string description: Runtime state - in: query name: service_manager_uuid schema: type: string format: uuid description: Service Manager UUID - in: query name: state schema: type: array items: type: string enum: - Creating - Erred - OK - Terminated - Terminating - Updating explode: true style: form - in: query name: visible_to_username schema: type: string description: Visible to username tags: - marketplace-resources security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/marketplace-resources/{uuid}/: get: operationId: marketplace_resources_retrieve parameters: - in: query name: field schema: type: array items: type: string enum: - attributes - available_actions - backend_id - backend_metadata - can_terminate - category_icon - category_title - category_uuid - created - creation_order - current_usages - customer_name - customer_slug - customer_uuid - description - downscaled - effective_id - end_date - end_date_requested_by - endpoints - error_message - error_traceback - is_limit_based - is_usage_based - last_sync - limit_usage - limits - modified - name - offering - offering_billable - offering_customer_uuid - offering_description - offering_image - offering_name - offering_plugin_options - offering_shared - offering_slug - offering_thumbnail - offering_type - offering_uuid - options - order_in_progress - parent_name - parent_offering_name - parent_offering_slug - parent_offering_uuid - parent_uuid - paused - plan - plan_description - plan_name - plan_unit - plan_uuid - project - project_description - project_end_date - project_end_date_requested_by - project_name - project_slug - project_uuid - provider_name - provider_uuid - report - resource_type - resource_uuid - restrict_member_access - scope - service_settings_uuid - slug - state - url - user_requires_reconsent - username - uuid - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-resources security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Resource' description: '' put: operationId: marketplace_resources_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-resources requestBody: content: application/json: schema: $ref: '#/components/schemas/ResourceUpdateRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ResourceUpdate' description: '' patch: operationId: marketplace_resources_partial_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-resources requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedResourceUpdateRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ResourceUpdate' description: '' /api/marketplace-resources/{uuid}/details/: get: operationId: marketplace_resources_details_retrieve parameters: - in: query name: field schema: type: array items: type: string enum: - attributes - available_actions - backend_id - backend_metadata - can_terminate - category_icon - category_title - category_uuid - created - creation_order - current_usages - customer_name - customer_slug - customer_uuid - description - downscaled - effective_id - end_date - end_date_requested_by - endpoints - error_message - error_traceback - is_limit_based - is_usage_based - last_sync - limit_usage - limits - modified - name - offering - offering_billable - offering_customer_uuid - offering_description - offering_image - offering_name - offering_plugin_options - offering_shared - offering_slug - offering_thumbnail - offering_type - offering_uuid - options - order_in_progress - parent_name - parent_offering_name - parent_offering_slug - parent_offering_uuid - parent_uuid - paused - plan - plan_description - plan_name - plan_unit - plan_uuid - project - project_description - project_end_date - project_end_date_requested_by - project_name - project_slug - project_uuid - provider_name - provider_uuid - report - resource_type - resource_uuid - restrict_member_access - scope - service_settings_uuid - slug - state - url - user_requires_reconsent - username - uuid - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-resources security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Resource' description: '' /api/marketplace-resources/{uuid}/glauth_users_config/: get: operationId: marketplace_resources_glauth_users_config_retrieve description: "\n This endpoint provides a config file for GLauth.\n \ \ Example: https://github.com/glauth/glauth/blob/master/v2/sample-simple.cfg\n\ \ It is assumed that the config is used by an external agent,\n \ \ which synchronizes data from Waldur to GLauth.\n " parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-resources security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: text/plain: schema: type: string description: '' /api/marketplace-resources/{uuid}/move_resource/: post: operationId: marketplace_resources_move_resource description: Move resource to another project. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-resources security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Resource' description: '' /api/marketplace-resources/{uuid}/offering/: get: operationId: marketplace_resources_offering_retrieve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-resources security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PublicOfferingDetails' description: '' /api/marketplace-resources/{uuid}/offering_for_subresources/: get: operationId: marketplace_resources_offering_for_subresources_list parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-resources security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/SubresourceOffering' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' /api/marketplace-resources/{uuid}/plan_periods/: get: operationId: marketplace_resources_plan_periods_list parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-resources security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/ResourcePlanPeriod' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' /api/marketplace-resources/{uuid}/pull/: post: operationId: marketplace_resources_pull description: Starts process of pulling a resource parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-resources security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: object additionalProperties: type: string description: '' /api/marketplace-resources/{uuid}/set_end_date_by_staff/: post: operationId: marketplace_resources_set_end_date_by_staff description: Set end date of the resource by staff. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-resources requestBody: content: application/json: schema: $ref: '#/components/schemas/ResourceEndDateByProviderRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/marketplace-resources/{uuid}/set_slug/: post: operationId: marketplace_resources_set_slug description: Set slug for resource. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-resources requestBody: content: application/json: schema: $ref: '#/components/schemas/ResourceSlugRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/marketplace-resources/{uuid}/switch_plan/: post: operationId: marketplace_resources_switch_plan description: Create marketplace order for resource plan switch. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-resources requestBody: content: application/json: schema: $ref: '#/components/schemas/ResourceSwitchPlanRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OrderUUID' description: '' x-permissions: - permission: RESOURCE.SET_PLAN scopes: - project - project.customer /api/marketplace-resources/{uuid}/team/: get: operationId: marketplace_resources_team_list description: Return users connected to the project. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-resources security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/ProjectUser' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' /api/marketplace-resources/{uuid}/terminate/: post: operationId: marketplace_resources_terminate description: Create marketplace order for resource termination. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-resources requestBody: content: application/json: schema: $ref: '#/components/schemas/ResourceTerminateRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OrderUUID' description: '' x-permissions: - permission: RESOURCE.TERMINATE scopes: - project - project.customer - offering.customer /api/marketplace-resources/{uuid}/unlink/: post: operationId: marketplace_resources_unlink description: |- Delete marketplace resource and related plugin resource from the database without scheduling operations on backend and without checking current state of the resource. It is intended to be used for removing resource stuck in transitioning state. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-resources security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/marketplace-resources/{uuid}/update_limits/: post: operationId: marketplace_resources_update_limits description: Create marketplace order for resource limits update. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-resources requestBody: content: application/json: schema: $ref: '#/components/schemas/ResourceUpdateLimitsRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OrderUUID' description: '' x-permissions: - permission: RESOURCE.SET_LIMITS scopes: - project - project.customer /api/marketplace-resources/{uuid}/update_options/: post: operationId: marketplace_resources_update_options description: Update resource options. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-resources requestBody: content: application/json: schema: $ref: '#/components/schemas/ResourceOptionsRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ResourceResponseStatus' description: '' x-permissions: - permission: RESOURCE.UPDATE_OPTIONS scopes: - project - project.customer /api/marketplace-resources/suggest_name/: post: operationId: marketplace_resources_suggest_name tags: - marketplace-resources requestBody: content: application/json: schema: $ref: '#/components/schemas/ResourceSuggestNameRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ResourceSuggestName' description: '' /api/marketplace-robot-accounts/: get: operationId: marketplace_robot_accounts_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: created schema: type: string format: date-time description: Created after - in: query name: customer_uuid schema: type: string format: uuid - in: query name: field schema: type: array items: type: string enum: - backend_id - created - customer_name - customer_uuid - description - error_message - error_traceback - fingerprints - keys - modified - offering_customer_uuid - offering_plugin_options - project_name - project_uuid - resource - resource_name - resource_uuid - responsible_user - state - type - url - user_keys - username - users - uuid - in: query name: modified schema: type: string format: date-time description: Modified after - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: project_uuid schema: type: string format: uuid - in: query name: provider_uuid schema: type: string format: uuid - in: query name: resource schema: type: string - in: query name: resource_uuid schema: type: string format: uuid - in: query name: state schema: type: integer enum: - 1 - 2 - 3 - 4 - 5 - 6 - in: query name: type schema: type: string tags: - marketplace-robot-accounts security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/RobotAccountDetails' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' post: operationId: marketplace_robot_accounts_create tags: - marketplace-robot-accounts requestBody: content: application/json: schema: $ref: '#/components/schemas/RobotAccountRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/RobotAccount' description: '' head: operationId: marketplace_robot_accounts_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: created schema: type: string format: date-time description: Created after - in: query name: customer_uuid schema: type: string format: uuid - in: query name: modified schema: type: string format: date-time description: Modified after - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: project_uuid schema: type: string format: uuid - in: query name: provider_uuid schema: type: string format: uuid - in: query name: resource schema: type: string - in: query name: resource_uuid schema: type: string format: uuid - in: query name: state schema: type: integer enum: - 1 - 2 - 3 - 4 - 5 - 6 - in: query name: type schema: type: string tags: - marketplace-robot-accounts security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/marketplace-robot-accounts/{uuid}/: get: operationId: marketplace_robot_accounts_retrieve parameters: - in: query name: field schema: type: array items: type: string enum: - backend_id - created - customer_name - customer_uuid - description - error_message - error_traceback - fingerprints - keys - modified - offering_customer_uuid - offering_plugin_options - project_name - project_uuid - resource - resource_name - resource_uuid - responsible_user - state - type - url - user_keys - username - users - uuid - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-robot-accounts security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RobotAccountDetails' description: '' put: operationId: marketplace_robot_accounts_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-robot-accounts requestBody: content: application/json: schema: $ref: '#/components/schemas/RobotAccountRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RobotAccount' description: '' patch: operationId: marketplace_robot_accounts_partial_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-robot-accounts requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedRobotAccountRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RobotAccount' description: '' delete: operationId: marketplace_robot_accounts_destroy parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-robot-accounts security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '204': description: No response body x-permissions: - permission: RESOURCE.DELETE_ROBOT_ACCOUNT scopes: - resource.offering.customer /api/marketplace-robot-accounts/{uuid}/set_state_creating/: post: operationId: marketplace_robot_accounts_set_state_creating parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-robot-accounts security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RobotAccountDetails' description: '' '400': content: application/json: schema: $ref: '#/components/schemas/StateTransitionError' description: '' x-permissions: - permission: RESOURCE.UPDATE_ROBOT_ACCOUNT scopes: - resource.offering.customer /api/marketplace-robot-accounts/{uuid}/set_state_deleted/: post: operationId: marketplace_robot_accounts_set_state_deleted parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-robot-accounts security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RobotAccountDetails' description: '' x-permissions: - permission: RESOURCE.UPDATE_ROBOT_ACCOUNT scopes: - resource.offering.customer /api/marketplace-robot-accounts/{uuid}/set_state_erred/: post: operationId: marketplace_robot_accounts_set_state_erred parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-robot-accounts requestBody: content: application/json: schema: $ref: '#/components/schemas/RobotAccountErrorRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RobotAccountDetails' description: '' x-permissions: - permission: RESOURCE.UPDATE_ROBOT_ACCOUNT scopes: - resource.offering.customer /api/marketplace-robot-accounts/{uuid}/set_state_ok/: post: operationId: marketplace_robot_accounts_set_state_ok parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-robot-accounts security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RobotAccountDetails' description: '' x-permissions: - permission: RESOURCE.UPDATE_ROBOT_ACCOUNT scopes: - resource.offering.customer /api/marketplace-robot-accounts/{uuid}/set_state_request_deletion/: post: operationId: marketplace_robot_accounts_set_state_request_deletion parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-robot-accounts security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RobotAccountDetails' description: '' x-permissions: - permission: RESOURCE.UPDATE_ROBOT_ACCOUNT scopes: - resource.offering.customer /api/marketplace-runtime-states/: get: operationId: marketplace_runtime_states_list description: Retrieve available runtime states for resources, optionally filtered by project and category. parameters: - in: query name: category_uuid schema: type: string format: uuid description: UUID of the category to filter runtime states by. - in: query name: project_uuid schema: type: string format: uuid description: UUID of the project to filter runtime states by. tags: - marketplace-runtime-states security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/RuntimeStates' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' /api/marketplace-screenshots/: get: operationId: marketplace_screenshots_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: o schema: type: array items: type: string enum: - -created - -name - created - name description: |+ Ordering explode: false style: form - in: query name: offering schema: type: string - in: query name: offering_slug schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: offering_uuid schema: type: array items: type: string format: uuid description: Multiple values may be separated by commas. explode: false style: form - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: parent_offering_uuid schema: type: string format: uuid tags: - marketplace-screenshots security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/Screenshot' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' post: operationId: marketplace_screenshots_create tags: - marketplace-screenshots requestBody: content: application/json: schema: $ref: '#/components/schemas/ScreenshotRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/Screenshot' description: '' head: operationId: marketplace_screenshots_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: o schema: type: array items: type: string enum: - -created - -name - created - name description: |+ Ordering explode: false style: form - in: query name: offering schema: type: string - in: query name: offering_slug schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: offering_uuid schema: type: array items: type: string format: uuid description: Multiple values may be separated by commas. explode: false style: form - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: parent_offering_uuid schema: type: string format: uuid tags: - marketplace-screenshots security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/marketplace-screenshots/{uuid}/: get: operationId: marketplace_screenshots_retrieve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-screenshots security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Screenshot' description: '' put: operationId: marketplace_screenshots_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-screenshots requestBody: content: application/json: schema: $ref: '#/components/schemas/ScreenshotRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Screenshot' description: '' patch: operationId: marketplace_screenshots_partial_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-screenshots requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedScreenshotRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Screenshot' description: '' delete: operationId: marketplace_screenshots_destroy parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-screenshots security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '204': description: No response body x-permissions: - permission: OFFERING.DELETE_SCREENSHOT scopes: - offering.customer /api/marketplace-script-async-dry-run/: get: operationId: marketplace_script_async_dry_run_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - marketplace-script-async-dry-run security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/DryRun' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' head: operationId: marketplace_script_async_dry_run_count description: Get number of items in the collection matching the request parameters. parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - marketplace-script-async-dry-run security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/marketplace-script-async-dry-run/{uuid}/: get: operationId: marketplace_script_async_dry_run_retrieve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-script-async-dry-run security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/DryRun' description: '' /api/marketplace-script-dry-run/{uuid}/async_run/: post: operationId: marketplace_script_dry_run_async_run parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-script-dry-run requestBody: content: application/json: schema: $ref: '#/components/schemas/DryRunRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PublicOfferingDetails' description: '' x-permissions: - permission: OFFERING.DRY_RUN_SCRIPT scopes: - '*' - customer /api/marketplace-script-dry-run/{uuid}/run/: post: operationId: marketplace_script_dry_run_run parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-script-dry-run requestBody: content: application/json: schema: $ref: '#/components/schemas/DryRunRequest' examples: Dry-runOrderExample: value: plan: http://127.0.0.1:8000/api/marketplace-plans/ed80e1047eeb4c9eb67f6e61b98977bc/ type: Update summary: Create security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PublicOfferingDetails' description: '' x-permissions: - permission: OFFERING.DRY_RUN_SCRIPT scopes: - '*' - customer /api/marketplace-script-sync-resource/: post: operationId: marketplace_script_sync_resource description: Pull a marketplace script resource. summary: |- This view allows a user to trigger a pull operation for a marketplace script resource. The user must be a service consumer and have access to the resource. The pull operation is performed asynchronously using Celery. tags: - marketplace-script-sync-resource requestBody: content: application/json: schema: $ref: '#/components/schemas/PullMarketplaceScriptResourceRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '202': description: No response body '404': description: No response body /api/marketplace-sections/: get: operationId: marketplace_sections_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - marketplace-sections security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/Section' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' post: operationId: marketplace_sections_create tags: - marketplace-sections requestBody: content: application/json: schema: $ref: '#/components/schemas/SectionRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/Section' description: '' head: operationId: marketplace_sections_count description: Get number of items in the collection matching the request parameters. parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - marketplace-sections security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/marketplace-sections/{key}/: get: operationId: marketplace_sections_retrieve parameters: - in: path name: key schema: type: string description: A unique value identifying this section. required: true tags: - marketplace-sections security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Section' description: '' put: operationId: marketplace_sections_update parameters: - in: path name: key schema: type: string description: A unique value identifying this section. required: true tags: - marketplace-sections requestBody: content: application/json: schema: $ref: '#/components/schemas/SectionRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Section' description: '' patch: operationId: marketplace_sections_partial_update parameters: - in: path name: key schema: type: string description: A unique value identifying this section. required: true tags: - marketplace-sections requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedSectionRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Section' description: '' delete: operationId: marketplace_sections_destroy parameters: - in: path name: key schema: type: string description: A unique value identifying this section. required: true tags: - marketplace-sections security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '204': description: No response body /api/marketplace-service-providers/: get: operationId: marketplace_service_providers_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: customer schema: type: string - in: query name: customer_keyword schema: type: string - in: query name: customer_uuid schema: type: string format: uuid - in: query name: field schema: type: array items: type: string enum: - created - customer - customer_abbreviation - customer_country - customer_image - customer_name - customer_native_name - customer_slug - customer_uuid - description - enable_notifications - image - offering_count - organization_groups - url - uuid - in: query name: o schema: type: array items: type: string enum: - -customer_name - customer_name description: |+ Ordering explode: false style: form - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - marketplace-service-providers security: - tokenAuth: [] - waldurOIDCAuth: [] - {} responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/ServiceProvider' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' post: operationId: marketplace_service_providers_create tags: - marketplace-service-providers requestBody: content: application/json: schema: $ref: '#/components/schemas/ServiceProviderRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/ServiceProvider' description: '' head: operationId: marketplace_service_providers_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: customer schema: type: string - in: query name: customer_keyword schema: type: string - in: query name: customer_uuid schema: type: string format: uuid - in: query name: o schema: type: array items: type: string enum: - -customer_name - customer_name description: |+ Ordering explode: false style: form - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - marketplace-service-providers security: - tokenAuth: [] - waldurOIDCAuth: [] - {} responses: '200': description: No response body /api/marketplace-service-providers/{service_provider_uuid}/compliance/compliance_overview/: get: operationId: service_provider_compliance_overview description: Get compliance overview statistics for all offerings managed by this service provider. parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: path name: service_provider_uuid schema: type: string format: uuid required: true tags: - marketplace-service-providers security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/ServiceProviderComplianceOverview' description: '' description: '' /api/marketplace-service-providers/{service_provider_uuid}/compliance/offering_users/: get: operationId: service_provider_offering_users_compliance description: List offering users with their compliance status for this service provider. parameters: - in: query name: compliance_status schema: type: string description: 'Filter by compliance status: completed, pending, no_checklist' - in: query name: offering_uuid schema: type: string format: uuid description: Filter by offering UUID - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: path name: service_provider_uuid schema: type: string format: uuid required: true tags: - marketplace-service-providers security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/ServiceProviderOfferingUserCompliance' description: '' description: '' /api/marketplace-service-providers/{service_provider_uuid}/course_accounts/: get: operationId: marketplace_service_providers_course_accounts_list description: "Return course project accounts that have access to resources managed\ \ by the provider.\n\n Checks for:\n - Projects with active\ \ service provider's resources\n - Course accounts with non-blank users\n\ \n " parameters: - in: query name: email schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: project_uuid schema: type: string format: uuid - in: path name: service_provider_uuid schema: type: string format: uuid required: true - in: query name: state schema: type: array items: type: string enum: - Closed - Erred - OK explode: true style: form - in: query name: username schema: type: string tags: - marketplace-service-providers security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/CourseAccount' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' /api/marketplace-service-providers/{service_provider_uuid}/customer_projects/: get: operationId: marketplace_service_providers_customer_projects_list description: Return customer projects of service provider. parameters: - in: query name: backend_id schema: type: string - in: query name: can_admin schema: type: boolean description: Return a list of projects where current user is admin. - in: query name: can_manage schema: type: boolean description: Return a list of projects where current user is manager or a customer owner. - in: query name: conceal_finished_projects schema: type: boolean description: Conceal finished projects - in: query name: created schema: type: string format: date-time description: Created after - in: query name: customer schema: type: array items: type: string format: uuid description: Multiple values may be separated by commas. explode: false style: form - in: query name: customer_abbreviation schema: type: string - in: query name: customer_name schema: type: string - in: query name: customer_native_name schema: type: string - in: query name: description schema: type: string - in: query name: field schema: type: array items: type: string enum: - billing_price_estimate - description - end_date - name - resources_count - users_count - uuid - in: query name: modified schema: type: string format: date-time description: Modified after - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - in: query name: o schema: type: array items: type: string enum: - -created - -customer_abbreviation - -customer_name - -customer_native_name - -end_date - -estimated_cost - -name - -start_date - created - customer_abbreviation - customer_name - customer_native_name - end_date - estimated_cost - name - start_date description: |+ Ordering explode: false style: form - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: query schema: type: string description: Filter by name, UUID, backend ID or resource effective ID - in: path name: service_provider_uuid schema: type: string format: uuid required: true - in: query name: slug schema: type: string tags: - marketplace-service-providers security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/MarketplaceProviderCustomerProject' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' /api/marketplace-service-providers/{service_provider_uuid}/customers/: get: operationId: marketplace_service_providers_customers_list description: Return customers of service provider. parameters: - in: query name: abbreviation schema: type: string - in: query name: agreement_number schema: type: string - in: query name: archived schema: type: boolean - in: query name: backend_id schema: type: string - in: query name: contact_details schema: type: string - in: query name: field schema: type: array items: type: string enum: - abbreviation - billing_price_estimate - email - name - payment_profiles - phone_number - projects - projects_count - slug - users - users_count - uuid - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - in: query name: native_name schema: type: string - in: query name: organization_group_name schema: type: string - in: query name: organization_group_uuid schema: type: array items: type: string format: uuid description: organization_group_uuid explode: true style: form - in: query name: owned_by_current_user schema: type: boolean description: Return a list of customers where current user is owner. - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: query schema: type: string description: Filter by name, native name, abbreviation, domain, UUID, registration code or agreement number - in: query name: registration_code schema: type: string - in: path name: service_provider_uuid schema: type: string format: uuid required: true tags: - marketplace-service-providers security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/MarketplaceProviderCustomer' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' /api/marketplace-service-providers/{service_provider_uuid}/keys/: get: operationId: marketplace_service_providers_keys_list description: Return SSH keys of service provider. parameters: - in: query name: created schema: type: string format: date-time description: Created after - in: query name: field schema: type: array items: type: string enum: - fingerprint_md5 - fingerprint_sha256 - fingerprint_sha512 - is_shared - name - public_key - type - url - user_uuid - uuid - in: query name: fingerprint_md5 schema: type: string - in: query name: fingerprint_sha256 schema: type: string - in: query name: fingerprint_sha512 schema: type: string - in: query name: is_shared schema: type: boolean - in: query name: modified schema: type: string format: date-time description: Modified after - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - in: query name: o schema: type: array items: type: string enum: - -name - name description: |+ Ordering explode: false style: form - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: path name: service_provider_uuid schema: type: string format: uuid required: true - in: query name: user_uuid schema: type: string format: uuid - in: query name: uuid schema: type: string format: uuid tags: - marketplace-service-providers security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/SshKey' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' /api/marketplace-service-providers/{service_provider_uuid}/offerings/: get: operationId: marketplace_service_providers_offerings_list description: Return offerings of service provider. parameters: - in: query name: accessible_via_calls schema: type: boolean description: Accessible via calls - in: query name: allowed_customer_uuid schema: type: string format: uuid description: Allowed customer UUID - in: query name: attributes schema: type: string - in: query name: billable schema: type: boolean - in: query name: category_group_uuid schema: type: string format: uuid - in: query name: category_uuid schema: type: string format: uuid - in: query name: created schema: type: string format: date-time description: Created after - in: query name: customer schema: type: string - in: query name: customer_uuid schema: type: string format: uuid - in: query name: description schema: type: string - in: query name: field schema: type: array items: type: string enum: - billing_price_estimate - category_title - components - customer_uuid - name - options - plans - resource_options - resources_count - secret_options - slug - state - type - uuid - in: query name: keyword schema: type: string description: Keyword - in: query name: modified schema: type: string format: date-time description: Modified after - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - in: query name: o schema: type: array items: type: string enum: - -created - -name - -state - -total_cost - -total_cost_estimated - -total_customers - -type - created - name - state - total_cost - total_cost_estimated - total_customers - type description: |+ Ordering explode: false style: form - in: query name: organization_group_uuid schema: type: array items: type: string format: uuid explode: true style: form - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: parent_uuid schema: type: string format: uuid - in: query name: project_uuid schema: type: string format: uuid description: Project UUID - in: query name: resource_customer_uuid schema: type: string format: uuid description: Resource customer UUID - in: query name: resource_project_uuid schema: type: string format: uuid description: Resource project UUID - in: query name: scope_uuid schema: type: string description: Scope UUID - in: query name: service_manager_uuid schema: type: string format: uuid description: Service manager UUID - in: path name: service_provider_uuid schema: type: string format: uuid required: true - in: query name: shared schema: type: boolean - in: query name: state schema: type: array items: type: string enum: - Active - Archived - Draft - Paused explode: true style: form - in: query name: type schema: type: array items: type: string explode: true style: form - in: query name: uuid_list schema: type: string description: Comma-separated offering UUIDs tags: - marketplace-service-providers security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/ProviderOffering' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' /api/marketplace-service-providers/{service_provider_uuid}/project_permissions/: get: operationId: marketplace_service_providers_project_permissions_list description: Return project permissions of service provider. parameters: - in: query name: created schema: type: string format: date-time description: Created after - in: query name: expiration_time schema: type: string format: date-time - in: query name: field schema: type: array items: type: string enum: - created - created_by - created_by_full_name - created_by_username - customer_name - customer_uuid - expiration_time - project - project_created - project_end_date - project_name - project_uuid - role - role_name - user - user_email - user_full_name - user_native_name - user_username - user_uuid - in: query name: full_name schema: type: string description: User full name contains - in: query name: modified schema: type: string format: date-time description: Modified after - in: query name: native_name schema: type: string - in: query name: o schema: type: array items: type: string enum: - -created - -email - -expiration_time - -full_name - -native_name - -role - -username - created - email - expiration_time - full_name - native_name - role - username description: |+ Ordering explode: false style: form - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: role_name schema: type: string description: Role name contains - in: query name: role_uuid schema: type: string format: uuid description: Role UUID - in: query name: scope_name schema: type: string description: Scope name - in: query name: scope_type schema: type: string description: Scope type - in: query name: scope_uuid schema: type: string description: Scope UUID - in: path name: service_provider_uuid schema: type: string format: uuid required: true - in: query name: user schema: type: string format: uuid - in: query name: user_slug schema: type: string description: User slug contains - in: query name: user_url schema: type: string - in: query name: username schema: type: string tags: - marketplace-service-providers security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/ProjectPermissionLog' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' /api/marketplace-service-providers/{service_provider_uuid}/project_service_accounts/: get: operationId: marketplace_service_providers_project_service_accounts_list description: "Return project service accounts that have access to resources\ \ managed by the provider.\n\n Checks for:\n - Projects with\ \ active service provider's resources\n - Service accounts with non-blank\ \ usernames\n\n " parameters: - in: query name: email schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: project schema: type: string - in: query name: project_uuid schema: type: string format: uuid - in: path name: service_provider_uuid schema: type: string format: uuid required: true - in: query name: state schema: type: array items: type: string enum: - Closed - Erred - OK explode: true style: form - in: query name: username schema: type: string tags: - marketplace-service-providers security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/ProjectServiceAccount' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' /api/marketplace-service-providers/{service_provider_uuid}/projects/: get: operationId: marketplace_service_providers_projects_list description: Return projects of service provider. parameters: - in: query name: backend_id schema: type: string - in: query name: can_admin schema: type: boolean description: Return a list of projects where current user is admin. - in: query name: can_manage schema: type: boolean description: Return a list of projects where current user is manager or a customer owner. - in: query name: conceal_finished_projects schema: type: boolean description: Conceal finished projects - in: query name: created schema: type: string format: date-time description: Created after - in: query name: customer schema: type: array items: type: string format: uuid description: Multiple values may be separated by commas. explode: false style: form - in: query name: customer_abbreviation schema: type: string - in: query name: customer_name schema: type: string - in: query name: customer_native_name schema: type: string - in: query name: description schema: type: string - in: query name: field schema: type: array items: type: string enum: - backend_id - billing_price_estimate - created - customer - customer_abbreviation - customer_name - customer_native_name - customer_slug - customer_uuid - description - end_date - end_date_requested_by - image - is_industry - kind - marketplace_resource_count - max_service_accounts - name - oecd_fos_2007_code - oecd_fos_2007_label - project_credit - resources_count - slug - start_date - type - type_name - type_uuid - url - uuid - in: query name: modified schema: type: string format: date-time description: Modified after - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - in: query name: o schema: type: array items: type: string enum: - -created - -customer_abbreviation - -customer_name - -customer_native_name - -end_date - -estimated_cost - -name - -start_date - created - customer_abbreviation - customer_name - customer_native_name - end_date - estimated_cost - name - start_date description: |+ Ordering explode: false style: form - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: query schema: type: string description: Filter by name, UUID, backend ID or resource effective ID - in: path name: service_provider_uuid schema: type: string format: uuid required: true - in: query name: slug schema: type: string tags: - marketplace-service-providers security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/Project' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' /api/marketplace-service-providers/{service_provider_uuid}/user_customers/: get: operationId: marketplace_service_providers_user_customers_list description: |- Return customers that have access role for a specified user within service provider's scope. Checks for: - Customers where user has direct permissions - Customers with projects where user has project roles - Customers related to service provider's resources If user UUID is invalid or missing, returns empty list. parameters: - in: query name: abbreviation schema: type: string - in: query name: agreement_number schema: type: string - in: query name: archived schema: type: boolean - in: query name: backend_id schema: type: string - in: query name: contact_details schema: type: string - in: query name: field schema: type: array items: type: string enum: - abbreviation - billing_price_estimate - email - name - payment_profiles - phone_number - projects - projects_count - slug - users - users_count - uuid - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - in: query name: native_name schema: type: string - in: query name: organization_group_name schema: type: string - in: query name: organization_group_uuid schema: type: array items: type: string format: uuid description: organization_group_uuid explode: true style: form - in: query name: owned_by_current_user schema: type: boolean description: Return a list of customers where current user is owner. - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: query schema: type: string description: Filter by name, native name, abbreviation, domain, UUID, registration code or agreement number - in: query name: registration_code schema: type: string - in: path name: service_provider_uuid schema: type: string format: uuid required: true - in: query name: user_uuid schema: type: string format: uuid description: UUID of user to get related customers for required: true tags: - marketplace-service-providers security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/MarketplaceProviderCustomer' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' /api/marketplace-service-providers/{service_provider_uuid}/users/: get: operationId: marketplace_service_providers_users_list description: Return users of service provider. parameters: - in: query name: agreement_date schema: type: string format: date-time description: Agreement date after - in: query name: civil_number schema: type: string - in: query name: customer_uuid schema: type: string format: uuid - in: query name: date_joined schema: type: string format: date-time description: Date joined after - in: query name: description schema: type: string - in: query name: email schema: type: string - in: query name: field schema: type: array items: type: string enum: - affiliations - email - first_name - full_name - is_active - last_name - organization - phone_number - projects_count - registration_method - username - uuid - in: query name: full_name schema: type: string description: Full name - in: query name: is_active schema: type: boolean - in: query name: is_staff schema: type: boolean - in: query name: is_support schema: type: boolean - in: query name: job_title schema: type: string - in: query name: modified schema: type: string format: date-time description: Date modified after - in: query name: native_name schema: type: string - in: query name: o schema: type: array items: type: string enum: - -description - -email - -full_name - -is_active - -is_staff - -is_support - -job_title - -native_name - -organization - -phone_number - -registration_method - -username - description - email - full_name - is_active - is_staff - is_support - job_title - native_name - organization - phone_number - registration_method - username description: |+ Ordering explode: false style: form - in: query name: organization schema: type: string - in: query name: organization_roles schema: type: string description: Organization roles - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: phone_number schema: type: string - in: query name: project_roles schema: type: string description: Project roles - in: query name: project_uuid schema: type: string format: uuid - in: query name: query schema: type: string description: Filter by first name, last name, civil number, username or email - in: query name: registration_method schema: type: string - in: path name: service_provider_uuid schema: type: string format: uuid required: true - in: query name: user_keyword schema: type: string description: User keyword - in: query name: username schema: type: string - in: query name: username_list schema: type: string description: Comma-separated usernames tags: - marketplace-service-providers security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/MarketplaceServiceProviderUser' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' /api/marketplace-service-providers/{uuid}/: get: operationId: marketplace_service_providers_retrieve parameters: - in: query name: field schema: type: array items: type: string enum: - created - customer - customer_abbreviation - customer_country - customer_image - customer_name - customer_native_name - customer_slug - customer_uuid - description - enable_notifications - image - offering_count - organization_groups - url - uuid - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-service-providers security: - tokenAuth: [] - waldurOIDCAuth: [] - {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/ServiceProvider' description: '' put: operationId: marketplace_service_providers_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-service-providers requestBody: content: application/json: schema: $ref: '#/components/schemas/ServiceProviderRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ServiceProvider' description: '' patch: operationId: marketplace_service_providers_partial_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-service-providers requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedServiceProviderRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ServiceProvider' description: '' delete: operationId: marketplace_service_providers_destroy parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-service-providers security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '204': description: No response body /api/marketplace-service-providers/{uuid}/add_user/: post: operationId: marketplace_service_providers_add_user parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-service-providers requestBody: content: application/json: schema: $ref: '#/components/schemas/UserRoleCreateRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/UserRoleExpirationTime' description: '' /api/marketplace-service-providers/{uuid}/api_secret_code/: get: operationId: service_provider_api_secret_code_retrieve description: Return service provider API secret code. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-service-providers security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ServiceProviderApiSecretCode' description: '' post: operationId: service_provider_api_secret_code_generate description: Generate new service provider API secret code. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-service-providers security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ServiceProviderApiSecretCode' description: '' /api/marketplace-service-providers/{uuid}/delete_user/: post: operationId: marketplace_service_providers_delete_user parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-service-providers requestBody: content: application/json: schema: $ref: '#/components/schemas/UserRoleDeleteRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/marketplace-service-providers/{uuid}/list_users/: get: operationId: marketplace_service_providers_list_users_list parameters: - in: query name: field schema: type: array items: type: string enum: - created - created_by_full_name - created_by_uuid - expiration_time - role_name - role_uuid - user_email - user_full_name - user_image - user_username - user_uuid - uuid description: Fields to include in response - in: query name: full_name schema: type: string description: User full name - in: query name: native_name schema: type: string description: User native name - in: query name: o schema: type: array items: type: string enum: - created - email - expiration_time - full_name - native_name - role - username description: Ordering fields - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: role schema: type: string format: uuid description: Role UUID or name - in: query name: search_string schema: type: string description: Search string for user - in: query name: user schema: type: string format: uuid description: User UUID - in: query name: user_slug schema: type: string description: User slug - in: query name: user_url schema: type: string description: User URL - in: query name: username schema: type: string description: User username - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-service-providers security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/UserRoleDetails' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' /api/marketplace-service-providers/{uuid}/revenue/: get: operationId: marketplace_service_providers_revenue_list parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-service-providers security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/ServiceProviderRevenues' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' x-permissions: - permission: SERVICE_PROVIDER.GET_REVENUE scopes: - customer /api/marketplace-service-providers/{uuid}/robot_account_customers/: get: operationId: marketplace_service_providers_robot_account_customers_list parameters: - in: query name: customer_name schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-service-providers security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/NameUUID' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' x-permissions: - permission: SERVICE_PROVIDER.GET_ROBOT_ACCOUNT_CUSTOMERS scopes: - customer /api/marketplace-service-providers/{uuid}/robot_account_projects/: get: operationId: marketplace_service_providers_robot_account_projects_list parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: project_name schema: type: string - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-service-providers security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/NameUUID' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' x-permissions: - permission: SERVICE_PROVIDER.GET_ROBOT_ACCOUNT_PROJECTS scopes: - customer /api/marketplace-service-providers/{uuid}/set_offerings_username/: post: operationId: marketplace_service_providers_set_offerings_username parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-service-providers requestBody: content: application/json: schema: $ref: '#/components/schemas/SetOfferingsUsernameRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/SetOfferingsUsername' description: '' x-permissions: - permission: SERVICE_PROVIDER.SET_OFFERINGS_USERNAME scopes: - customer /api/marketplace-service-providers/{uuid}/stat/: get: operationId: marketplace_service_providers_stat_retrieve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-service-providers security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ServiceProviderStatistics' description: '' x-permissions: - permission: SERVICE_PROVIDER.GET_STATISTICS scopes: - customer /api/marketplace-service-providers/{uuid}/update_user/: post: operationId: marketplace_service_providers_update_user parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-service-providers requestBody: content: application/json: schema: $ref: '#/components/schemas/UserRoleUpdateRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/UserRoleExpirationTime' description: '' /api/marketplace-stats/component_usages/: get: operationId: marketplace_stats_component_usages_list description: Return component usages for current month. parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - marketplace-stats security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/ComponentUsagesStats' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' head: operationId: marketplace_stats_component_usages_count description: Get number of items in the collection matching the request parameters. parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - marketplace-stats security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/marketplace-stats/component_usages_per_month/: get: operationId: marketplace_stats_component_usages_per_month_list description: Return component usages per month. parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - marketplace-stats security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/ComponentUsagesPerMonthStats' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' head: operationId: marketplace_stats_component_usages_per_month_count description: Get number of items in the collection matching the request parameters. parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - marketplace-stats security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/marketplace-stats/component_usages_per_project/: get: operationId: marketplace_stats_component_usages_per_project_list description: Return component usages per project. parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - marketplace-stats security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/ComponentUsagesPerProject' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' head: operationId: marketplace_stats_component_usages_per_project_count description: Get number of items in the collection matching the request parameters. parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - marketplace-stats security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/marketplace-stats/count_active_resources_grouped_by_offering/: get: operationId: marketplace_stats_count_active_resources_grouped_by_offering_list description: Count active resources grouped by offering. parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - marketplace-stats security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/OfferingStats' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' head: operationId: marketplace_stats_count_active_resources_grouped_by_offering_count description: Get number of items in the collection matching the request parameters. parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - marketplace-stats security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/marketplace-stats/count_active_resources_grouped_by_offering_country/: get: operationId: marketplace_stats_count_active_resources_grouped_by_offering_country_list description: Count active resources grouped by offering country. parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - marketplace-stats security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/OfferingCountryStats' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' head: operationId: marketplace_stats_count_active_resources_grouped_by_offering_country_count description: Get number of items in the collection matching the request parameters. parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - marketplace-stats security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/marketplace-stats/count_active_resources_grouped_by_organization_group/: get: operationId: marketplace_stats_count_active_resources_grouped_by_organization_group_list description: Count active resources grouped by organization group. parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - marketplace-stats security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/CountStats' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' head: operationId: marketplace_stats_count_active_resources_grouped_by_organization_group_count description: Get number of items in the collection matching the request parameters. parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - marketplace-stats security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/marketplace-stats/count_projects_grouped_by_provider_and_industry_flag/: get: operationId: marketplace_stats_count_projects_grouped_by_provider_and_industry_flag_list description: Count projects grouped by provider and industry flag parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - marketplace-stats security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/CustomerIndustryFlagStats' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' head: operationId: marketplace_stats_count_projects_grouped_by_provider_and_industry_flag_count description: Get number of items in the collection matching the request parameters. parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - marketplace-stats security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/marketplace-stats/count_projects_grouped_by_provider_and_oecd/: get: operationId: marketplace_stats_count_projects_grouped_by_provider_and_oecd_list description: Count projects grouped by provider and OECD code parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - marketplace-stats security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/CustomerOecdCodeStats' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' head: operationId: marketplace_stats_count_projects_grouped_by_provider_and_oecd_count description: Get number of items in the collection matching the request parameters. parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - marketplace-stats security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/marketplace-stats/count_projects_of_service_providers/: get: operationId: marketplace_stats_count_projects_of_service_providers_list description: Count projects of service providers. parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - marketplace-stats security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/CountProjectsOfServiceProviders' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' head: operationId: marketplace_stats_count_projects_of_service_providers_count description: Get number of items in the collection matching the request parameters. parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - marketplace-stats security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/marketplace-stats/count_projects_of_service_providers_grouped_by_oecd/: get: operationId: marketplace_stats_count_projects_of_service_providers_grouped_by_oecd_list description: Count projects of service providers grouped by OECD. parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - marketplace-stats security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/CountProjectsOfServiceProvidersGroupedByOecd' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' head: operationId: marketplace_stats_count_projects_of_service_providers_grouped_by_oecd_count description: Get number of items in the collection matching the request parameters. parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - marketplace-stats security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/marketplace-stats/count_unique_users_connected_with_active_resources_of_service_provider/: get: operationId: marketplace_stats_count_unique_users_connected_with_active_resources_of_service_provider_list description: Count unique users connected with active resources of service provider. parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - marketplace-stats security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/CountUniqueUsersConnectedWithActiveResourcesOfServiceProvider' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' head: operationId: marketplace_stats_count_unique_users_connected_with_active_resources_of_service_provider_count description: Get number of items in the collection matching the request parameters. parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - marketplace-stats security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/marketplace-stats/count_users_of_service_providers/: get: operationId: marketplace_stats_count_users_of_service_providers_list description: Count users of service providers. parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - marketplace-stats security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/CountUsersOfServiceProviders' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' head: operationId: marketplace_stats_count_users_of_service_providers_count description: Get number of items in the collection matching the request parameters. parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - marketplace-stats security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/marketplace-stats/customer_member_count/: get: operationId: marketplace_stats_customer_member_count_list description: Return count of customer members. parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - marketplace-stats security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/CustomerMemberCount' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' head: operationId: marketplace_stats_customer_member_count_count description: Get number of items in the collection matching the request parameters. parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - marketplace-stats security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/marketplace-stats/offerings_counter_stats/: get: operationId: marketplace_stats_offerings_counter_stats_list description: Retrieve statistics about the number of offerings, grouped by category and service provider. parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - marketplace-stats security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/OfferingStatsCounter' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' head: operationId: marketplace_stats_offerings_counter_stats_count description: Get number of items in the collection matching the request parameters. parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - marketplace-stats security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/marketplace-stats/organization_project_count/: get: operationId: marketplace_stats_organization_project_count_list description: Return project count per organization. parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - marketplace-stats security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/MarketplaceCustomerStats' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' head: operationId: marketplace_stats_organization_project_count_count description: Get number of items in the collection matching the request parameters. parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - marketplace-stats security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/marketplace-stats/organization_resource_count/: get: operationId: marketplace_stats_organization_resource_count_list description: Return resource count per organization. parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - marketplace-stats security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/MarketplaceCustomerStats' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' head: operationId: marketplace_stats_organization_resource_count_count description: Get number of items in the collection matching the request parameters. parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - marketplace-stats security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/marketplace-stats/projects_limits_grouped_by_industry_flag/: get: operationId: marketplace_stats_projects_limits_grouped_by_industry_flag_retrieve description: Group project limits by industry flag. tags: - marketplace-stats security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ProjectsLimitsGroupedByIndustryFlag' description: '' head: operationId: marketplace_stats_projects_limits_grouped_by_industry_flag_count description: Get number of items in the collection matching the request parameters. tags: - marketplace-stats security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/marketplace-stats/projects_limits_grouped_by_oecd/: get: operationId: marketplace_stats_projects_limits_grouped_by_oecd_retrieve description: Group project limits by OECD code. tags: - marketplace-stats security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ProjectsLimitsGroupedByOecd' description: '' head: operationId: marketplace_stats_projects_limits_grouped_by_oecd_count description: Get number of items in the collection matching the request parameters. tags: - marketplace-stats security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/marketplace-stats/projects_usages_grouped_by_industry_flag/: get: operationId: marketplace_stats_projects_usages_grouped_by_industry_flag_retrieve description: Group project usages by industry flag. tags: - marketplace-stats security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ProjectsUsagesGroupedByIndustryFlag' description: '' head: operationId: marketplace_stats_projects_usages_grouped_by_industry_flag_count description: Get number of items in the collection matching the request parameters. tags: - marketplace-stats security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/marketplace-stats/projects_usages_grouped_by_oecd/: get: operationId: marketplace_stats_projects_usages_grouped_by_oecd_retrieve description: Group project usages by OECD code. tags: - marketplace-stats security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ProjectsUsagesGroupedByOecd' description: '' head: operationId: marketplace_stats_projects_usages_grouped_by_oecd_count description: Get number of items in the collection matching the request parameters. tags: - marketplace-stats security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/marketplace-stats/resources_limits/: get: operationId: marketplace_stats_resources_limits_list description: Return resources limits per offering. parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - marketplace-stats security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/ResourcesLimits' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' head: operationId: marketplace_stats_resources_limits_count description: Get number of items in the collection matching the request parameters. parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - marketplace-stats security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/marketplace-stats/total_cost_of_active_resources_per_offering/: get: operationId: marketplace_stats_total_cost_of_active_resources_per_offering_list description: Total cost of active resources per offering. parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - marketplace-stats security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/OfferingCost' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' head: operationId: marketplace_stats_total_cost_of_active_resources_per_offering_count description: Get number of items in the collection matching the request parameters. parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - marketplace-stats security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/marketplace-user-offering-consents/: get: operationId: marketplace_user_offering_consents_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: has_consent schema: type: boolean - in: query name: o schema: type: array items: type: string enum: - -agreement_date - -created - -modified - -revocation_date - agreement_date - created - modified - revocation_date description: |+ Ordering explode: false style: form - in: query name: offering schema: type: string - in: query name: offering_uuid schema: type: string format: uuid - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: requires_reconsent schema: type: boolean - in: query name: user schema: type: string - in: query name: user_uuid schema: type: string format: uuid - in: query name: version schema: type: string tags: - marketplace-user-offering-consents security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/UserOfferingConsent' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' post: operationId: marketplace_user_offering_consents_create tags: - marketplace-user-offering-consents requestBody: content: application/json: schema: $ref: '#/components/schemas/UserOfferingConsentCreateRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/UserOfferingConsentCreate' description: '' head: operationId: marketplace_user_offering_consents_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: has_consent schema: type: boolean - in: query name: o schema: type: array items: type: string enum: - -agreement_date - -created - -modified - -revocation_date - agreement_date - created - modified - revocation_date description: |+ Ordering explode: false style: form - in: query name: offering schema: type: string - in: query name: offering_uuid schema: type: string format: uuid - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: requires_reconsent schema: type: boolean - in: query name: user schema: type: string - in: query name: user_uuid schema: type: string format: uuid - in: query name: version schema: type: string tags: - marketplace-user-offering-consents security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/marketplace-user-offering-consents/{uuid}/: get: operationId: marketplace_user_offering_consents_retrieve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-user-offering-consents security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/UserOfferingConsent' description: '' put: operationId: marketplace_user_offering_consents_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-user-offering-consents requestBody: content: application/json: schema: $ref: '#/components/schemas/UserOfferingConsentRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/UserOfferingConsent' description: '' patch: operationId: marketplace_user_offering_consents_partial_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-user-offering-consents requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedUserOfferingConsentRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/UserOfferingConsent' description: '' delete: operationId: marketplace_user_offering_consents_destroy parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-user-offering-consents security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '204': description: No response body /api/marketplace-user-offering-consents/{uuid}/revoke/: post: operationId: marketplace_user_offering_consents_revoke description: Revoke consent to Terms of Service for an offering. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - marketplace-user-offering-consents security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/UserOfferingConsent' description: '' /api/media/{uuid}/: get: operationId: media_retrieve description: Get media file parameters: - in: path name: uuid schema: type: string pattern: ^.+$ required: true tags: - media security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: string format: binary description: '' /api/notification-messages/: get: operationId: notification_messages_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: description schema: type: string - in: query name: is_overridden schema: type: boolean - in: query name: key schema: type: string - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: query schema: type: string description: Filter by key or description tags: - notification-messages security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/Notification' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' post: operationId: notification_messages_create tags: - notification-messages requestBody: content: application/json: schema: $ref: '#/components/schemas/NotificationRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/Notification' description: '' head: operationId: notification_messages_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: description schema: type: string - in: query name: is_overridden schema: type: boolean - in: query name: key schema: type: string - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: query schema: type: string description: Filter by key or description tags: - notification-messages security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/notification-messages-templates/: get: operationId: notification_messages_templates_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: is_overridden schema: type: boolean - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: path schema: type: string - in: query name: path_exact schema: type: string tags: - notification-messages-templates security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/NotificationTemplateDetailSerializers' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' post: operationId: notification_messages_templates_create tags: - notification-messages-templates requestBody: content: application/json: schema: $ref: '#/components/schemas/NotificationTemplateDetailSerializersRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/NotificationTemplateDetailSerializers' description: '' head: operationId: notification_messages_templates_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: is_overridden schema: type: boolean - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: path schema: type: string - in: query name: path_exact schema: type: string tags: - notification-messages-templates security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/notification-messages-templates/{uuid}/: get: operationId: notification_messages_templates_retrieve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - notification-messages-templates security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/NotificationTemplateDetailSerializers' description: '' put: operationId: notification_messages_templates_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - notification-messages-templates requestBody: content: application/json: schema: $ref: '#/components/schemas/NotificationTemplateDetailSerializersRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/NotificationTemplateDetailSerializers' description: '' patch: operationId: notification_messages_templates_partial_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - notification-messages-templates requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedNotificationTemplateDetailSerializersRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/NotificationTemplateDetailSerializers' description: '' delete: operationId: notification_messages_templates_destroy parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - notification-messages-templates security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '204': description: No response body /api/notification-messages-templates/{uuid}/override/: post: operationId: notification_messages_templates_override parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - notification-messages-templates requestBody: content: application/json: schema: $ref: '#/components/schemas/NotificationTemplateUpdateSerializersRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/notification-messages/{uuid}/: get: operationId: notification_messages_retrieve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - notification-messages security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Notification' description: '' put: operationId: notification_messages_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - notification-messages requestBody: content: application/json: schema: $ref: '#/components/schemas/NotificationRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Notification' description: '' patch: operationId: notification_messages_partial_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - notification-messages requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedNotificationRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Notification' description: '' delete: operationId: notification_messages_destroy parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - notification-messages security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '204': description: No response body /api/notification-messages/{uuid}/disable/: post: operationId: notification_messages_disable parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - notification-messages security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/notification-messages/{uuid}/enable/: post: operationId: notification_messages_enable parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - notification-messages security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/openstack-backups/: get: operationId: openstack_backups_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: backend_id schema: type: string - in: query name: can_manage schema: type: boolean description: Can manage - in: query name: customer schema: type: string format: uuid - in: query name: customer_abbreviation schema: type: string - in: query name: customer_name schema: type: string - in: query name: customer_native_name schema: type: string - in: query name: customer_uuid schema: type: string format: uuid - in: query name: description schema: type: string - in: query name: external_ip schema: type: string - in: query name: field schema: type: array items: type: string enum: - access_url - backend_id - created - customer - customer_abbreviation - customer_name - customer_native_name - description - error_message - error_traceback - instance - instance_floating_ips - instance_marketplace_uuid - instance_name - instance_ports - instance_security_groups - is_limit_based - is_usage_based - kept_until - marketplace_category_name - marketplace_category_uuid - marketplace_offering_name - marketplace_offering_plugin_options - marketplace_offering_uuid - marketplace_plan_uuid - marketplace_resource_state - marketplace_resource_uuid - metadata - modified - name - project - project_name - project_uuid - resource_type - restorations - service_name - service_settings - service_settings_error_message - service_settings_state - service_settings_uuid - state - tenant_uuid - url - uuid - in: query name: instance schema: type: string - in: query name: instance_uuid schema: type: string format: uuid - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: project schema: type: string format: uuid - in: query name: project_name schema: type: string - in: query name: project_uuid schema: type: string format: uuid - in: query name: service_settings_name schema: type: string - in: query name: service_settings_uuid schema: type: string format: uuid - in: query name: state schema: type: array items: type: string enum: - CREATING - CREATION_SCHEDULED - DELETING - DELETION_SCHEDULED - ERRED - OK - UPDATE_SCHEDULED - UPDATING explode: true style: form - in: query name: tenant schema: type: string - in: query name: tenant_uuid schema: type: string format: uuid - in: query name: uuid schema: type: string format: uuid tags: - openstack-backups security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/OpenStackBackup' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' head: operationId: openstack_backups_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: backend_id schema: type: string - in: query name: can_manage schema: type: boolean description: Can manage - in: query name: customer schema: type: string format: uuid - in: query name: customer_abbreviation schema: type: string - in: query name: customer_name schema: type: string - in: query name: customer_native_name schema: type: string - in: query name: customer_uuid schema: type: string format: uuid - in: query name: description schema: type: string - in: query name: external_ip schema: type: string - in: query name: instance schema: type: string - in: query name: instance_uuid schema: type: string format: uuid - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: project schema: type: string format: uuid - in: query name: project_name schema: type: string - in: query name: project_uuid schema: type: string format: uuid - in: query name: service_settings_name schema: type: string - in: query name: service_settings_uuid schema: type: string format: uuid - in: query name: state schema: type: array items: type: string enum: - CREATING - CREATION_SCHEDULED - DELETING - DELETION_SCHEDULED - ERRED - OK - UPDATE_SCHEDULED - UPDATING explode: true style: form - in: query name: tenant schema: type: string - in: query name: tenant_uuid schema: type: string format: uuid - in: query name: uuid schema: type: string format: uuid tags: - openstack-backups security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/openstack-backups/{uuid}/: get: operationId: openstack_backups_retrieve parameters: - in: query name: field schema: type: array items: type: string enum: - access_url - backend_id - created - customer - customer_abbreviation - customer_name - customer_native_name - description - error_message - error_traceback - instance - instance_floating_ips - instance_marketplace_uuid - instance_name - instance_ports - instance_security_groups - is_limit_based - is_usage_based - kept_until - marketplace_category_name - marketplace_category_uuid - marketplace_offering_name - marketplace_offering_plugin_options - marketplace_offering_uuid - marketplace_plan_uuid - marketplace_resource_state - marketplace_resource_uuid - metadata - modified - name - project - project_name - project_uuid - resource_type - restorations - service_name - service_settings - service_settings_error_message - service_settings_state - service_settings_uuid - state - tenant_uuid - url - uuid - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-backups security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OpenStackBackup' description: '' put: operationId: openstack_backups_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-backups requestBody: content: application/json: schema: $ref: '#/components/schemas/OpenStackBackupRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OpenStackBackup' description: '' patch: operationId: openstack_backups_partial_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-backups requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedOpenStackBackupRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OpenStackBackup' description: '' delete: operationId: openstack_backups_destroy parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-backups security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '204': description: No response body /api/openstack-backups/{uuid}/pull/: post: operationId: openstack_backups_pull parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-backups security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/openstack-backups/{uuid}/restore/: post: operationId: openstack_backups_restore description: Restore instance from backup parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-backups requestBody: content: application/json: schema: $ref: '#/components/schemas/OpenStackBackupRestorationRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OpenStackInstance' description: '' /api/openstack-backups/{uuid}/unlink/: post: operationId: openstack_backups_unlink description: |- Delete resource from the database without scheduling operations on backend and without checking current state of the resource. It is intended to be used for removing resource stuck in transitioning state. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-backups security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/openstack-flavors/: get: operationId: openstack_flavors_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: cores schema: type: integer - in: query name: cores__gte schema: type: integer - in: query name: cores__lte schema: type: integer - in: query name: disk schema: type: integer - in: query name: disk__gte schema: type: integer - in: query name: disk__lte schema: type: integer - in: query name: field schema: type: array items: type: string enum: - backend_id - cores - disk - display_name - name - ram - settings - url - uuid - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - in: query name: name_iregex schema: type: string - in: query name: o schema: type: array items: type: string enum: - -cores - -disk - -ram - cores - disk - ram description: |+ Ordering explode: false style: form - in: query name: offering_uuid schema: type: string format: uuid - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: ram schema: type: integer - in: query name: ram__gte schema: type: integer - in: query name: ram__lte schema: type: integer - in: query name: settings schema: type: string - in: query name: settings_uuid schema: type: string format: uuid - in: query name: tenant schema: type: string - in: query name: tenant_uuid schema: type: string format: uuid tags: - openstack-flavors security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/OpenStackFlavor' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' head: operationId: openstack_flavors_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: cores schema: type: integer - in: query name: cores__gte schema: type: integer - in: query name: cores__lte schema: type: integer - in: query name: disk schema: type: integer - in: query name: disk__gte schema: type: integer - in: query name: disk__lte schema: type: integer - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - in: query name: name_iregex schema: type: string - in: query name: o schema: type: array items: type: string enum: - -cores - -disk - -ram - cores - disk - ram description: |+ Ordering explode: false style: form - in: query name: offering_uuid schema: type: string format: uuid - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: ram schema: type: integer - in: query name: ram__gte schema: type: integer - in: query name: ram__lte schema: type: integer - in: query name: settings schema: type: string - in: query name: settings_uuid schema: type: string format: uuid - in: query name: tenant schema: type: string - in: query name: tenant_uuid schema: type: string format: uuid tags: - openstack-flavors security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/openstack-flavors/{uuid}/: get: operationId: openstack_flavors_retrieve parameters: - in: query name: field schema: type: array items: type: string enum: - backend_id - cores - disk - display_name - name - ram - settings - url - uuid - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-flavors security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OpenStackFlavor' description: '' /api/openstack-flavors/usage_stats/: get: operationId: openstack_flavors_usage_stats_retrieve parameters: - in: query name: field schema: type: array items: type: string enum: - backend_id - cores - disk - display_name - name - ram - settings - url - uuid tags: - openstack-flavors security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OpenStackFlavor' description: '' head: operationId: openstack_flavors_usage_stats_count tags: - openstack-flavors security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body description: Get number of items in the collection matching the request parameters. /api/openstack-floating-ips/: get: operationId: openstack_floating_ips_list description: Status *DOWN* means that floating IP is not linked to a VM, status *ACTIVE* means that it is in use. parameters: - in: query name: address schema: type: string - in: query name: backend_id schema: type: string - in: query name: can_manage schema: type: boolean description: Can manage - in: query name: customer schema: type: string format: uuid - in: query name: customer_abbreviation schema: type: string - in: query name: customer_name schema: type: string - in: query name: customer_native_name schema: type: string - in: query name: customer_uuid schema: type: string format: uuid - in: query name: description schema: type: string - in: query name: external_ip schema: type: string - in: query name: field schema: type: array items: type: string enum: - access_url - address - backend_id - backend_network_id - created - customer - customer_abbreviation - customer_name - customer_native_name - description - error_message - error_traceback - external_address - instance_name - instance_url - instance_uuid - is_limit_based - is_usage_based - marketplace_category_name - marketplace_category_uuid - marketplace_offering_name - marketplace_offering_plugin_options - marketplace_offering_uuid - marketplace_plan_uuid - marketplace_resource_state - marketplace_resource_uuid - modified - name - port - port_fixed_ips - project - project_name - project_uuid - resource_type - runtime_state - service_name - service_settings - service_settings_error_message - service_settings_state - service_settings_uuid - state - tenant - tenant_name - tenant_uuid - url - uuid - in: query name: free schema: type: boolean - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: project schema: type: string format: uuid - in: query name: project_name schema: type: string - in: query name: project_uuid schema: type: string format: uuid - in: query name: runtime_state schema: type: string - in: query name: service_settings_name schema: type: string - in: query name: service_settings_uuid schema: type: string format: uuid - in: query name: state schema: type: array items: type: string enum: - CREATING - CREATION_SCHEDULED - DELETING - DELETION_SCHEDULED - ERRED - OK - UPDATE_SCHEDULED - UPDATING explode: true style: form - in: query name: tenant schema: type: string - in: query name: tenant_uuid schema: type: string format: uuid - in: query name: uuid schema: type: string format: uuid tags: - openstack-floating-ips security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/OpenStackFloatingIP' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' head: operationId: openstack_floating_ips_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: address schema: type: string - in: query name: backend_id schema: type: string - in: query name: can_manage schema: type: boolean description: Can manage - in: query name: customer schema: type: string format: uuid - in: query name: customer_abbreviation schema: type: string - in: query name: customer_name schema: type: string - in: query name: customer_native_name schema: type: string - in: query name: customer_uuid schema: type: string format: uuid - in: query name: description schema: type: string - in: query name: external_ip schema: type: string - in: query name: free schema: type: boolean - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: project schema: type: string format: uuid - in: query name: project_name schema: type: string - in: query name: project_uuid schema: type: string format: uuid - in: query name: runtime_state schema: type: string - in: query name: service_settings_name schema: type: string - in: query name: service_settings_uuid schema: type: string format: uuid - in: query name: state schema: type: array items: type: string enum: - CREATING - CREATION_SCHEDULED - DELETING - DELETION_SCHEDULED - ERRED - OK - UPDATE_SCHEDULED - UPDATING explode: true style: form - in: query name: tenant schema: type: string - in: query name: tenant_uuid schema: type: string format: uuid - in: query name: uuid schema: type: string format: uuid tags: - openstack-floating-ips security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/openstack-floating-ips/{uuid}/: get: operationId: openstack_floating_ips_retrieve parameters: - in: query name: field schema: type: array items: type: string enum: - access_url - address - backend_id - backend_network_id - created - customer - customer_abbreviation - customer_name - customer_native_name - description - error_message - error_traceback - external_address - instance_name - instance_url - instance_uuid - is_limit_based - is_usage_based - marketplace_category_name - marketplace_category_uuid - marketplace_offering_name - marketplace_offering_plugin_options - marketplace_offering_uuid - marketplace_plan_uuid - marketplace_resource_state - marketplace_resource_uuid - modified - name - port - port_fixed_ips - project - project_name - project_uuid - resource_type - runtime_state - service_name - service_settings - service_settings_error_message - service_settings_state - service_settings_uuid - state - tenant - tenant_name - tenant_uuid - url - uuid - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-floating-ips security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OpenStackFloatingIP' description: '' delete: operationId: openstack_floating_ips_destroy parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-floating-ips security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '204': description: No response body /api/openstack-floating-ips/{uuid}/attach_to_port/: post: operationId: openstack_floating_ips_attach_to_port description: Attach floating IP to port parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-floating-ips requestBody: content: application/json: schema: $ref: '#/components/schemas/OpenStackFloatingIPAttachRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/openstack-floating-ips/{uuid}/detach_from_port/: post: operationId: openstack_floating_ips_detach_from_port description: Detach floating IP from port parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-floating-ips security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/openstack-floating-ips/{uuid}/pull/: post: operationId: openstack_floating_ips_pull parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-floating-ips security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/openstack-floating-ips/{uuid}/unlink/: post: operationId: openstack_floating_ips_unlink description: |- Delete resource from the database without scheduling operations on backend and without checking current state of the resource. It is intended to be used for removing resource stuck in transitioning state. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-floating-ips security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/openstack-floating-ips/{uuid}/update_description/: post: operationId: openstack_floating_ips_update_description description: Update description of the floating IP parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-floating-ips requestBody: content: application/json: schema: $ref: '#/components/schemas/OpenStackFloatingIPDescriptionUpdateRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/openstack-images/: get: operationId: openstack_images_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - in: query name: offering_uuid schema: type: string format: uuid - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: settings schema: type: string - in: query name: settings_uuid schema: type: string format: uuid - in: query name: tenant schema: type: string - in: query name: tenant_uuid schema: type: string format: uuid tags: - openstack-images security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/OpenStackImage' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' head: operationId: openstack_images_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - in: query name: offering_uuid schema: type: string format: uuid - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: settings schema: type: string - in: query name: settings_uuid schema: type: string format: uuid - in: query name: tenant schema: type: string - in: query name: tenant_uuid schema: type: string format: uuid tags: - openstack-images security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/openstack-images/{uuid}/: get: operationId: openstack_images_retrieve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-images security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OpenStackImage' description: '' /api/openstack-images/usage_stats/: get: operationId: openstack_images_usage_stats_retrieve tags: - openstack-images security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OpenStackImage' description: '' head: operationId: openstack_images_usage_stats_count tags: - openstack-images security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body description: Get number of items in the collection matching the request parameters. /api/openstack-instance-availability-zones/: get: operationId: openstack_instance_availability_zones_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: settings schema: type: string - in: query name: settings_uuid schema: type: string format: uuid - in: query name: tenant schema: type: string - in: query name: tenant_uuid schema: type: string format: uuid tags: - openstack-instance-availability-zones security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/OpenStackInstanceAvailabilityZone' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' head: operationId: openstack_instance_availability_zones_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: settings schema: type: string - in: query name: settings_uuid schema: type: string format: uuid - in: query name: tenant schema: type: string - in: query name: tenant_uuid schema: type: string format: uuid tags: - openstack-instance-availability-zones security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/openstack-instance-availability-zones/{uuid}/: get: operationId: openstack_instance_availability_zones_retrieve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-instance-availability-zones security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OpenStackInstanceAvailabilityZone' description: '' /api/openstack-instances/: get: operationId: openstack_instances_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: attach_volume_uuid schema: type: string format: uuid - in: query name: availability_zone_name schema: type: string - in: query name: backend_id schema: type: string - in: query name: can_manage schema: type: boolean description: Can manage - in: query name: customer schema: type: string format: uuid - in: query name: customer_abbreviation schema: type: string - in: query name: customer_name schema: type: string - in: query name: customer_native_name schema: type: string - in: query name: customer_uuid schema: type: string format: uuid - in: query name: description schema: type: string - in: query name: external_ip schema: type: string - in: query name: field schema: type: array items: type: string enum: - access_url - action - action_details - availability_zone - availability_zone_name - backend_id - connect_directly_to_external_network - cores - created - customer - customer_abbreviation - customer_name - customer_native_name - data_volume_size - data_volume_type - data_volumes - description - disk - error_message - error_traceback - external_address - external_ips - flavor - flavor_disk - flavor_name - floating_ips - hypervisor_hostname - image - image_name - internal_ips - is_limit_based - is_usage_based - key_fingerprint - key_name - latitude - longitude - marketplace_category_name - marketplace_category_uuid - marketplace_offering_name - marketplace_offering_plugin_options - marketplace_offering_uuid - marketplace_plan_uuid - marketplace_resource_state - marketplace_resource_uuid - min_disk - min_ram - modified - name - ports - project - project_name - project_uuid - ram - rancher_cluster - resource_type - runtime_state - security_groups - server_group - service_name - service_settings - service_settings_error_message - service_settings_state - service_settings_uuid - ssh_public_key - start_time - state - system_volume_size - system_volume_type - tenant - tenant_uuid - url - user_data - uuid - volumes - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: project schema: type: string format: uuid - in: query name: project_name schema: type: string - in: query name: project_uuid schema: type: string format: uuid - in: query name: query schema: type: string description: Search by name, internal IP, or external IP - in: query name: runtime_state schema: type: string - in: query name: service_settings_name schema: type: string - in: query name: service_settings_uuid schema: type: string format: uuid - in: query name: state schema: type: array items: type: string enum: - CREATING - CREATION_SCHEDULED - DELETING - DELETION_SCHEDULED - ERRED - OK - UPDATE_SCHEDULED - UPDATING explode: true style: form - in: query name: tenant schema: type: string - in: query name: tenant_uuid schema: type: string format: uuid - in: query name: uuid schema: type: string format: uuid tags: - openstack-instances security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/OpenStackInstance' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' head: operationId: openstack_instances_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: attach_volume_uuid schema: type: string format: uuid - in: query name: availability_zone_name schema: type: string - in: query name: backend_id schema: type: string - in: query name: can_manage schema: type: boolean description: Can manage - in: query name: customer schema: type: string format: uuid - in: query name: customer_abbreviation schema: type: string - in: query name: customer_name schema: type: string - in: query name: customer_native_name schema: type: string - in: query name: customer_uuid schema: type: string format: uuid - in: query name: description schema: type: string - in: query name: external_ip schema: type: string - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: project schema: type: string format: uuid - in: query name: project_name schema: type: string - in: query name: project_uuid schema: type: string format: uuid - in: query name: query schema: type: string description: Search by name, internal IP, or external IP - in: query name: runtime_state schema: type: string - in: query name: service_settings_name schema: type: string - in: query name: service_settings_uuid schema: type: string format: uuid - in: query name: state schema: type: array items: type: string enum: - CREATING - CREATION_SCHEDULED - DELETING - DELETION_SCHEDULED - ERRED - OK - UPDATE_SCHEDULED - UPDATING explode: true style: form - in: query name: tenant schema: type: string - in: query name: tenant_uuid schema: type: string format: uuid - in: query name: uuid schema: type: string format: uuid tags: - openstack-instances security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/openstack-instances/{uuid}/: get: operationId: openstack_instances_retrieve parameters: - in: query name: field schema: type: array items: type: string enum: - access_url - action - action_details - availability_zone - availability_zone_name - backend_id - connect_directly_to_external_network - cores - created - customer - customer_abbreviation - customer_name - customer_native_name - data_volume_size - data_volume_type - data_volumes - description - disk - error_message - error_traceback - external_address - external_ips - flavor - flavor_disk - flavor_name - floating_ips - hypervisor_hostname - image - image_name - internal_ips - is_limit_based - is_usage_based - key_fingerprint - key_name - latitude - longitude - marketplace_category_name - marketplace_category_uuid - marketplace_offering_name - marketplace_offering_plugin_options - marketplace_offering_uuid - marketplace_plan_uuid - marketplace_resource_state - marketplace_resource_uuid - min_disk - min_ram - modified - name - ports - project - project_name - project_uuid - ram - rancher_cluster - resource_type - runtime_state - security_groups - server_group - service_name - service_settings - service_settings_error_message - service_settings_state - service_settings_uuid - ssh_public_key - start_time - state - system_volume_size - system_volume_type - tenant - tenant_uuid - url - user_data - uuid - volumes - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-instances security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OpenStackInstance' description: '' put: operationId: openstack_instances_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-instances requestBody: content: application/json: schema: $ref: '#/components/schemas/OpenStackInstanceRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OpenStackInstance' description: '' patch: operationId: openstack_instances_partial_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-instances requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedOpenStackInstanceRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OpenStackInstance' description: '' /api/openstack-instances/{uuid}/backup/: post: operationId: openstack_instances_backup description: Create backup from instance parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-instances requestBody: content: application/json: schema: $ref: '#/components/schemas/OpenStackBackupRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OpenStackBackup' description: '' /api/openstack-instances/{uuid}/change_flavor/: post: operationId: openstack_instances_change_flavor description: Change flavor of the instance parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-instances requestBody: content: application/json: schema: $ref: '#/components/schemas/InstanceFlavorChangeRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/openstack-instances/{uuid}/console/: get: operationId: openstack_instances_console_retrieve description: Get console url for the instance parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-instances security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ConsoleUrl' description: '' /api/openstack-instances/{uuid}/console_log/: get: operationId: openstack_instances_console_log_retrieve description: Get console log for the instance parameters: - in: query name: length schema: type: integer - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-instances security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: string description: '' /api/openstack-instances/{uuid}/floating_ips/: get: operationId: openstack_instances_floating_ips_list description: Get a list of instance floating IPs parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-instances security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/OpenStackNestedFloatingIP' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' /api/openstack-instances/{uuid}/ports/: get: operationId: openstack_instances_ports_list description: Get a list of instance ports parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-instances security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/OpenStackNestedPort' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' /api/openstack-instances/{uuid}/pull/: post: operationId: openstack_instances_pull parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-instances security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/openstack-instances/{uuid}/restart/: post: operationId: openstack_instances_restart description: Restart the instance parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-instances security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/openstack-instances/{uuid}/start/: post: operationId: openstack_instances_start description: Start the instance parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-instances security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/openstack-instances/{uuid}/stop/: post: operationId: openstack_instances_stop description: Stop the instance parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-instances security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/openstack-instances/{uuid}/unlink/: post: operationId: openstack_instances_unlink description: |- Delete resource from the database without scheduling operations on backend and without checking current state of the resource. It is intended to be used for removing resource stuck in transitioning state. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-instances security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/openstack-instances/{uuid}/update_allowed_address_pairs/: post: operationId: openstack_instances_update_allowed_address_pairs description: Update allowed address pairs of the instance parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-instances requestBody: content: application/json: schema: $ref: '#/components/schemas/OpenStackInstanceAllowedAddressPairsUpdateRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/openstack-instances/{uuid}/update_floating_ips/: post: operationId: openstack_instances_update_floating_ips description: Update floating IPs of the instance parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-instances requestBody: content: application/json: schema: $ref: '#/components/schemas/OpenStackInstanceFloatingIPsUpdateRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/openstack-instances/{uuid}/update_ports/: post: operationId: openstack_instances_update_ports description: Update ports of the instance parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-instances requestBody: content: application/json: schema: $ref: '#/components/schemas/OpenStackInstancePortsUpdateRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/openstack-instances/{uuid}/update_security_groups/: post: operationId: openstack_instances_update_security_groups description: Update security groups of the instance parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-instances requestBody: content: application/json: schema: $ref: '#/components/schemas/OpenStackInstanceSecurityGroupsUpdateRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/openstack-marketplace-tenants/: get: operationId: openstack_marketplace_tenants_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: backend_id schema: type: string - in: query name: can_manage schema: type: boolean description: Can manage - in: query name: customer schema: type: string format: uuid - in: query name: customer_abbreviation schema: type: string - in: query name: customer_name schema: type: string - in: query name: customer_native_name schema: type: string - in: query name: customer_uuid schema: type: string format: uuid - in: query name: description schema: type: string - in: query name: external_ip schema: type: string - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: project schema: type: string format: uuid - in: query name: project_name schema: type: string - in: query name: project_uuid schema: type: string format: uuid - in: query name: service_settings_name schema: type: string - in: query name: service_settings_uuid schema: type: string format: uuid - in: query name: state schema: type: array items: type: string enum: - CREATING - CREATION_SCHEDULED - DELETING - DELETION_SCHEDULED - ERRED - OK - UPDATE_SCHEDULED - UPDATING explode: true style: form - in: query name: uuid schema: type: string format: uuid tags: - openstack-marketplace-tenants security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/Tenant' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' head: operationId: openstack_marketplace_tenants_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: backend_id schema: type: string - in: query name: can_manage schema: type: boolean description: Can manage - in: query name: customer schema: type: string format: uuid - in: query name: customer_abbreviation schema: type: string - in: query name: customer_name schema: type: string - in: query name: customer_native_name schema: type: string - in: query name: customer_uuid schema: type: string format: uuid - in: query name: description schema: type: string - in: query name: external_ip schema: type: string - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: project schema: type: string format: uuid - in: query name: project_name schema: type: string - in: query name: project_uuid schema: type: string format: uuid - in: query name: service_settings_name schema: type: string - in: query name: service_settings_uuid schema: type: string format: uuid - in: query name: state schema: type: array items: type: string enum: - CREATING - CREATION_SCHEDULED - DELETING - DELETION_SCHEDULED - ERRED - OK - UPDATE_SCHEDULED - UPDATING explode: true style: form - in: query name: uuid schema: type: string format: uuid tags: - openstack-marketplace-tenants security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/openstack-marketplace-tenants/{uuid}/: get: operationId: openstack_marketplace_tenants_retrieve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-marketplace-tenants security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Tenant' description: '' /api/openstack-marketplace-tenants/{uuid}/create_image/: post: operationId: openstack_marketplace_tenants_create_image parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-marketplace-tenants requestBody: content: application/json: schema: $ref: '#/components/schemas/ImageCreateRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/ImageCreateResponse' description: '' /api/openstack-marketplace-tenants/{uuid}/upload_image_data/{image_id}/: post: operationId: openstack_marketplace_tenants_upload_image_data parameters: - in: path name: image_id schema: type: string format: uuid required: true - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-marketplace-tenants requestBody: content: application/json: schema: type: string format: binary security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ImageUploadResponse' description: '' /api/openstack-migrations/: get: operationId: openstack_migrations_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: dst_resource_uuid schema: type: string format: uuid - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: src_resource_uuid schema: type: string format: uuid tags: - openstack-migrations security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/MigrationDetails' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' post: operationId: openstack_migrations_create tags: - openstack-migrations requestBody: content: application/json: schema: $ref: '#/components/schemas/MigrationCreateRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/MigrationCreate' description: '' head: operationId: openstack_migrations_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: dst_resource_uuid schema: type: string format: uuid - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: src_resource_uuid schema: type: string format: uuid tags: - openstack-migrations security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/openstack-migrations/{uuid}/: get: operationId: openstack_migrations_retrieve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-migrations security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/MigrationDetails' description: '' put: operationId: openstack_migrations_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-migrations requestBody: content: application/json: schema: $ref: '#/components/schemas/MigrationDetailsRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/MigrationDetails' description: '' patch: operationId: openstack_migrations_partial_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-migrations requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedMigrationDetailsRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/MigrationDetails' description: '' delete: operationId: openstack_migrations_destroy parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-migrations security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '204': description: No response body /api/openstack-network-rbac-policies/: get: operationId: openstack_network_rbac_policies_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: network schema: type: string - in: query name: network_uuid schema: type: string format: uuid - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: policy_type schema: type: string enum: - access_as_external - access_as_shared description: |+ Type of access granted - either shared access or external network access - in: query name: target_tenant schema: type: string - in: query name: target_tenant_uuid schema: type: string format: uuid tags: - openstack-network-rbac-policies security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/NetworkRBACPolicy' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' head: operationId: openstack_network_rbac_policies_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: network schema: type: string - in: query name: network_uuid schema: type: string format: uuid - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: policy_type schema: type: string enum: - access_as_external - access_as_shared description: |+ Type of access granted - either shared access or external network access - in: query name: target_tenant schema: type: string - in: query name: target_tenant_uuid schema: type: string format: uuid tags: - openstack-network-rbac-policies security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/openstack-network-rbac-policies/{uuid}/: get: operationId: openstack_network_rbac_policies_retrieve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-network-rbac-policies security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/NetworkRBACPolicy' description: '' /api/openstack-networks/: get: operationId: openstack_networks_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: backend_id schema: type: string - in: query name: can_manage schema: type: boolean description: Can manage - in: query name: customer schema: type: string format: uuid - in: query name: customer_abbreviation schema: type: string - in: query name: customer_name schema: type: string - in: query name: customer_native_name schema: type: string - in: query name: customer_uuid schema: type: string format: uuid - in: query name: description schema: type: string - in: query name: direct_only schema: type: boolean description: Direct only - in: query name: external_ip schema: type: string - in: query name: field schema: type: array items: type: string enum: - access_url - backend_id - created - customer - customer_abbreviation - customer_name - customer_native_name - description - error_message - error_traceback - is_external - is_limit_based - is_usage_based - marketplace_category_name - marketplace_category_uuid - marketplace_offering_name - marketplace_offering_plugin_options - marketplace_offering_uuid - marketplace_plan_uuid - marketplace_resource_state - marketplace_resource_uuid - modified - mtu - name - project - project_name - project_uuid - rbac_policies - resource_type - segmentation_id - service_name - service_settings - service_settings_error_message - service_settings_state - service_settings_uuid - state - subnets - tenant - tenant_name - tenant_uuid - type - url - uuid - in: query name: is_external schema: type: boolean - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: project schema: type: string format: uuid - in: query name: project_name schema: type: string - in: query name: project_uuid schema: type: string format: uuid - in: query name: rbac_only schema: type: boolean description: RBAC only - in: query name: service_settings_name schema: type: string - in: query name: service_settings_uuid schema: type: string format: uuid - in: query name: state schema: type: array items: type: string enum: - CREATING - CREATION_SCHEDULED - DELETING - DELETION_SCHEDULED - ERRED - OK - UPDATE_SCHEDULED - UPDATING explode: true style: form - in: query name: tenant schema: type: string description: Tenant URL - in: query name: tenant_uuid schema: type: string format: uuid description: Tenant UUID - in: query name: type schema: type: string - in: query name: uuid schema: type: string format: uuid tags: - openstack-networks security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/OpenStackNetwork' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' head: operationId: openstack_networks_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: backend_id schema: type: string - in: query name: can_manage schema: type: boolean description: Can manage - in: query name: customer schema: type: string format: uuid - in: query name: customer_abbreviation schema: type: string - in: query name: customer_name schema: type: string - in: query name: customer_native_name schema: type: string - in: query name: customer_uuid schema: type: string format: uuid - in: query name: description schema: type: string - in: query name: direct_only schema: type: boolean description: Direct only - in: query name: external_ip schema: type: string - in: query name: is_external schema: type: boolean - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: project schema: type: string format: uuid - in: query name: project_name schema: type: string - in: query name: project_uuid schema: type: string format: uuid - in: query name: rbac_only schema: type: boolean description: RBAC only - in: query name: service_settings_name schema: type: string - in: query name: service_settings_uuid schema: type: string format: uuid - in: query name: state schema: type: array items: type: string enum: - CREATING - CREATION_SCHEDULED - DELETING - DELETION_SCHEDULED - ERRED - OK - UPDATE_SCHEDULED - UPDATING explode: true style: form - in: query name: tenant schema: type: string description: Tenant URL - in: query name: tenant_uuid schema: type: string format: uuid description: Tenant UUID - in: query name: type schema: type: string - in: query name: uuid schema: type: string format: uuid tags: - openstack-networks security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/openstack-networks/{uuid}/: get: operationId: openstack_networks_retrieve parameters: - in: query name: field schema: type: array items: type: string enum: - access_url - backend_id - created - customer - customer_abbreviation - customer_name - customer_native_name - description - error_message - error_traceback - is_external - is_limit_based - is_usage_based - marketplace_category_name - marketplace_category_uuid - marketplace_offering_name - marketplace_offering_plugin_options - marketplace_offering_uuid - marketplace_plan_uuid - marketplace_resource_state - marketplace_resource_uuid - modified - mtu - name - project - project_name - project_uuid - rbac_policies - resource_type - segmentation_id - service_name - service_settings - service_settings_error_message - service_settings_state - service_settings_uuid - state - subnets - tenant - tenant_name - tenant_uuid - type - url - uuid - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-networks security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OpenStackNetwork' description: '' put: operationId: openstack_networks_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-networks requestBody: content: application/json: schema: $ref: '#/components/schemas/OpenStackNetworkRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OpenStackNetwork' description: '' patch: operationId: openstack_networks_partial_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-networks requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedOpenStackNetworkRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OpenStackNetwork' description: '' delete: operationId: openstack_networks_destroy parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-networks security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '204': description: No response body /api/openstack-networks/{uuid}/create_subnet/: post: operationId: openstack_networks_create_subnet parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-networks requestBody: content: application/json: schema: $ref: '#/components/schemas/OpenStackSubNetRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OpenStackSubNet' description: '' /api/openstack-networks/{uuid}/pull/: post: operationId: openstack_networks_pull parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-networks security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/openstack-networks/{uuid}/rbac_policy_create/: post: operationId: openstack_networks_rbac_policy_create description: Create RBAC policy for the network parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-networks requestBody: content: application/json: schema: $ref: '#/components/schemas/NetworkRBACPolicyRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/NetworkRBACPolicy' description: '' /api/openstack-networks/{uuid}/rbac_policy_delete/{rbac_policy_uuid}/: delete: operationId: openstack_networks_rbac_policy_delete_destroy description: Delete RBAC policy for the network parameters: - in: path name: rbac_policy_uuid schema: type: string format: uuid description: UUID of the RBAC policy to delete required: true - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-networks security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '204': description: No response body /api/openstack-networks/{uuid}/set_mtu/: post: operationId: openstack_networks_set_mtu parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-networks requestBody: content: application/json: schema: $ref: '#/components/schemas/SetMtuRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/SetMtu' description: '' /api/openstack-networks/{uuid}/unlink/: post: operationId: openstack_networks_unlink description: |- Delete resource from the database without scheduling operations on backend and without checking current state of the resource. It is intended to be used for removing resource stuck in transitioning state. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-networks security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/openstack-ports/: get: operationId: openstack_ports_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: admin_state_up schema: type: boolean - in: query name: backend_id schema: type: string - in: query name: device_id schema: type: string - in: query name: device_owner schema: type: string - in: query name: exclude_subnet_uuids schema: type: string description: Exclude Subnet UUIDs (comma-separated) - in: query name: field schema: type: array items: type: string enum: - access_url - admin_state_up - allowed_address_pairs - backend_id - created - customer - customer_abbreviation - customer_name - customer_native_name - description - device_id - device_owner - error_message - error_traceback - fixed_ips - floating_ips - is_limit_based - is_usage_based - mac_address - marketplace_category_name - marketplace_category_uuid - marketplace_offering_name - marketplace_offering_plugin_options - marketplace_offering_uuid - marketplace_plan_uuid - marketplace_resource_state - marketplace_resource_uuid - modified - name - network - network_name - network_uuid - port_security_enabled - project - project_name - project_uuid - resource_type - security_groups - service_name - service_settings - service_settings_error_message - service_settings_state - service_settings_uuid - state - status - tenant - tenant_name - tenant_uuid - url - uuid - in: query name: has_device_owner schema: type: boolean description: Has device owner - in: query name: mac_address schema: type: string - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - in: query name: o schema: type: array items: type: string enum: - -network_name - network_name description: |+ Ordering explode: false style: form - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: query schema: type: string description: Search by name, MAC address or backend ID - in: query name: status schema: type: string - in: query name: tenant schema: type: string - in: query name: tenant_uuid schema: type: string format: uuid tags: - openstack-ports security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/OpenStackPort' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' post: operationId: openstack_ports_create tags: - openstack-ports requestBody: content: application/json: schema: $ref: '#/components/schemas/OpenStackPortRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/OpenStackPort' description: '' head: operationId: openstack_ports_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: admin_state_up schema: type: boolean - in: query name: backend_id schema: type: string - in: query name: device_id schema: type: string - in: query name: device_owner schema: type: string - in: query name: exclude_subnet_uuids schema: type: string description: Exclude Subnet UUIDs (comma-separated) - in: query name: has_device_owner schema: type: boolean description: Has device owner - in: query name: mac_address schema: type: string - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - in: query name: o schema: type: array items: type: string enum: - -network_name - network_name description: |+ Ordering explode: false style: form - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: query schema: type: string description: Search by name, MAC address or backend ID - in: query name: status schema: type: string - in: query name: tenant schema: type: string - in: query name: tenant_uuid schema: type: string format: uuid tags: - openstack-ports security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/openstack-ports/{uuid}/: get: operationId: openstack_ports_retrieve parameters: - in: query name: field schema: type: array items: type: string enum: - access_url - admin_state_up - allowed_address_pairs - backend_id - created - customer - customer_abbreviation - customer_name - customer_native_name - description - device_id - device_owner - error_message - error_traceback - fixed_ips - floating_ips - is_limit_based - is_usage_based - mac_address - marketplace_category_name - marketplace_category_uuid - marketplace_offering_name - marketplace_offering_plugin_options - marketplace_offering_uuid - marketplace_plan_uuid - marketplace_resource_state - marketplace_resource_uuid - modified - name - network - network_name - network_uuid - port_security_enabled - project - project_name - project_uuid - resource_type - security_groups - service_name - service_settings - service_settings_error_message - service_settings_state - service_settings_uuid - state - status - tenant - tenant_name - tenant_uuid - url - uuid - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-ports security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OpenStackPort' description: '' put: operationId: openstack_ports_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-ports requestBody: content: application/json: schema: $ref: '#/components/schemas/OpenStackPortRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OpenStackPort' description: '' patch: operationId: openstack_ports_partial_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-ports requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedOpenStackPortRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OpenStackPort' description: '' delete: operationId: openstack_ports_destroy parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-ports security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '204': description: No response body /api/openstack-ports/{uuid}/disable_port/: post: operationId: openstack_ports_disable_port description: Disable port. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-ports security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/openstack-ports/{uuid}/disable_port_security/: post: operationId: openstack_ports_disable_port_security description: Disable port security for the port parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-ports security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/openstack-ports/{uuid}/enable_port/: post: operationId: openstack_ports_enable_port description: Enable port. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-ports security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/openstack-ports/{uuid}/enable_port_security/: post: operationId: openstack_ports_enable_port_security description: Enable port security for the port parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-ports security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/openstack-ports/{uuid}/pull/: post: operationId: openstack_ports_pull parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-ports security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/openstack-ports/{uuid}/unlink/: post: operationId: openstack_ports_unlink description: |- Delete resource from the database without scheduling operations on backend and without checking current state of the resource. It is intended to be used for removing resource stuck in transitioning state. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-ports security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/openstack-ports/{uuid}/update_port_ip/: post: operationId: openstack_ports_update_port_ip description: Update port IP address. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-ports requestBody: content: application/json: schema: $ref: '#/components/schemas/OpenStackPortIPUpdateRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/openstack-ports/{uuid}/update_security_groups/: post: operationId: openstack_ports_update_security_groups description: Update security groups of the port parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-ports requestBody: content: application/json: schema: $ref: '#/components/schemas/OpenStackInstanceSecurityGroupsUpdateRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/openstack-routers/: get: operationId: openstack_routers_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: field schema: type: array items: type: string enum: - access_url - backend_id - created - customer - customer_abbreviation - customer_name - customer_native_name - description - error_message - error_traceback - fixed_ips - is_limit_based - is_usage_based - marketplace_category_name - marketplace_category_uuid - marketplace_offering_name - marketplace_offering_plugin_options - marketplace_offering_uuid - marketplace_plan_uuid - marketplace_resource_state - marketplace_resource_uuid - modified - name - offering_external_ips - ports - project - project_name - project_uuid - resource_type - routes - service_name - service_settings - service_settings_error_message - service_settings_state - service_settings_uuid - state - tenant - tenant_name - tenant_uuid - url - uuid - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: tenant schema: type: string - in: query name: tenant_uuid schema: type: string format: uuid tags: - openstack-routers security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/OpenStackRouter' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' post: operationId: openstack_routers_create tags: - openstack-routers requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateRouterRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/CreateRouter' description: '' head: operationId: openstack_routers_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: tenant schema: type: string - in: query name: tenant_uuid schema: type: string format: uuid tags: - openstack-routers security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/openstack-routers/{uuid}/: get: operationId: openstack_routers_retrieve parameters: - in: query name: field schema: type: array items: type: string enum: - access_url - backend_id - created - customer - customer_abbreviation - customer_name - customer_native_name - description - error_message - error_traceback - fixed_ips - is_limit_based - is_usage_based - marketplace_category_name - marketplace_category_uuid - marketplace_offering_name - marketplace_offering_plugin_options - marketplace_offering_uuid - marketplace_plan_uuid - marketplace_resource_state - marketplace_resource_uuid - modified - name - offering_external_ips - ports - project - project_name - project_uuid - resource_type - routes - service_name - service_settings - service_settings_error_message - service_settings_state - service_settings_uuid - state - tenant - tenant_name - tenant_uuid - url - uuid - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-routers security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OpenStackRouter' description: '' delete: operationId: openstack_routers_destroy parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-routers security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '204': description: No response body /api/openstack-routers/{uuid}/add_router_interface/: post: operationId: openstack_routers_add_router_interface description: Add interface to router. Either subnet or port must be provided. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-routers requestBody: content: application/json: schema: $ref: '#/components/schemas/OpenStackRouterInterfaceRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/openstack-routers/{uuid}/remove_router_interface/: post: operationId: openstack_routers_remove_router_interface description: Remove interface from router. Either subnet or port must be provided. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-routers requestBody: content: application/json: schema: $ref: '#/components/schemas/OpenStackRouterInterfaceRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/openstack-routers/{uuid}/set_routes/: post: operationId: openstack_routers_set_routes parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-routers requestBody: content: application/json: schema: $ref: '#/components/schemas/OpenStackRouterSetRoutesRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OpenStackRouterSetRoutes' description: '' /api/openstack-security-groups/: get: operationId: openstack_security_groups_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: backend_id schema: type: string - in: query name: can_manage schema: type: boolean description: Can manage - in: query name: customer schema: type: string format: uuid - in: query name: customer_abbreviation schema: type: string - in: query name: customer_name schema: type: string - in: query name: customer_native_name schema: type: string - in: query name: customer_uuid schema: type: string format: uuid - in: query name: description schema: type: string - in: query name: external_ip schema: type: string - in: query name: field schema: type: array items: type: string enum: - access_url - backend_id - created - customer - customer_abbreviation - customer_name - customer_native_name - description - error_message - error_traceback - is_limit_based - is_usage_based - marketplace_category_name - marketplace_category_uuid - marketplace_offering_name - marketplace_offering_plugin_options - marketplace_offering_uuid - marketplace_plan_uuid - marketplace_resource_state - marketplace_resource_uuid - modified - name - project - project_name - project_uuid - resource_type - rules - service_name - service_settings - service_settings_error_message - service_settings_state - service_settings_uuid - state - tenant - tenant_name - tenant_uuid - url - uuid - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: project schema: type: string format: uuid - in: query name: project_name schema: type: string - in: query name: project_uuid schema: type: string format: uuid - in: query name: query schema: type: string description: Search by name or description - in: query name: service_settings_name schema: type: string - in: query name: service_settings_uuid schema: type: string format: uuid - in: query name: state schema: type: array items: type: string enum: - CREATING - CREATION_SCHEDULED - DELETING - DELETION_SCHEDULED - ERRED - OK - UPDATE_SCHEDULED - UPDATING explode: true style: form - in: query name: tenant schema: type: string - in: query name: tenant_uuid schema: type: string format: uuid - in: query name: uuid schema: type: string format: uuid tags: - openstack-security-groups security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/OpenStackSecurityGroup' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' head: operationId: openstack_security_groups_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: backend_id schema: type: string - in: query name: can_manage schema: type: boolean description: Can manage - in: query name: customer schema: type: string format: uuid - in: query name: customer_abbreviation schema: type: string - in: query name: customer_name schema: type: string - in: query name: customer_native_name schema: type: string - in: query name: customer_uuid schema: type: string format: uuid - in: query name: description schema: type: string - in: query name: external_ip schema: type: string - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: project schema: type: string format: uuid - in: query name: project_name schema: type: string - in: query name: project_uuid schema: type: string format: uuid - in: query name: query schema: type: string description: Search by name or description - in: query name: service_settings_name schema: type: string - in: query name: service_settings_uuid schema: type: string format: uuid - in: query name: state schema: type: array items: type: string enum: - CREATING - CREATION_SCHEDULED - DELETING - DELETION_SCHEDULED - ERRED - OK - UPDATE_SCHEDULED - UPDATING explode: true style: form - in: query name: tenant schema: type: string - in: query name: tenant_uuid schema: type: string format: uuid - in: query name: uuid schema: type: string format: uuid tags: - openstack-security-groups security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/openstack-security-groups/{uuid}/: get: operationId: openstack_security_groups_retrieve parameters: - in: query name: field schema: type: array items: type: string enum: - access_url - backend_id - created - customer - customer_abbreviation - customer_name - customer_native_name - description - error_message - error_traceback - is_limit_based - is_usage_based - marketplace_category_name - marketplace_category_uuid - marketplace_offering_name - marketplace_offering_plugin_options - marketplace_offering_uuid - marketplace_plan_uuid - marketplace_resource_state - marketplace_resource_uuid - modified - name - project - project_name - project_uuid - resource_type - rules - service_name - service_settings - service_settings_error_message - service_settings_state - service_settings_uuid - state - tenant - tenant_name - tenant_uuid - url - uuid - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-security-groups security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OpenStackSecurityGroup' description: '' put: operationId: openstack_security_groups_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-security-groups requestBody: content: application/json: schema: $ref: '#/components/schemas/OpenStackSecurityGroupUpdateRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OpenStackSecurityGroupUpdate' description: '' patch: operationId: openstack_security_groups_partial_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-security-groups requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedOpenStackSecurityGroupUpdateRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OpenStackSecurityGroupUpdate' description: '' delete: operationId: openstack_security_groups_destroy parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-security-groups security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '204': description: No response body /api/openstack-security-groups/{uuid}/pull/: post: operationId: openstack_security_groups_pull parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-security-groups security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/openstack-security-groups/{uuid}/set_rules/: post: operationId: openstack_security_groups_set_rules description: Update security group rules parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-security-groups requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/OpenStackSecurityGroupRuleUpdateRequest' examples: Openstack-security-group-set-rules: value: - - protocol: tcp from_port: 1 to_port: 10 cidr: 10.1.1.0/24 summary: openstack-security-group-set-rules required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/openstack-security-groups/{uuid}/unlink/: post: operationId: openstack_security_groups_unlink description: |- Delete resource from the database without scheduling operations on backend and without checking current state of the resource. It is intended to be used for removing resource stuck in transitioning state. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-security-groups security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/openstack-server-groups/: get: operationId: openstack_server_groups_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: backend_id schema: type: string - in: query name: can_manage schema: type: boolean description: Can manage - in: query name: customer schema: type: string format: uuid - in: query name: customer_abbreviation schema: type: string - in: query name: customer_name schema: type: string - in: query name: customer_native_name schema: type: string - in: query name: customer_uuid schema: type: string format: uuid - in: query name: description schema: type: string - in: query name: external_ip schema: type: string - in: query name: field schema: type: array items: type: string enum: - access_url - backend_id - created - customer - customer_abbreviation - customer_name - customer_native_name - description - display_name - error_message - error_traceback - instances - is_limit_based - is_usage_based - marketplace_category_name - marketplace_category_uuid - marketplace_offering_name - marketplace_offering_plugin_options - marketplace_offering_uuid - marketplace_plan_uuid - marketplace_resource_state - marketplace_resource_uuid - modified - name - policy - project - project_name - project_uuid - resource_type - service_name - service_settings - service_settings_error_message - service_settings_state - service_settings_uuid - state - tenant - tenant_name - tenant_uuid - url - uuid - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: project schema: type: string format: uuid - in: query name: project_name schema: type: string - in: query name: project_uuid schema: type: string format: uuid - in: query name: service_settings_name schema: type: string - in: query name: service_settings_uuid schema: type: string format: uuid - in: query name: state schema: type: array items: type: string enum: - CREATING - CREATION_SCHEDULED - DELETING - DELETION_SCHEDULED - ERRED - OK - UPDATE_SCHEDULED - UPDATING explode: true style: form - in: query name: tenant schema: type: string - in: query name: tenant_uuid schema: type: string format: uuid - in: query name: uuid schema: type: string format: uuid tags: - openstack-server-groups security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/OpenStackServerGroup' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' post: operationId: openstack_server_groups_create tags: - openstack-server-groups requestBody: content: application/json: schema: $ref: '#/components/schemas/OpenStackServerGroupRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/OpenStackServerGroup' description: '' head: operationId: openstack_server_groups_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: backend_id schema: type: string - in: query name: can_manage schema: type: boolean description: Can manage - in: query name: customer schema: type: string format: uuid - in: query name: customer_abbreviation schema: type: string - in: query name: customer_name schema: type: string - in: query name: customer_native_name schema: type: string - in: query name: customer_uuid schema: type: string format: uuid - in: query name: description schema: type: string - in: query name: external_ip schema: type: string - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: project schema: type: string format: uuid - in: query name: project_name schema: type: string - in: query name: project_uuid schema: type: string format: uuid - in: query name: service_settings_name schema: type: string - in: query name: service_settings_uuid schema: type: string format: uuid - in: query name: state schema: type: array items: type: string enum: - CREATING - CREATION_SCHEDULED - DELETING - DELETION_SCHEDULED - ERRED - OK - UPDATE_SCHEDULED - UPDATING explode: true style: form - in: query name: tenant schema: type: string - in: query name: tenant_uuid schema: type: string format: uuid - in: query name: uuid schema: type: string format: uuid tags: - openstack-server-groups security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/openstack-server-groups/{uuid}/: get: operationId: openstack_server_groups_retrieve parameters: - in: query name: field schema: type: array items: type: string enum: - access_url - backend_id - created - customer - customer_abbreviation - customer_name - customer_native_name - description - display_name - error_message - error_traceback - instances - is_limit_based - is_usage_based - marketplace_category_name - marketplace_category_uuid - marketplace_offering_name - marketplace_offering_plugin_options - marketplace_offering_uuid - marketplace_plan_uuid - marketplace_resource_state - marketplace_resource_uuid - modified - name - policy - project - project_name - project_uuid - resource_type - service_name - service_settings - service_settings_error_message - service_settings_state - service_settings_uuid - state - tenant - tenant_name - tenant_uuid - url - uuid - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-server-groups security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OpenStackServerGroup' description: '' put: operationId: openstack_server_groups_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-server-groups requestBody: content: application/json: schema: $ref: '#/components/schemas/OpenStackServerGroupRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OpenStackServerGroup' description: '' patch: operationId: openstack_server_groups_partial_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-server-groups requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedOpenStackServerGroupRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OpenStackServerGroup' description: '' delete: operationId: openstack_server_groups_destroy parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-server-groups security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '204': description: No response body /api/openstack-server-groups/{uuid}/pull/: post: operationId: openstack_server_groups_pull parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-server-groups security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/openstack-server-groups/{uuid}/unlink/: post: operationId: openstack_server_groups_unlink description: |- Delete resource from the database without scheduling operations on backend and without checking current state of the resource. It is intended to be used for removing resource stuck in transitioning state. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-server-groups security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/openstack-snapshots/: get: operationId: openstack_snapshots_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: backend_id schema: type: string - in: query name: backup schema: type: string - in: query name: backup_uuid schema: type: string format: uuid - in: query name: can_manage schema: type: boolean description: Can manage - in: query name: customer schema: type: string format: uuid - in: query name: customer_abbreviation schema: type: string - in: query name: customer_name schema: type: string - in: query name: customer_native_name schema: type: string - in: query name: customer_uuid schema: type: string format: uuid - in: query name: description schema: type: string - in: query name: external_ip schema: type: string - in: query name: field schema: type: array items: type: string enum: - access_url - action - action_details - backend_id - created - customer - customer_abbreviation - customer_name - customer_native_name - description - error_message - error_traceback - is_limit_based - is_usage_based - kept_until - marketplace_category_name - marketplace_category_uuid - marketplace_offering_name - marketplace_offering_plugin_options - marketplace_offering_uuid - marketplace_plan_uuid - marketplace_resource_state - marketplace_resource_uuid - metadata - modified - name - project - project_name - project_uuid - resource_type - restorations - runtime_state - service_name - service_settings - service_settings_error_message - service_settings_state - service_settings_uuid - size - source_volume - source_volume_marketplace_uuid - source_volume_name - state - url - uuid - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: project schema: type: string format: uuid - in: query name: project_name schema: type: string - in: query name: project_uuid schema: type: string format: uuid - in: query name: runtime_state schema: type: string - in: query name: service_settings_name schema: type: string - in: query name: service_settings_uuid schema: type: string format: uuid - in: query name: source_volume schema: type: string - in: query name: source_volume_uuid schema: type: string format: uuid - in: query name: state schema: type: array items: type: string enum: - CREATING - CREATION_SCHEDULED - DELETING - DELETION_SCHEDULED - ERRED - OK - UPDATE_SCHEDULED - UPDATING explode: true style: form - in: query name: tenant schema: type: string - in: query name: tenant_uuid schema: type: string format: uuid - in: query name: uuid schema: type: string format: uuid tags: - openstack-snapshots security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/OpenStackSnapshot' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' head: operationId: openstack_snapshots_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: backend_id schema: type: string - in: query name: backup schema: type: string - in: query name: backup_uuid schema: type: string format: uuid - in: query name: can_manage schema: type: boolean description: Can manage - in: query name: customer schema: type: string format: uuid - in: query name: customer_abbreviation schema: type: string - in: query name: customer_name schema: type: string - in: query name: customer_native_name schema: type: string - in: query name: customer_uuid schema: type: string format: uuid - in: query name: description schema: type: string - in: query name: external_ip schema: type: string - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: project schema: type: string format: uuid - in: query name: project_name schema: type: string - in: query name: project_uuid schema: type: string format: uuid - in: query name: runtime_state schema: type: string - in: query name: service_settings_name schema: type: string - in: query name: service_settings_uuid schema: type: string format: uuid - in: query name: source_volume schema: type: string - in: query name: source_volume_uuid schema: type: string format: uuid - in: query name: state schema: type: array items: type: string enum: - CREATING - CREATION_SCHEDULED - DELETING - DELETION_SCHEDULED - ERRED - OK - UPDATE_SCHEDULED - UPDATING explode: true style: form - in: query name: tenant schema: type: string - in: query name: tenant_uuid schema: type: string format: uuid - in: query name: uuid schema: type: string format: uuid tags: - openstack-snapshots security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/openstack-snapshots/{uuid}/: get: operationId: openstack_snapshots_retrieve parameters: - in: query name: field schema: type: array items: type: string enum: - access_url - action - action_details - backend_id - created - customer - customer_abbreviation - customer_name - customer_native_name - description - error_message - error_traceback - is_limit_based - is_usage_based - kept_until - marketplace_category_name - marketplace_category_uuid - marketplace_offering_name - marketplace_offering_plugin_options - marketplace_offering_uuid - marketplace_plan_uuid - marketplace_resource_state - marketplace_resource_uuid - metadata - modified - name - project - project_name - project_uuid - resource_type - restorations - runtime_state - service_name - service_settings - service_settings_error_message - service_settings_state - service_settings_uuid - size - source_volume - source_volume_marketplace_uuid - source_volume_name - state - url - uuid - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-snapshots security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OpenStackSnapshot' description: '' put: operationId: openstack_snapshots_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-snapshots requestBody: content: application/json: schema: $ref: '#/components/schemas/OpenStackSnapshotRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OpenStackSnapshot' description: '' patch: operationId: openstack_snapshots_partial_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-snapshots requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedOpenStackSnapshotRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OpenStackSnapshot' description: '' delete: operationId: openstack_snapshots_destroy parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-snapshots security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '204': description: No response body /api/openstack-snapshots/{uuid}/pull/: post: operationId: openstack_snapshots_pull parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-snapshots security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/openstack-snapshots/{uuid}/restorations/: get: operationId: openstack_snapshots_restorations_list description: Get a list of snapshot restorations parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-snapshots security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/OpenStackSnapshotRestoration' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' /api/openstack-snapshots/{uuid}/restore/: post: operationId: openstack_snapshots_restore description: Restore volume from snapshot parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-snapshots requestBody: content: application/json: schema: $ref: '#/components/schemas/OpenStackSnapshotRestorationRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OpenStackVolume' description: '' /api/openstack-snapshots/{uuid}/unlink/: post: operationId: openstack_snapshots_unlink description: |- Delete resource from the database without scheduling operations on backend and without checking current state of the resource. It is intended to be used for removing resource stuck in transitioning state. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-snapshots security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/openstack-subnets/: get: operationId: openstack_subnets_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: backend_id schema: type: string - in: query name: can_manage schema: type: boolean description: Can manage - in: query name: customer schema: type: string format: uuid - in: query name: customer_abbreviation schema: type: string - in: query name: customer_name schema: type: string - in: query name: customer_native_name schema: type: string - in: query name: customer_uuid schema: type: string format: uuid - in: query name: description schema: type: string - in: query name: direct_only schema: type: boolean description: Direct only - in: query name: enable_dhcp schema: type: boolean - in: query name: external_ip schema: type: string - in: query name: field schema: type: array items: type: string enum: - access_url - allocation_pools - backend_id - cidr - created - customer - customer_abbreviation - customer_name - customer_native_name - description - disable_gateway - dns_nameservers - enable_dhcp - error_message - error_traceback - gateway_ip - host_routes - ip_version - is_connected - is_limit_based - is_usage_based - marketplace_category_name - marketplace_category_uuid - marketplace_offering_name - marketplace_offering_plugin_options - marketplace_offering_uuid - marketplace_plan_uuid - marketplace_resource_state - marketplace_resource_uuid - modified - name - network - network_name - project - project_name - project_uuid - resource_type - service_name - service_settings - service_settings_error_message - service_settings_state - service_settings_uuid - state - tenant - tenant_name - url - uuid - in: query name: ip_version schema: type: integer - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - in: query name: network schema: type: string - in: query name: network_uuid schema: type: string format: uuid - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: project schema: type: string format: uuid - in: query name: project_name schema: type: string - in: query name: project_uuid schema: type: string format: uuid - in: query name: rbac_only schema: type: boolean description: RBAC only - in: query name: service_settings_name schema: type: string - in: query name: service_settings_uuid schema: type: string format: uuid - in: query name: state schema: type: array items: type: string enum: - CREATING - CREATION_SCHEDULED - DELETING - DELETION_SCHEDULED - ERRED - OK - UPDATE_SCHEDULED - UPDATING explode: true style: form - in: query name: tenant schema: type: string description: Tenant URL - in: query name: tenant_uuid schema: type: string format: uuid description: Tenant UUID - in: query name: uuid schema: type: string format: uuid tags: - openstack-subnets security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/OpenStackSubNet' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' head: operationId: openstack_subnets_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: backend_id schema: type: string - in: query name: can_manage schema: type: boolean description: Can manage - in: query name: customer schema: type: string format: uuid - in: query name: customer_abbreviation schema: type: string - in: query name: customer_name schema: type: string - in: query name: customer_native_name schema: type: string - in: query name: customer_uuid schema: type: string format: uuid - in: query name: description schema: type: string - in: query name: direct_only schema: type: boolean description: Direct only - in: query name: enable_dhcp schema: type: boolean - in: query name: external_ip schema: type: string - in: query name: ip_version schema: type: integer - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - in: query name: network schema: type: string - in: query name: network_uuid schema: type: string format: uuid - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: project schema: type: string format: uuid - in: query name: project_name schema: type: string - in: query name: project_uuid schema: type: string format: uuid - in: query name: rbac_only schema: type: boolean description: RBAC only - in: query name: service_settings_name schema: type: string - in: query name: service_settings_uuid schema: type: string format: uuid - in: query name: state schema: type: array items: type: string enum: - CREATING - CREATION_SCHEDULED - DELETING - DELETION_SCHEDULED - ERRED - OK - UPDATE_SCHEDULED - UPDATING explode: true style: form - in: query name: tenant schema: type: string description: Tenant URL - in: query name: tenant_uuid schema: type: string format: uuid description: Tenant UUID - in: query name: uuid schema: type: string format: uuid tags: - openstack-subnets security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/openstack-subnets/{uuid}/: get: operationId: openstack_subnets_retrieve parameters: - in: query name: field schema: type: array items: type: string enum: - access_url - allocation_pools - backend_id - cidr - created - customer - customer_abbreviation - customer_name - customer_native_name - description - disable_gateway - dns_nameservers - enable_dhcp - error_message - error_traceback - gateway_ip - host_routes - ip_version - is_connected - is_limit_based - is_usage_based - marketplace_category_name - marketplace_category_uuid - marketplace_offering_name - marketplace_offering_plugin_options - marketplace_offering_uuid - marketplace_plan_uuid - marketplace_resource_state - marketplace_resource_uuid - modified - name - network - network_name - project - project_name - project_uuid - resource_type - service_name - service_settings - service_settings_error_message - service_settings_state - service_settings_uuid - state - tenant - tenant_name - url - uuid - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-subnets security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OpenStackSubNet' description: '' put: operationId: openstack_subnets_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-subnets requestBody: content: application/json: schema: $ref: '#/components/schemas/OpenStackSubNetRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OpenStackSubNet' description: '' patch: operationId: openstack_subnets_partial_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-subnets requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedOpenStackSubNetRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OpenStackSubNet' description: '' delete: operationId: openstack_subnets_destroy parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-subnets security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '204': description: No response body /api/openstack-subnets/{uuid}/connect/: post: operationId: openstack_subnets_connect parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-subnets security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/openstack-subnets/{uuid}/disconnect/: post: operationId: openstack_subnets_disconnect parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-subnets security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/openstack-subnets/{uuid}/pull/: post: operationId: openstack_subnets_pull parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-subnets security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/openstack-subnets/{uuid}/unlink/: post: operationId: openstack_subnets_unlink description: |- Delete resource from the database without scheduling operations on backend and without checking current state of the resource. It is intended to be used for removing resource stuck in transitioning state. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-subnets security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/openstack-tenants/: get: operationId: openstack_tenants_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: backend_id schema: type: string - in: query name: can_manage schema: type: boolean description: Can manage - in: query name: customer schema: type: string format: uuid - in: query name: customer_abbreviation schema: type: string - in: query name: customer_name schema: type: string - in: query name: customer_native_name schema: type: string - in: query name: customer_uuid schema: type: string format: uuid - in: query name: description schema: type: string - in: query name: external_ip schema: type: string - in: query name: field schema: type: array items: type: string enum: - access_url - availability_zone - backend_id - created - customer - customer_abbreviation - customer_name - customer_native_name - default_volume_type_name - description - error_message - error_traceback - external_network_id - internal_network_id - is_limit_based - is_usage_based - marketplace_category_name - marketplace_category_uuid - marketplace_offering_name - marketplace_offering_plugin_options - marketplace_offering_uuid - marketplace_plan_uuid - marketplace_resource_state - marketplace_resource_uuid - modified - name - project - project_name - project_uuid - quotas - resource_type - service_name - service_settings - service_settings_error_message - service_settings_state - service_settings_uuid - state - subnet_cidr - url - user_password - user_username - uuid - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: project schema: type: string format: uuid - in: query name: project_name schema: type: string - in: query name: project_uuid schema: type: string format: uuid - in: query name: service_settings_name schema: type: string - in: query name: service_settings_uuid schema: type: string format: uuid - in: query name: state schema: type: array items: type: string enum: - CREATING - CREATION_SCHEDULED - DELETING - DELETION_SCHEDULED - ERRED - OK - UPDATE_SCHEDULED - UPDATING explode: true style: form - in: query name: uuid schema: type: string format: uuid tags: - openstack-tenants security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/OpenStackTenant' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' post: operationId: openstack_tenants_create tags: - openstack-tenants requestBody: content: application/json: schema: $ref: '#/components/schemas/OpenStackTenantRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/OpenStackTenant' description: '' head: operationId: openstack_tenants_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: backend_id schema: type: string - in: query name: can_manage schema: type: boolean description: Can manage - in: query name: customer schema: type: string format: uuid - in: query name: customer_abbreviation schema: type: string - in: query name: customer_name schema: type: string - in: query name: customer_native_name schema: type: string - in: query name: customer_uuid schema: type: string format: uuid - in: query name: description schema: type: string - in: query name: external_ip schema: type: string - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: project schema: type: string format: uuid - in: query name: project_name schema: type: string - in: query name: project_uuid schema: type: string format: uuid - in: query name: service_settings_name schema: type: string - in: query name: service_settings_uuid schema: type: string format: uuid - in: query name: state schema: type: array items: type: string enum: - CREATING - CREATION_SCHEDULED - DELETING - DELETION_SCHEDULED - ERRED - OK - UPDATE_SCHEDULED - UPDATING explode: true style: form - in: query name: uuid schema: type: string format: uuid tags: - openstack-tenants security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/openstack-tenants/{uuid}/: get: operationId: openstack_tenants_retrieve parameters: - in: query name: field schema: type: array items: type: string enum: - access_url - availability_zone - backend_id - created - customer - customer_abbreviation - customer_name - customer_native_name - default_volume_type_name - description - error_message - error_traceback - external_network_id - internal_network_id - is_limit_based - is_usage_based - marketplace_category_name - marketplace_category_uuid - marketplace_offering_name - marketplace_offering_plugin_options - marketplace_offering_uuid - marketplace_plan_uuid - marketplace_resource_state - marketplace_resource_uuid - modified - name - project - project_name - project_uuid - quotas - resource_type - service_name - service_settings - service_settings_error_message - service_settings_state - service_settings_uuid - state - subnet_cidr - url - user_password - user_username - uuid - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-tenants security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OpenStackTenant' description: '' put: operationId: openstack_tenants_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-tenants requestBody: content: application/json: schema: $ref: '#/components/schemas/OpenStackTenantRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OpenStackTenant' description: '' patch: operationId: openstack_tenants_partial_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-tenants requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedOpenStackTenantRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OpenStackTenant' description: '' delete: operationId: openstack_tenants_destroy parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-tenants security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '204': description: No response body /api/openstack-tenants/{uuid}/backend_instances/: get: operationId: openstack_tenants_backend_instances_list description: Return a list of volumes from backend parameters: - in: query name: backend_id schema: type: string - in: query name: can_manage schema: type: boolean description: Can manage - in: query name: customer schema: type: string format: uuid - in: query name: customer_abbreviation schema: type: string - in: query name: customer_name schema: type: string - in: query name: customer_native_name schema: type: string - in: query name: customer_uuid schema: type: string format: uuid - in: query name: description schema: type: string - in: query name: external_ip schema: type: string - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: project schema: type: string format: uuid - in: query name: project_name schema: type: string - in: query name: project_uuid schema: type: string format: uuid - in: query name: service_settings_name schema: type: string - in: query name: service_settings_uuid schema: type: string format: uuid - in: query name: state schema: type: array items: type: string enum: - CREATING - CREATION_SCHEDULED - DELETING - DELETION_SCHEDULED - ERRED - OK - UPDATE_SCHEDULED - UPDATING explode: true style: form - in: path name: uuid schema: type: string format: uuid required: true - in: query name: uuid schema: type: string format: uuid tags: - openstack-tenants security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/OpenStackBackendInstance' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' /api/openstack-tenants/{uuid}/backend_volumes/: get: operationId: openstack_tenants_backend_volumes_list description: Return a list of volumes from backend parameters: - in: query name: backend_id schema: type: string - in: query name: can_manage schema: type: boolean description: Can manage - in: query name: customer schema: type: string format: uuid - in: query name: customer_abbreviation schema: type: string - in: query name: customer_name schema: type: string - in: query name: customer_native_name schema: type: string - in: query name: customer_uuid schema: type: string format: uuid - in: query name: description schema: type: string - in: query name: external_ip schema: type: string - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: project schema: type: string format: uuid - in: query name: project_name schema: type: string - in: query name: project_uuid schema: type: string format: uuid - in: query name: service_settings_name schema: type: string - in: query name: service_settings_uuid schema: type: string format: uuid - in: query name: state schema: type: array items: type: string enum: - CREATING - CREATION_SCHEDULED - DELETING - DELETION_SCHEDULED - ERRED - OK - UPDATE_SCHEDULED - UPDATING explode: true style: form - in: path name: uuid schema: type: string format: uuid required: true - in: query name: uuid schema: type: string format: uuid tags: - openstack-tenants security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/OpenStackBackendVolumes' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' /api/openstack-tenants/{uuid}/change_password/: post: operationId: openstack_tenants_change_password description: Change password for tenant user parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-tenants requestBody: content: application/json: schema: $ref: '#/components/schemas/OpenStackTenantChangePasswordRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/openstack-tenants/{uuid}/create_floating_ip/: post: operationId: openstack_tenants_create_floating_ip description: Create floating IP for tenant parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-tenants security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OpenStackFloatingIP' description: '' /api/openstack-tenants/{uuid}/create_network/: post: operationId: openstack_tenants_create_network description: Create network for tenant parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-tenants requestBody: content: application/json: schema: $ref: '#/components/schemas/OpenStackNetworkRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OpenStackNetwork' description: '' /api/openstack-tenants/{uuid}/create_security_group/: post: operationId: openstack_tenants_create_security_group parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-tenants requestBody: content: application/json: schema: $ref: '#/components/schemas/OpenStackSecurityGroupRequest' examples: Openstack-tenant-create-security-group: value: name: Security group name description: description rules: - protocol: tcp from_port: 1 to_port: 10 cidr: 10.1.1.0/24 - protocol: udp from_port: 10 to_port: 8000 cidr: 10.1.1.0/24 summary: openstack-tenant-create-security-group description: Example of creating a security group with rules required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/OpenStackSecurityGroup' description: '' /api/openstack-tenants/{uuid}/create_server_group/: post: operationId: openstack_tenants_create_server_group parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-tenants requestBody: content: application/json: schema: $ref: '#/components/schemas/OpenStackServerGroupRequest' examples: Openstack-tenant-create-server-group: value: name: Server group name policy: affinity summary: openstack-tenant-create-server-group required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OpenStackServerGroup' description: '' /api/openstack-tenants/{uuid}/pull/: post: operationId: openstack_tenants_pull parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-tenants security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/openstack-tenants/{uuid}/pull_floating_ips/: post: operationId: openstack_tenants_pull_floating_ips description: Trigger job to pull floating IPs from remote VPC parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-tenants security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '202': description: No response body /api/openstack-tenants/{uuid}/pull_quotas/: post: operationId: openstack_tenants_pull_quotas description: It triggers celery job to pull quotas from remote VPC parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-tenants security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/openstack-tenants/{uuid}/pull_security_groups/: post: operationId: openstack_tenants_pull_security_groups description: Trigger job to pull security groups from remote VPC parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-tenants security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OpenStackTenant' description: '' /api/openstack-tenants/{uuid}/pull_server_groups/: post: operationId: openstack_tenants_pull_server_groups description: Trigger job to pull server groups from remote VPC parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-tenants security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OpenStackTenant' description: '' /api/openstack-tenants/{uuid}/set_quotas/: post: operationId: openstack_tenants_set_quotas description: |- A quota can be set for a particular tenant. Only staff users can do that. In order to set quota submit POST request to /api/openstack-tenants//set_quotas/. The quota values are propagated to the backend. The following quotas are supported. All values are expected to be integers: - instances - maximal number of created instances. - ram - maximal size of ram for allocation. In MiB_. - storage - maximal size of storage for allocation. In MiB_. - vcpu - maximal number of virtual cores for allocation. - security_group_count - maximal number of created security groups. - security_group_rule_count - maximal number of created security groups rules. - volumes - maximal number of created volumes. - snapshots - maximal number of created snapshots. It is possible to update quotas by one or by submitting all the fields in one request. Waldur will attempt to update the provided quotas. Please note, that if provided quotas are conflicting with the backend (e.g. requested number of instances is below of the already existing ones), some quotas might not be applied. .. _MiB: http://en.wikipedia.org/wiki/Mebibyte Response code of a successful request is **202 ACCEPTED**. In case tenant is in a non-stable status, the response would be **409 CONFLICT**. In this case REST client is advised to repeat the request after some time. On successful completion the task will synchronize quotas with the backend. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-tenants requestBody: content: application/json: schema: $ref: '#/components/schemas/OpenStackTenantQuotaRequest' examples: Openstack-tenant-set-quotas: value: instances: 30 ram: 100000 storage: 1000000 vcpu: 30 security_group_count: 100 security_group_rule_count: 100 volumes: 10 snapshots: 20 summary: openstack-tenant-set-quotas security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OpenStackTenantQuota' description: '' /api/openstack-tenants/{uuid}/unlink/: post: operationId: openstack_tenants_unlink description: |- Delete resource from the database without scheduling operations on backend and without checking current state of the resource. It is intended to be used for removing resource stuck in transitioning state. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-tenants security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/openstack-volume-availability-zones/: get: operationId: openstack_volume_availability_zones_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: settings schema: type: string - in: query name: settings_uuid schema: type: string format: uuid - in: query name: tenant schema: type: string - in: query name: tenant_uuid schema: type: string format: uuid tags: - openstack-volume-availability-zones security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/OpenStackVolumeAvailabilityZone' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' head: operationId: openstack_volume_availability_zones_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: settings schema: type: string - in: query name: settings_uuid schema: type: string format: uuid - in: query name: tenant schema: type: string - in: query name: tenant_uuid schema: type: string format: uuid tags: - openstack-volume-availability-zones security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/openstack-volume-availability-zones/{uuid}/: get: operationId: openstack_volume_availability_zones_retrieve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-volume-availability-zones security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OpenStackVolumeAvailabilityZone' description: '' /api/openstack-volume-types/: get: operationId: openstack_volume_types_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - in: query name: offering_uuid schema: type: string format: uuid - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: settings schema: type: string - in: query name: settings_uuid schema: type: string format: uuid - in: query name: tenant schema: type: string - in: query name: tenant_uuid schema: type: string format: uuid tags: - openstack-volume-types security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/OpenStackVolumeType' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' head: operationId: openstack_volume_types_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - in: query name: offering_uuid schema: type: string format: uuid - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: settings schema: type: string - in: query name: settings_uuid schema: type: string format: uuid - in: query name: tenant schema: type: string - in: query name: tenant_uuid schema: type: string format: uuid tags: - openstack-volume-types security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/openstack-volume-types/{uuid}/: get: operationId: openstack_volume_types_retrieve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-volume-types security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OpenStackVolumeType' description: '' /api/openstack-volume-types/names/: get: operationId: openstack_volume_types_names_retrieve description: Return a list of unique volume type names. tags: - openstack-volume-types security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: type: string description: '' head: operationId: openstack_volume_types_names_count description: Get number of items in the collection matching the request parameters. tags: - openstack-volume-types security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/openstack-volumes/: get: operationId: openstack_volumes_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: attach_instance_uuid schema: type: string format: uuid - in: query name: availability_zone_name schema: type: string - in: query name: backend_id schema: type: string - in: query name: can_manage schema: type: boolean description: Can manage - in: query name: customer schema: type: string format: uuid - in: query name: customer_abbreviation schema: type: string - in: query name: customer_name schema: type: string - in: query name: customer_native_name schema: type: string - in: query name: customer_uuid schema: type: string format: uuid - in: query name: description schema: type: string - in: query name: external_ip schema: type: string - in: query name: field schema: type: array items: type: string enum: - access_url - action - action_details - availability_zone - availability_zone_name - backend_id - bootable - created - customer - customer_abbreviation - customer_name - customer_native_name - description - device - error_message - error_traceback - extend_enabled - image - image_metadata - image_name - instance - instance_marketplace_uuid - instance_name - is_limit_based - is_usage_based - marketplace_category_name - marketplace_category_uuid - marketplace_offering_name - marketplace_offering_plugin_options - marketplace_offering_uuid - marketplace_plan_uuid - marketplace_resource_state - marketplace_resource_uuid - metadata - modified - name - project - project_name - project_uuid - resource_type - runtime_state - service_name - service_settings - service_settings_error_message - service_settings_state - service_settings_uuid - size - source_snapshot - state - tenant - tenant_uuid - type - type_name - url - uuid - in: query name: instance schema: type: string - in: query name: instance_uuid schema: type: string format: uuid - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: project schema: type: string format: uuid - in: query name: project_name schema: type: string - in: query name: project_uuid schema: type: string format: uuid - in: query name: runtime_state schema: type: string - in: query name: service_settings_name schema: type: string - in: query name: service_settings_uuid schema: type: string format: uuid - in: query name: snapshot schema: type: string - in: query name: snapshot_uuid schema: type: string format: uuid - in: query name: state schema: type: array items: type: string enum: - CREATING - CREATION_SCHEDULED - DELETING - DELETION_SCHEDULED - ERRED - OK - UPDATE_SCHEDULED - UPDATING explode: true style: form - in: query name: tenant schema: type: string - in: query name: tenant_uuid schema: type: string format: uuid - in: query name: uuid schema: type: string format: uuid tags: - openstack-volumes security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/OpenStackVolume' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' head: operationId: openstack_volumes_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: attach_instance_uuid schema: type: string format: uuid - in: query name: availability_zone_name schema: type: string - in: query name: backend_id schema: type: string - in: query name: can_manage schema: type: boolean description: Can manage - in: query name: customer schema: type: string format: uuid - in: query name: customer_abbreviation schema: type: string - in: query name: customer_name schema: type: string - in: query name: customer_native_name schema: type: string - in: query name: customer_uuid schema: type: string format: uuid - in: query name: description schema: type: string - in: query name: external_ip schema: type: string - in: query name: instance schema: type: string - in: query name: instance_uuid schema: type: string format: uuid - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: project schema: type: string format: uuid - in: query name: project_name schema: type: string - in: query name: project_uuid schema: type: string format: uuid - in: query name: runtime_state schema: type: string - in: query name: service_settings_name schema: type: string - in: query name: service_settings_uuid schema: type: string format: uuid - in: query name: snapshot schema: type: string - in: query name: snapshot_uuid schema: type: string format: uuid - in: query name: state schema: type: array items: type: string enum: - CREATING - CREATION_SCHEDULED - DELETING - DELETION_SCHEDULED - ERRED - OK - UPDATE_SCHEDULED - UPDATING explode: true style: form - in: query name: tenant schema: type: string - in: query name: tenant_uuid schema: type: string format: uuid - in: query name: uuid schema: type: string format: uuid tags: - openstack-volumes security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/openstack-volumes/{uuid}/: get: operationId: openstack_volumes_retrieve parameters: - in: query name: field schema: type: array items: type: string enum: - access_url - action - action_details - availability_zone - availability_zone_name - backend_id - bootable - created - customer - customer_abbreviation - customer_name - customer_native_name - description - device - error_message - error_traceback - extend_enabled - image - image_metadata - image_name - instance - instance_marketplace_uuid - instance_name - is_limit_based - is_usage_based - marketplace_category_name - marketplace_category_uuid - marketplace_offering_name - marketplace_offering_plugin_options - marketplace_offering_uuid - marketplace_plan_uuid - marketplace_resource_state - marketplace_resource_uuid - metadata - modified - name - project - project_name - project_uuid - resource_type - runtime_state - service_name - service_settings - service_settings_error_message - service_settings_state - service_settings_uuid - size - source_snapshot - state - tenant - tenant_uuid - type - type_name - url - uuid - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-volumes security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OpenStackVolume' description: '' put: operationId: openstack_volumes_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-volumes requestBody: content: application/json: schema: $ref: '#/components/schemas/OpenStackVolumeRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OpenStackVolume' description: '' patch: operationId: openstack_volumes_partial_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-volumes requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedOpenStackVolumeRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OpenStackVolume' description: '' /api/openstack-volumes/{uuid}/attach/: post: operationId: openstack_volumes_attach description: Attach volume to instance parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-volumes requestBody: content: application/json: schema: $ref: '#/components/schemas/VolumeAttachRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/openstack-volumes/{uuid}/detach/: post: operationId: openstack_volumes_detach description: Detach instance from volume parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-volumes security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/openstack-volumes/{uuid}/extend/: post: operationId: openstack_volumes_extend description: Increase volume size parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-volumes requestBody: content: application/json: schema: $ref: '#/components/schemas/OpenStackVolumeExtendRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/openstack-volumes/{uuid}/pull/: post: operationId: openstack_volumes_pull parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-volumes security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/openstack-volumes/{uuid}/retype/: post: operationId: openstack_volumes_retype description: Retype detached volume parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-volumes requestBody: content: application/json: schema: $ref: '#/components/schemas/OpenStackVolumeRetypeRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/openstack-volumes/{uuid}/snapshot/: post: operationId: openstack_volumes_snapshot description: Create snapshot from volume parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-volumes requestBody: content: application/json: schema: $ref: '#/components/schemas/OpenStackSnapshotRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/OpenStackSnapshot' description: '' /api/openstack-volumes/{uuid}/unlink/: post: operationId: openstack_volumes_unlink description: |- Delete resource from the database without scheduling operations on backend and without checking current state of the resource. It is intended to be used for removing resource stuck in transitioning state. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - openstack-volumes security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/organization-groups/: get: operationId: organization_groups_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - name: o required: false in: query description: Which field to use when ordering the results. schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: parent schema: type: string format: uuid tags: - organization-groups security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/OrganizationGroup' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' post: operationId: organization_groups_create tags: - organization-groups requestBody: content: application/json: schema: $ref: '#/components/schemas/OrganizationGroupRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/OrganizationGroup' description: '' head: operationId: organization_groups_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - name: o required: false in: query description: Which field to use when ordering the results. schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: parent schema: type: string format: uuid tags: - organization-groups security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/organization-groups/{uuid}/: get: operationId: organization_groups_retrieve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - organization-groups security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OrganizationGroup' description: '' put: operationId: organization_groups_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - organization-groups requestBody: content: application/json: schema: $ref: '#/components/schemas/OrganizationGroupRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OrganizationGroup' description: '' patch: operationId: organization_groups_partial_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - organization-groups requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedOrganizationGroupRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OrganizationGroup' description: '' delete: operationId: organization_groups_destroy parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - organization-groups security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '204': description: No response body /api/override-settings/: get: operationId: override_settings_retrieve tags: - override-settings security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ConstanceSettings' description: '' post: operationId: override_settings tags: - override-settings requestBody: content: application/json: schema: $ref: '#/components/schemas/ConstanceSettingsRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/payment-profiles/: get: operationId: payment_profiles_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: is_active schema: type: boolean - in: query name: o schema: type: array items: type: string enum: - -is_active - -name - -payment_type - is_active - name - payment_type description: |+ Ordering explode: false style: form - in: query name: organization schema: type: string - in: query name: organization_uuid schema: type: string format: uuid - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: payment_type schema: type: array items: type: string enum: - fixed_price - invoices - payment_gw_monthly explode: true style: form tags: - payment-profiles security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/PaymentProfile' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' post: operationId: payment_profiles_create tags: - payment-profiles requestBody: content: application/json: schema: $ref: '#/components/schemas/PaymentProfileRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/PaymentProfile' description: '' head: operationId: payment_profiles_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: is_active schema: type: boolean - in: query name: o schema: type: array items: type: string enum: - -is_active - -name - -payment_type - is_active - name - payment_type description: |+ Ordering explode: false style: form - in: query name: organization schema: type: string - in: query name: organization_uuid schema: type: string format: uuid - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: payment_type schema: type: array items: type: string enum: - fixed_price - invoices - payment_gw_monthly explode: true style: form tags: - payment-profiles security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/payment-profiles/{uuid}/: get: operationId: payment_profiles_retrieve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - payment-profiles security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaymentProfile' description: '' put: operationId: payment_profiles_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - payment-profiles requestBody: content: application/json: schema: $ref: '#/components/schemas/PaymentProfileRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaymentProfile' description: '' patch: operationId: payment_profiles_partial_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - payment-profiles requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedPaymentProfileRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaymentProfile' description: '' delete: operationId: payment_profiles_destroy parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - payment-profiles security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '204': description: No response body /api/payment-profiles/{uuid}/enable/: post: operationId: payment_profiles_enable parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - payment-profiles security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/payments/: get: operationId: payments_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: date_of_payment schema: type: string format: date - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: profile schema: type: string - in: query name: profile_uuid schema: type: string format: uuid tags: - payments security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/Payment' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' post: operationId: payments_create tags: - payments requestBody: content: application/json: schema: $ref: '#/components/schemas/PaymentRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/Payment' description: '' head: operationId: payments_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: date_of_payment schema: type: string format: date - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: profile schema: type: string - in: query name: profile_uuid schema: type: string format: uuid tags: - payments security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/payments/{uuid}/: get: operationId: payments_retrieve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - payments security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Payment' description: '' put: operationId: payments_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - payments requestBody: content: application/json: schema: $ref: '#/components/schemas/PaymentRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Payment' description: '' patch: operationId: payments_partial_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - payments requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedPaymentRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Payment' description: '' delete: operationId: payments_destroy parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - payments security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '204': description: No response body /api/payments/{uuid}/link_to_invoice/: post: operationId: payments_link_to_invoice description: Link a payment to an invoice. Payment can be linked to an invoice only if they belong to the same customer. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - payments requestBody: content: application/json: schema: $ref: '#/components/schemas/LinkToInvoiceRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/LinkToInvoice' description: '' /api/payments/{uuid}/unlink_from_invoice/: post: operationId: payments_unlink_from_invoice description: Unlink a payment from an invoice. Remove connection between payment and existing linked invoice. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - payments security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/project-credits/: get: operationId: project_credits_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: customer_name schema: type: string - in: query name: customer_slug schema: type: string - in: query name: customer_uuid schema: type: string format: uuid - in: query name: o schema: type: array items: type: string enum: - -end_date - -expected_consumption - -project_name - -value - end_date - expected_consumption - project_name - value description: |+ Ordering explode: false style: form - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: project_name schema: type: string - in: query name: project_uuid schema: type: string format: uuid tags: - project-credits security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/ProjectCredit' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' post: operationId: project_credits_create tags: - project-credits requestBody: content: application/json: schema: $ref: '#/components/schemas/ProjectCreditRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/ProjectCredit' description: '' head: operationId: project_credits_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: customer_name schema: type: string - in: query name: customer_slug schema: type: string - in: query name: customer_uuid schema: type: string format: uuid - in: query name: o schema: type: array items: type: string enum: - -end_date - -expected_consumption - -project_name - -value - end_date - expected_consumption - project_name - value description: |+ Ordering explode: false style: form - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: project_name schema: type: string - in: query name: project_uuid schema: type: string format: uuid tags: - project-credits security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/project-credits/{uuid}/: get: operationId: project_credits_retrieve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - project-credits security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ProjectCredit' description: '' put: operationId: project_credits_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - project-credits requestBody: content: application/json: schema: $ref: '#/components/schemas/ProjectCreditRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ProjectCredit' description: '' patch: operationId: project_credits_partial_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - project-credits requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedProjectCreditRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ProjectCredit' description: '' delete: operationId: project_credits_destroy parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - project-credits security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '204': description: No response body /api/project-permissions-reviews/: get: operationId: project_permissions_reviews_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: closed schema: type: string format: date-time - in: query name: is_pending schema: type: boolean description: Is pending - in: query name: o schema: type: array items: type: string enum: - -closed - -created - closed - created description: |+ Ordering explode: false style: form - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: project_uuid schema: type: string format: uuid description: Project UUID - in: query name: reviewer_uuid schema: type: string format: uuid description: Reviewer UUID tags: - project-permissions-reviews security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/ProjectPermissionReview' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' head: operationId: project_permissions_reviews_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: closed schema: type: string format: date-time - in: query name: is_pending schema: type: boolean description: Is pending - in: query name: o schema: type: array items: type: string enum: - -closed - -created - closed - created description: |+ Ordering explode: false style: form - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: project_uuid schema: type: string format: uuid description: Project UUID - in: query name: reviewer_uuid schema: type: string format: uuid description: Reviewer UUID tags: - project-permissions-reviews security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/project-permissions-reviews/{uuid}/: get: operationId: project_permissions_reviews_retrieve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - project-permissions-reviews security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ProjectPermissionReview' description: '' /api/project-permissions-reviews/{uuid}/close/: post: operationId: project_permissions_reviews_close description: Complete project permission review. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - project-permissions-reviews security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body x-permissions: - permission: PROJECT.REVIEW_MEMBERSHIP scopes: - project /api/project-quotas/: get: operationId: project_quotas_list description: List project quotas. parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - project-quotas security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/ProjectQuotas' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' head: operationId: project_quotas_count description: Get number of items in the collection matching the request parameters. parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - project-quotas security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/project-types/: get: operationId: project_types_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - project-types security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/ProjectType' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' head: operationId: project_types_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - project-types security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/project-types/{uuid}/: get: operationId: project_types_retrieve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - project-types security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ProjectType' description: '' /api/projects/: get: operationId: projects_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: backend_id schema: type: string - in: query name: can_admin schema: type: boolean description: Return a list of projects where current user is admin. - in: query name: can_manage schema: type: boolean description: Return a list of projects where current user is manager or a customer owner. - in: query name: conceal_finished_projects schema: type: boolean description: Conceal finished projects - in: query name: created schema: type: string format: date-time description: Created after - in: query name: customer schema: type: array items: type: string format: uuid description: Multiple values may be separated by commas. explode: false style: form - in: query name: customer_abbreviation schema: type: string - in: query name: customer_name schema: type: string - in: query name: customer_native_name schema: type: string - in: query name: description schema: type: string - in: query name: field schema: type: array items: type: string enum: - backend_id - billing_price_estimate - created - customer - customer_abbreviation - customer_name - customer_native_name - customer_slug - customer_uuid - description - end_date - end_date_requested_by - image - is_industry - kind - marketplace_resource_count - max_service_accounts - name - oecd_fos_2007_code - oecd_fos_2007_label - project_credit - resources_count - slug - start_date - type - type_name - type_uuid - url - uuid - in: query name: modified schema: type: string format: date-time description: Modified after - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - in: query name: o schema: type: array items: type: string enum: - -created - -customer_abbreviation - -customer_name - -customer_native_name - -end_date - -estimated_cost - -name - -start_date - created - customer_abbreviation - customer_name - customer_native_name - end_date - estimated_cost - name - start_date description: |+ Ordering explode: false style: form - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: query schema: type: string description: Filter by name, UUID, backend ID or resource effective ID - in: query name: slug schema: type: string tags: - projects security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/Project' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' post: operationId: projects_create description: |- A new project can be created by users with staff privilege (is_staff=True) or customer owners. Project resource quota is optional. tags: - projects requestBody: content: application/json: schema: $ref: '#/components/schemas/ProjectRequest' examples: CreateProject: value: name: Project A customer: http://example.com/api/customers/6c9b01c251c24174a6691a1f894fae31/ summary: Create project required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/Project' description: '' head: operationId: projects_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: backend_id schema: type: string - in: query name: can_admin schema: type: boolean description: Return a list of projects where current user is admin. - in: query name: can_manage schema: type: boolean description: Return a list of projects where current user is manager or a customer owner. - in: query name: conceal_finished_projects schema: type: boolean description: Conceal finished projects - in: query name: created schema: type: string format: date-time description: Created after - in: query name: customer schema: type: array items: type: string format: uuid description: Multiple values may be separated by commas. explode: false style: form - in: query name: customer_abbreviation schema: type: string - in: query name: customer_name schema: type: string - in: query name: customer_native_name schema: type: string - in: query name: description schema: type: string - in: query name: modified schema: type: string format: date-time description: Modified after - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - in: query name: o schema: type: array items: type: string enum: - -created - -customer_abbreviation - -customer_name - -customer_native_name - -end_date - -estimated_cost - -name - -start_date - created - customer_abbreviation - customer_name - customer_native_name - end_date - estimated_cost - name - start_date description: |+ Ordering explode: false style: form - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: query schema: type: string description: Filter by name, UUID, backend ID or resource effective ID - in: query name: slug schema: type: string tags: - projects security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/projects/{project_uuid}/other_users/: get: operationId: projects_other_users_list description: A list of users which can be added to the current project from other projects of the same customer. parameters: - in: query name: agreement_date schema: type: string format: date-time description: Agreement date after - in: query name: civil_number schema: type: string - in: query name: date_joined schema: type: string format: date-time description: Date joined after - in: query name: description schema: type: string - in: query name: email schema: type: string - in: query name: full_name schema: type: string description: Full name - in: query name: is_active schema: type: boolean - in: query name: job_title schema: type: string - in: query name: modified schema: type: string format: date-time description: Date modified after - in: query name: native_name schema: type: string - in: query name: o schema: type: string enum: - concatenated_name - -concatenated_name description: Ordering. Sort by a combination of first name, last name, and username. - in: query name: organization schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: phone_number schema: type: string - in: path name: project_uuid schema: type: string format: uuid description: UUID of the project required: true - in: query name: registration_method schema: type: string - in: query name: user_keyword schema: type: string description: User keyword - in: query name: username schema: type: string tags: - projects security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/BasicUser' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' /api/projects/{uuid}/: get: operationId: projects_retrieve parameters: - in: query name: field schema: type: array items: type: string enum: - backend_id - billing_price_estimate - created - customer - customer_abbreviation - customer_name - customer_native_name - customer_slug - customer_uuid - description - end_date - end_date_requested_by - image - is_industry - kind - marketplace_resource_count - max_service_accounts - name - oecd_fos_2007_code - oecd_fos_2007_label - project_credit - resources_count - slug - start_date - type - type_name - type_uuid - url - uuid - in: path name: uuid schema: type: string format: uuid required: true tags: - projects security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Project' description: '' put: operationId: projects_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - projects requestBody: content: application/json: schema: $ref: '#/components/schemas/ProjectRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Project' description: '' x-permissions: - permission: PROJECT.UPDATE scopes: - '*' - customer patch: operationId: projects_partial_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - projects requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedProjectRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Project' description: '' x-permissions: - permission: PROJECT.UPDATE scopes: - '*' - customer delete: operationId: projects_destroy description: If a project has connected instances, deletion request will fail with 409 response code. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - projects security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '204': description: No response body x-permissions: - permission: PROJECT.DELETE scopes: - customer /api/projects/{uuid}/add_user/: post: operationId: projects_add_user parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - projects requestBody: content: application/json: schema: $ref: '#/components/schemas/UserRoleCreateRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/UserRoleExpirationTime' description: '' /api/projects/{uuid}/checklist/: get: operationId: projects_checklist_retrieve description: Get checklist with questions and existing answers. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - projects security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ChecklistResponse' description: '' '400': content: application/json: schema: description: No checklist configured description: '' '404': content: application/json: schema: description: Object not found description: '' /api/projects/{uuid}/completion_status/: get: operationId: projects_completion_status_retrieve description: Get checklist completion status. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - projects security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ChecklistCompletion' description: '' '400': content: application/json: schema: description: No checklist configured description: '' '404': content: application/json: schema: description: Object not found description: '' /api/projects/{uuid}/delete_user/: post: operationId: projects_delete_user parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - projects requestBody: content: application/json: schema: $ref: '#/components/schemas/UserRoleDeleteRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/projects/{uuid}/list_users/: get: operationId: projects_list_users_list parameters: - in: query name: field schema: type: array items: type: string enum: - created - created_by_full_name - created_by_uuid - expiration_time - role_name - role_uuid - user_email - user_full_name - user_image - user_username - user_uuid - uuid description: Fields to include in response - in: query name: full_name schema: type: string description: User full name - in: query name: native_name schema: type: string description: User native name - in: query name: o schema: type: array items: type: string enum: - created - email - expiration_time - full_name - native_name - role - username description: Ordering fields - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: role schema: type: string format: uuid description: Role UUID or name - in: query name: search_string schema: type: string description: Search string for user - in: query name: user schema: type: string format: uuid description: User UUID - in: query name: user_slug schema: type: string description: User slug - in: query name: user_url schema: type: string description: User URL - in: query name: username schema: type: string description: User username - in: path name: uuid schema: type: string format: uuid required: true tags: - projects security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/UserRoleDetails' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' /api/projects/{uuid}/move_project/: post: operationId: projects_move_project parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - projects requestBody: content: application/json: schema: $ref: '#/components/schemas/MoveProjectRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Project' description: '' /api/projects/{uuid}/stats/: get: operationId: projects_stats_retrieve description: Return statistics about project resources usage parameters: - in: query name: for_current_month schema: type: boolean - in: path name: uuid schema: type: string format: uuid required: true tags: - projects security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ComponentsUsageStats' description: '' /api/projects/{uuid}/submit_answers/: post: operationId: projects_submit_answers description: Submit checklist answers. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - projects requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/AnswerSubmitRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/AnswerSubmitResponse' description: '' '400': content: application/json: schema: description: Validation error or no checklist configured description: '' '404': content: application/json: schema: description: Object not found description: '' /api/projects/{uuid}/update_user/: post: operationId: projects_update_user parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - projects requestBody: content: application/json: schema: $ref: '#/components/schemas/UserRoleUpdateRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/UserRoleExpirationTime' description: '' /api/promotions-campaigns/: get: operationId: promotions_campaigns_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: discount_type schema: type: string - in: query name: end_date schema: type: string format: date - in: query name: o schema: type: array items: type: string enum: - -end_date - -start_date - end_date - start_date description: |+ Ordering explode: false style: form - in: query name: offering schema: type: string description: Offering - in: query name: offering_uuid schema: type: string format: uuid - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: query schema: type: string description: Search by name or coupon code - in: query name: service_provider_uuid schema: type: string format: uuid - in: query name: start_date schema: type: string format: date - in: query name: state schema: type: array items: type: string enum: - Active - Draft - Terminated explode: true style: form tags: - promotions-campaigns security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/Campaign' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' post: operationId: promotions_campaigns_create tags: - promotions-campaigns requestBody: content: application/json: schema: $ref: '#/components/schemas/CampaignRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/Campaign' description: '' head: operationId: promotions_campaigns_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: discount_type schema: type: string - in: query name: end_date schema: type: string format: date - in: query name: o schema: type: array items: type: string enum: - -end_date - -start_date - end_date - start_date description: |+ Ordering explode: false style: form - in: query name: offering schema: type: string description: Offering - in: query name: offering_uuid schema: type: string format: uuid - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: query schema: type: string description: Search by name or coupon code - in: query name: service_provider_uuid schema: type: string format: uuid - in: query name: start_date schema: type: string format: date - in: query name: state schema: type: array items: type: string enum: - Active - Draft - Terminated explode: true style: form tags: - promotions-campaigns security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/promotions-campaigns/{uuid}/: get: operationId: promotions_campaigns_retrieve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - promotions-campaigns security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Campaign' description: '' put: operationId: promotions_campaigns_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - promotions-campaigns requestBody: content: application/json: schema: $ref: '#/components/schemas/CampaignRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Campaign' description: '' x-permissions: - permission: OFFERING.MANAGE_CAMPAIGN scopes: - service_provider.customer delete: operationId: promotions_campaigns_destroy parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - promotions-campaigns security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '204': description: No response body x-permissions: - permission: OFFERING.MANAGE_CAMPAIGN scopes: - service_provider.customer /api/promotions-campaigns/{uuid}/activate/: post: operationId: promotions_campaigns_activate description: Activate campaign. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - promotions-campaigns security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body '409': description: No response body x-permissions: - permission: OFFERING.MANAGE_CAMPAIGN scopes: - service_provider.customer /api/promotions-campaigns/{uuid}/orders/: get: operationId: promotions_campaigns_orders_list description: Return a list of orders for which the campaign is applied. parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: path name: uuid schema: type: string format: uuid required: true tags: - promotions-campaigns security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/OrderDetails' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' /api/promotions-campaigns/{uuid}/resources/: get: operationId: promotions_campaigns_resources_list description: Return a list of resources for which the campaign is applied. parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: path name: uuid schema: type: string format: uuid required: true tags: - promotions-campaigns security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/Resource' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' /api/promotions-campaigns/{uuid}/terminate/: post: operationId: promotions_campaigns_terminate description: Terminate campaign. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - promotions-campaigns security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body '409': description: No response body x-permissions: - permission: OFFERING.MANAGE_CAMPAIGN scopes: - service_provider.customer /api/proposal-proposals/: get: operationId: proposal_proposals_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: call_uuid schema: type: string format: uuid - in: query name: name schema: type: string - in: query name: o schema: type: array items: type: string enum: - -created - -round__call__name - -round__cutoff_time - -round__start_time - -state - created - round__call__name - round__cutoff_time - round__start_time - state description: |+ Ordering explode: false style: form - in: query name: organization_uuid schema: type: string format: uuid - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: round schema: type: string format: uuid - in: query name: state schema: type: array items: type: string enum: - accepted - canceled - draft - in_review - rejected - submitted explode: true style: form tags: - proposal-proposals security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/Proposal' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' post: operationId: proposal_proposals_create tags: - proposal-proposals requestBody: content: application/json: schema: $ref: '#/components/schemas/ProposalRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/Proposal' description: '' head: operationId: proposal_proposals_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: call_uuid schema: type: string format: uuid - in: query name: name schema: type: string - in: query name: o schema: type: array items: type: string enum: - -created - -round__call__name - -round__cutoff_time - -round__start_time - -state - created - round__call__name - round__cutoff_time - round__start_time - state description: |+ Ordering explode: false style: form - in: query name: organization_uuid schema: type: string format: uuid - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: round schema: type: string format: uuid - in: query name: state schema: type: array items: type: string enum: - accepted - canceled - draft - in_review - rejected - submitted explode: true style: form tags: - proposal-proposals security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/proposal-proposals/{uuid}/: get: operationId: proposal_proposals_retrieve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - proposal-proposals security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Proposal' description: '' delete: operationId: proposal_proposals_destroy parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - proposal-proposals security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '204': description: No response body /api/proposal-proposals/{uuid}/add_user/: post: operationId: proposal_proposals_add_user parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - proposal-proposals requestBody: content: application/json: schema: $ref: '#/components/schemas/UserRoleCreateRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/UserRoleExpirationTime' description: '' /api/proposal-proposals/{uuid}/approve/: post: operationId: proposal_proposals_approve description: Approve a proposal. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - proposal-proposals requestBody: content: application/json: schema: $ref: '#/components/schemas/ProposalApproveRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body x-permissions: - permission: CALL.APPROVE_AND_REJECT_PROPOSALS scopes: - round.call - round.call.manager /api/proposal-proposals/{uuid}/attach_document/: post: operationId: proposal_proposals_attach_document description: Attach document to proposal. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - proposal-proposals requestBody: content: application/json: schema: $ref: '#/components/schemas/ProposalDocumentationRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/proposal-proposals/{uuid}/checklist/: get: operationId: proposal_proposals_checklist_retrieve description: Get checklist with questions and existing answers. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - proposal-proposals security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ChecklistResponse' description: '' '400': content: application/json: schema: description: No checklist configured description: '' '404': content: application/json: schema: description: Object not found description: '' x-permissions: - permission: PROPOSAL.MANAGE scopes: null /api/proposal-proposals/{uuid}/checklist_review/: get: operationId: proposal_proposals_checklist_review_retrieve description: Get checklist with questions and existing answers including review logic (reviewers only). parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - proposal-proposals security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ChecklistReviewerResponse' description: '' '400': content: application/json: schema: description: No checklist configured description: '' '404': content: application/json: schema: description: Object not found description: '' x-permissions: - permission: PROPOSAL.MANAGE_REVIEW scopes: - round.call /api/proposal-proposals/{uuid}/completion_review_status/: get: operationId: proposal_proposals_completion_review_status_retrieve description: Get checklist completion status with review triggers (reviewers only). parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - proposal-proposals security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ChecklistCompletionReviewer' description: '' '400': content: application/json: schema: description: No checklist configured description: '' '404': content: application/json: schema: description: Object not found description: '' x-permissions: - permission: PROPOSAL.MANAGE_REVIEW scopes: - round.call /api/proposal-proposals/{uuid}/completion_status/: get: operationId: proposal_proposals_completion_status_retrieve description: Get checklist completion status. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - proposal-proposals security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ChecklistCompletion' description: '' '400': content: application/json: schema: description: No checklist configured description: '' '404': content: application/json: schema: description: Object not found description: '' x-permissions: - permission: PROPOSAL.MANAGE scopes: null /api/proposal-proposals/{uuid}/delete_user/: post: operationId: proposal_proposals_delete_user parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - proposal-proposals requestBody: content: application/json: schema: $ref: '#/components/schemas/UserRoleDeleteRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/proposal-proposals/{uuid}/list_users/: get: operationId: proposal_proposals_list_users_list parameters: - in: query name: field schema: type: array items: type: string enum: - created - created_by_full_name - created_by_uuid - expiration_time - role_name - role_uuid - user_email - user_full_name - user_image - user_username - user_uuid - uuid description: Fields to include in response - in: query name: full_name schema: type: string description: User full name - in: query name: native_name schema: type: string description: User native name - in: query name: o schema: type: array items: type: string enum: - created - email - expiration_time - full_name - native_name - role - username description: Ordering fields - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: role schema: type: string format: uuid description: Role UUID or name - in: query name: search_string schema: type: string description: Search string for user - in: query name: user schema: type: string format: uuid description: User UUID - in: query name: user_slug schema: type: string description: User slug - in: query name: user_url schema: type: string description: User URL - in: query name: username schema: type: string description: User username - in: path name: uuid schema: type: string format: uuid required: true tags: - proposal-proposals security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/UserRoleDetails' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' /api/proposal-proposals/{uuid}/reject/: post: operationId: proposal_proposals_reject description: Reject a proposal. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - proposal-proposals requestBody: content: application/json: schema: $ref: '#/components/schemas/ProposalApproveRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body x-permissions: - permission: CALL.APPROVE_AND_REJECT_PROPOSALS scopes: - round.call - round.call.manager /api/proposal-proposals/{uuid}/resources/: get: operationId: proposal_proposals_resources_list description: List resources for a proposal. parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: path name: uuid schema: type: string format: uuid required: true tags: - proposal-proposals security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/RequestedResource' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' post: operationId: proposal_proposals_resources_set description: Create resource for a proposal. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - proposal-proposals requestBody: content: application/json: schema: $ref: '#/components/schemas/RequestedResourceRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RequestedResource' description: '' /api/proposal-proposals/{uuid}/resources/{obj_uuid}/: get: operationId: proposal_proposals_resources_retrieve parameters: - in: path name: obj_uuid schema: type: string pattern: ^[a-f0-9]+$ required: true - in: path name: uuid schema: type: string pattern: ^[a-f0-9]+$ required: true tags: - proposal-proposals security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RequestedResource' description: '' put: operationId: proposal_proposals_resources_update parameters: - in: path name: obj_uuid schema: type: string pattern: ^[a-f0-9]+$ required: true - in: path name: uuid schema: type: string pattern: ^[a-f0-9]+$ required: true tags: - proposal-proposals requestBody: content: application/json: schema: $ref: '#/components/schemas/RequestedResourceRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RequestedResource' description: '' patch: operationId: proposal_proposals_resources_partial_update parameters: - in: path name: obj_uuid schema: type: string pattern: ^[a-f0-9]+$ required: true - in: path name: uuid schema: type: string pattern: ^[a-f0-9]+$ required: true tags: - proposal-proposals requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedRequestedResourceRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RequestedResource' description: '' delete: operationId: proposal_proposals_resources_destroy parameters: - in: path name: obj_uuid schema: type: string pattern: ^[a-f0-9]+$ required: true - in: path name: uuid schema: type: string pattern: ^[a-f0-9]+$ required: true tags: - proposal-proposals security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '204': description: No response body /api/proposal-proposals/{uuid}/submit/: post: operationId: proposal_proposals_submit description: Submit a proposal. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - proposal-proposals security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/proposal-proposals/{uuid}/submit_answers/: post: operationId: proposal_proposals_submit_answers description: Submit checklist answers. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - proposal-proposals requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/AnswerSubmitRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/AnswerSubmitResponse' description: '' '400': content: application/json: schema: description: Validation error or no checklist configured description: '' '404': content: application/json: schema: description: Object not found description: '' x-permissions: - permission: PROPOSAL.MANAGE scopes: null /api/proposal-proposals/{uuid}/update_project_details/: post: operationId: proposal_proposals_update_project_details description: Update project details of a proposal. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - proposal-proposals requestBody: content: application/json: schema: $ref: '#/components/schemas/ProposalUpdateProjectDetailsRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/proposal-proposals/{uuid}/update_user/: post: operationId: proposal_proposals_update_user parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - proposal-proposals requestBody: content: application/json: schema: $ref: '#/components/schemas/UserRoleUpdateRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/UserRoleExpirationTime' description: '' /api/proposal-protected-calls/: get: operationId: proposal_protected_calls_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: customer schema: type: string - in: query name: customer_keyword schema: type: string - in: query name: customer_uuid schema: type: string format: uuid - in: query name: field schema: type: array items: type: string enum: - backend_id - compliance_checklist - compliance_checklist_name - created - created_by - customer_name - customer_uuid - description - documents - end_date - external_url - fixed_duration_in_days - manager - manager_uuid - name - offerings - reference_code - resource_templates - reviewer_identity_visible_to_submitters - reviews_visible_to_submitters - rounds - slug - start_date - state - url - uuid - in: query name: has_active_round schema: type: boolean - in: query name: name schema: type: string - in: query name: o schema: type: array items: type: string enum: - -created - -manager__customer__name - -name - created - manager__customer__name - name description: |+ Ordering explode: false style: form - in: query name: offering_uuid schema: type: string format: uuid - in: query name: offerings_provider_uuid schema: type: string format: uuid - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: state schema: type: array items: type: string enum: - active - archived - draft explode: true style: form tags: - proposal-protected-calls security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/ProtectedCall' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' post: operationId: proposal_protected_calls_create tags: - proposal-protected-calls requestBody: content: application/json: schema: $ref: '#/components/schemas/ProtectedCallRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/ProtectedCall' description: '' head: operationId: proposal_protected_calls_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: customer schema: type: string - in: query name: customer_keyword schema: type: string - in: query name: customer_uuid schema: type: string format: uuid - in: query name: has_active_round schema: type: boolean - in: query name: name schema: type: string - in: query name: o schema: type: array items: type: string enum: - -created - -manager__customer__name - -name - created - manager__customer__name - name description: |+ Ordering explode: false style: form - in: query name: offering_uuid schema: type: string format: uuid - in: query name: offerings_provider_uuid schema: type: string format: uuid - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: state schema: type: array items: type: string enum: - active - archived - draft explode: true style: form tags: - proposal-protected-calls security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/proposal-protected-calls/{uuid}/: get: operationId: proposal_protected_calls_retrieve parameters: - in: query name: field schema: type: array items: type: string enum: - backend_id - compliance_checklist - compliance_checklist_name - created - created_by - customer_name - customer_uuid - description - documents - end_date - external_url - fixed_duration_in_days - manager - manager_uuid - name - offerings - reference_code - resource_templates - reviewer_identity_visible_to_submitters - reviews_visible_to_submitters - rounds - slug - start_date - state - url - uuid - in: path name: uuid schema: type: string format: uuid required: true tags: - proposal-protected-calls security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ProtectedCall' description: '' put: operationId: proposal_protected_calls_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - proposal-protected-calls requestBody: content: application/json: schema: $ref: '#/components/schemas/ProtectedCallRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ProtectedCall' description: '' patch: operationId: proposal_protected_calls_partial_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - proposal-protected-calls requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedProtectedCallRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ProtectedCall' description: '' delete: operationId: proposal_protected_calls_destroy parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - proposal-protected-calls security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '204': description: No response body /api/proposal-protected-calls/{uuid}/activate/: post: operationId: proposal_protected_calls_activate description: Activate a call. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - proposal-protected-calls security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ProtectedCall' description: '' /api/proposal-protected-calls/{uuid}/add_user/: post: operationId: proposal_protected_calls_add_user parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - proposal-protected-calls requestBody: content: application/json: schema: $ref: '#/components/schemas/UserRoleCreateRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/UserRoleExpirationTime' description: '' /api/proposal-protected-calls/{uuid}/archive/: post: operationId: proposal_protected_calls_archive description: Archive a call. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - proposal-protected-calls security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ProtectedCall' description: '' /api/proposal-protected-calls/{uuid}/attach_documents/: post: operationId: proposal_protected_calls_attach_documents description: Attach documents to call. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - proposal-protected-calls requestBody: content: application/json: schema: $ref: '#/components/schemas/CallAttachDocumentsRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/proposal-protected-calls/{uuid}/compliance_overview/: get: operationId: proposal_protected_calls_compliance_overview_retrieve description: Get compliance overview for call manager showing all proposals and their compliance status. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - proposal-protected-calls security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/CallComplianceOverview' description: '' x-permissions: - permission: CALL.UPDATE scopes: null /api/proposal-protected-calls/{uuid}/delete_user/: post: operationId: proposal_protected_calls_delete_user parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - proposal-protected-calls requestBody: content: application/json: schema: $ref: '#/components/schemas/UserRoleDeleteRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/proposal-protected-calls/{uuid}/detach_documents/: post: operationId: proposal_protected_calls_detach_documents description: Detach documents from call. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - proposal-protected-calls requestBody: content: application/json: schema: $ref: '#/components/schemas/CallDetachDocumentsRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/proposal-protected-calls/{uuid}/list_users/: get: operationId: proposal_protected_calls_list_users_list parameters: - in: query name: field schema: type: array items: type: string enum: - created - created_by_full_name - created_by_uuid - expiration_time - role_name - role_uuid - user_email - user_full_name - user_image - user_username - user_uuid - uuid description: Fields to include in response - in: query name: full_name schema: type: string description: User full name - in: query name: native_name schema: type: string description: User native name - in: query name: o schema: type: array items: type: string enum: - created - email - expiration_time - full_name - native_name - role - username description: Ordering fields - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: role schema: type: string format: uuid description: Role UUID or name - in: query name: search_string schema: type: string description: Search string for user - in: query name: user schema: type: string format: uuid description: User UUID - in: query name: user_slug schema: type: string description: User slug - in: query name: user_url schema: type: string description: User URL - in: query name: username schema: type: string description: User username - in: path name: uuid schema: type: string format: uuid required: true tags: - proposal-protected-calls security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/UserRoleDetails' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' /api/proposal-protected-calls/{uuid}/offerings/: get: operationId: proposal_protected_calls_offerings_list description: List offerings for a call. parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: path name: uuid schema: type: string format: uuid required: true tags: - proposal-protected-calls security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/RequestedOffering' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' post: operationId: proposal_protected_calls_offerings_set description: Create offering for a call. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - proposal-protected-calls requestBody: content: application/json: schema: $ref: '#/components/schemas/RequestedOfferingRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RequestedOffering' description: '' /api/proposal-protected-calls/{uuid}/offerings/{obj_uuid}/: get: operationId: proposal_protected_calls_offerings_retrieve parameters: - in: path name: obj_uuid schema: type: string pattern: ^[a-f0-9]+$ required: true - in: path name: uuid schema: type: string pattern: ^[a-f0-9]+$ required: true tags: - proposal-protected-calls security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RequestedOffering' description: '' put: operationId: proposal_protected_calls_offerings_update parameters: - in: path name: obj_uuid schema: type: string pattern: ^[a-f0-9]+$ required: true - in: path name: uuid schema: type: string pattern: ^[a-f0-9]+$ required: true tags: - proposal-protected-calls requestBody: content: application/json: schema: $ref: '#/components/schemas/RequestedOfferingRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RequestedOffering' description: '' patch: operationId: proposal_protected_calls_offerings_partial_update parameters: - in: path name: obj_uuid schema: type: string pattern: ^[a-f0-9]+$ required: true - in: path name: uuid schema: type: string pattern: ^[a-f0-9]+$ required: true tags: - proposal-protected-calls requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedRequestedOfferingRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RequestedOffering' description: '' delete: operationId: proposal_protected_calls_offerings_destroy parameters: - in: path name: obj_uuid schema: type: string pattern: ^[a-f0-9]+$ required: true - in: path name: uuid schema: type: string pattern: ^[a-f0-9]+$ required: true tags: - proposal-protected-calls security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '204': description: No response body /api/proposal-protected-calls/{uuid}/proposals/{proposal_uuid}/compliance-answers/: get: operationId: proposal_protected_calls_proposals_compliance_answers_list description: Get detailed compliance answers for a specific proposal (call managers only). parameters: - in: query name: customer schema: type: string - in: query name: customer_keyword schema: type: string - in: query name: customer_uuid schema: type: string format: uuid - in: query name: has_active_round schema: type: boolean - in: query name: name schema: type: string - in: query name: o schema: type: array items: type: string enum: - -created - -manager__customer__name - -name - created - manager__customer__name - name description: |+ Ordering explode: false style: form - in: query name: offering_uuid schema: type: string format: uuid - in: query name: offerings_provider_uuid schema: type: string format: uuid - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: path name: proposal_uuid schema: type: string description: UUID of the proposal required: true - in: query name: state schema: type: array items: type: string enum: - active - archived - draft explode: true style: form - in: path name: uuid schema: type: string format: uuid required: true tags: - proposal-protected-calls security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/Answer' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' x-permissions: - permission: CALL.UPDATE scopes: null /api/proposal-protected-calls/{uuid}/resource_templates/: get: operationId: proposal_protected_calls_resource_templates_list description: List resource templates for a call. parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: path name: uuid schema: type: string format: uuid required: true tags: - proposal-protected-calls security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/CallResourceTemplate' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' post: operationId: proposal_protected_calls_resource_templates_set description: Create resource template for a call. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - proposal-protected-calls requestBody: content: application/json: schema: $ref: '#/components/schemas/CallResourceTemplateRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/CallResourceTemplate' description: '' /api/proposal-protected-calls/{uuid}/resource_templates/{obj_uuid}/: get: operationId: proposal_protected_calls_resource_templates_retrieve parameters: - in: path name: obj_uuid schema: type: string pattern: ^[a-f0-9]+$ required: true - in: path name: uuid schema: type: string pattern: ^[a-f0-9]+$ required: true tags: - proposal-protected-calls security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/CallResourceTemplate' description: '' put: operationId: proposal_protected_calls_resource_templates_update parameters: - in: path name: obj_uuid schema: type: string pattern: ^[a-f0-9]+$ required: true - in: path name: uuid schema: type: string pattern: ^[a-f0-9]+$ required: true tags: - proposal-protected-calls requestBody: content: application/json: schema: $ref: '#/components/schemas/CallResourceTemplateRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/CallResourceTemplate' description: '' patch: operationId: proposal_protected_calls_resource_templates_partial_update parameters: - in: path name: obj_uuid schema: type: string pattern: ^[a-f0-9]+$ required: true - in: path name: uuid schema: type: string pattern: ^[a-f0-9]+$ required: true tags: - proposal-protected-calls requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedCallResourceTemplateRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/CallResourceTemplate' description: '' delete: operationId: proposal_protected_calls_resource_templates_destroy parameters: - in: path name: obj_uuid schema: type: string pattern: ^[a-f0-9]+$ required: true - in: path name: uuid schema: type: string pattern: ^[a-f0-9]+$ required: true tags: - proposal-protected-calls security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '204': description: No response body /api/proposal-protected-calls/{uuid}/review_proposal_compliance/: post: operationId: proposal_protected_calls_review_proposal_compliance description: Mark proposal compliance as reviewed by call manager. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - proposal-protected-calls requestBody: content: application/json: schema: $ref: '#/components/schemas/CallComplianceReviewRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: object additionalProperties: type: string description: '' x-permissions: - permission: CALL.UPDATE scopes: null /api/proposal-protected-calls/{uuid}/rounds/: get: operationId: proposal_protected_calls_rounds_list description: List rounds for a call. parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: path name: uuid schema: type: string format: uuid required: true tags: - proposal-protected-calls security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/ProtectedRound' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' post: operationId: proposal_protected_calls_rounds_set description: Create a round for a call. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - proposal-protected-calls requestBody: content: application/json: schema: $ref: '#/components/schemas/ProtectedRoundRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ProtectedRound' description: '' /api/proposal-protected-calls/{uuid}/rounds/{obj_uuid}/: get: operationId: proposal_protected_calls_rounds_retrieve parameters: - in: path name: obj_uuid schema: type: string pattern: ^[a-f0-9]+$ required: true - in: path name: uuid schema: type: string pattern: ^[a-f0-9]+$ required: true tags: - proposal-protected-calls security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ProtectedRound' description: '' put: operationId: proposal_protected_calls_rounds_update parameters: - in: path name: obj_uuid schema: type: string pattern: ^[a-f0-9]+$ required: true - in: path name: uuid schema: type: string pattern: ^[a-f0-9]+$ required: true tags: - proposal-protected-calls requestBody: content: application/json: schema: $ref: '#/components/schemas/ProtectedRoundRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ProtectedRound' description: '' patch: operationId: proposal_protected_calls_rounds_partial_update parameters: - in: path name: obj_uuid schema: type: string pattern: ^[a-f0-9]+$ required: true - in: path name: uuid schema: type: string pattern: ^[a-f0-9]+$ required: true tags: - proposal-protected-calls requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedProtectedRoundRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ProtectedRound' description: '' delete: operationId: proposal_protected_calls_rounds_destroy parameters: - in: path name: obj_uuid schema: type: string pattern: ^[a-f0-9]+$ required: true - in: path name: uuid schema: type: string pattern: ^[a-f0-9]+$ required: true tags: - proposal-protected-calls security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '204': description: No response body /api/proposal-protected-calls/{uuid}/rounds/{obj_uuid}/close/: post: operationId: proposal_protected_calls_rounds_close parameters: - in: path name: obj_uuid schema: type: string pattern: ^[a-f0-9]+$ required: true - in: path name: uuid schema: type: string pattern: ^[a-f0-9]+$ required: true tags: - proposal-protected-calls requestBody: content: application/json: schema: $ref: '#/components/schemas/ProtectedCallRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ProtectedCall' description: '' /api/proposal-protected-calls/{uuid}/update_user/: post: operationId: proposal_protected_calls_update_user parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - proposal-protected-calls requestBody: content: application/json: schema: $ref: '#/components/schemas/UserRoleUpdateRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/UserRoleExpirationTime' description: '' /api/proposal-public-calls/: get: operationId: proposal_public_calls_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: customer schema: type: string - in: query name: customer_keyword schema: type: string - in: query name: customer_uuid schema: type: string format: uuid - in: query name: field schema: type: array items: type: string enum: - backend_id - created - customer_name - customer_uuid - description - documents - end_date - external_url - fixed_duration_in_days - manager - manager_uuid - name - offerings - resource_templates - reviewer_identity_visible_to_submitters - reviews_visible_to_submitters - rounds - slug - start_date - state - url - uuid - in: query name: has_active_round schema: type: boolean - in: query name: name schema: type: string - in: query name: o schema: type: array items: type: string enum: - -created - -manager__customer__name - -name - created - manager__customer__name - name description: |+ Ordering explode: false style: form - in: query name: offering_uuid schema: type: string format: uuid - in: query name: offerings_provider_uuid schema: type: string format: uuid - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: state schema: type: array items: type: string enum: - active - archived - draft explode: true style: form tags: - proposal-public-calls security: - tokenAuth: [] - waldurOIDCAuth: [] - {} responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/PublicCall' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' head: operationId: proposal_public_calls_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: customer schema: type: string - in: query name: customer_keyword schema: type: string - in: query name: customer_uuid schema: type: string format: uuid - in: query name: has_active_round schema: type: boolean - in: query name: name schema: type: string - in: query name: o schema: type: array items: type: string enum: - -created - -manager__customer__name - -name - created - manager__customer__name - name description: |+ Ordering explode: false style: form - in: query name: offering_uuid schema: type: string format: uuid - in: query name: offerings_provider_uuid schema: type: string format: uuid - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: state schema: type: array items: type: string enum: - active - archived - draft explode: true style: form tags: - proposal-public-calls security: - tokenAuth: [] - waldurOIDCAuth: [] - {} responses: '200': description: No response body /api/proposal-public-calls/{uuid}/: get: operationId: proposal_public_calls_retrieve parameters: - in: query name: field schema: type: array items: type: string enum: - backend_id - created - customer_name - customer_uuid - description - documents - end_date - external_url - fixed_duration_in_days - manager - manager_uuid - name - offerings - resource_templates - reviewer_identity_visible_to_submitters - reviews_visible_to_submitters - rounds - slug - start_date - state - url - uuid - in: path name: uuid schema: type: string format: uuid required: true tags: - proposal-public-calls security: - tokenAuth: [] - waldurOIDCAuth: [] - {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/PublicCall' description: '' /api/proposal-requested-offerings/: get: operationId: proposal_requested_offerings_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: call schema: type: string description: Call - in: query name: call_uuid schema: type: string format: uuid - in: query name: o schema: type: array items: type: string enum: - -call__name - -created - -offering__name - -state - call__name - created - offering__name - state description: |+ Ordering explode: false style: form - in: query name: offering schema: type: string description: Offering - in: query name: offering_uuid schema: type: string format: uuid - in: query name: organization_uuid schema: type: string format: uuid - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: provider_uuid schema: type: string format: uuid description: Provider - in: query name: state schema: type: array items: type: string enum: - accepted - canceled - requested explode: true style: form tags: - proposal-requested-offerings security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/ProviderRequestedOffering' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' head: operationId: proposal_requested_offerings_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: call schema: type: string description: Call - in: query name: call_uuid schema: type: string format: uuid - in: query name: o schema: type: array items: type: string enum: - -call__name - -created - -offering__name - -state - call__name - created - offering__name - state description: |+ Ordering explode: false style: form - in: query name: offering schema: type: string description: Offering - in: query name: offering_uuid schema: type: string format: uuid - in: query name: organization_uuid schema: type: string format: uuid - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: provider_uuid schema: type: string format: uuid description: Provider - in: query name: state schema: type: array items: type: string enum: - accepted - canceled - requested explode: true style: form tags: - proposal-requested-offerings security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/proposal-requested-offerings/{uuid}/: get: operationId: proposal_requested_offerings_retrieve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - proposal-requested-offerings security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ProviderRequestedOffering' description: '' /api/proposal-requested-offerings/{uuid}/accept/: post: operationId: proposal_requested_offerings_accept description: Accept a requested offering. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - proposal-requested-offerings security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body x-permissions: - permission: OFFERING.ACCEPT_CALL_REQUEST scopes: - offering.customer /api/proposal-requested-offerings/{uuid}/cancel/: post: operationId: proposal_requested_offerings_cancel description: Cancel a requested offering. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - proposal-requested-offerings security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body x-permissions: - permission: OFFERING.ACCEPT_CALL_REQUEST scopes: - offering.customer /api/proposal-requested-resources/: get: operationId: proposal_requested_resources_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: created schema: type: string format: date-time - in: query name: o schema: type: array items: type: string enum: - -created - -offering__name - -proposal__name - -resource__name - created - offering__name - proposal__name - resource__name description: |+ Ordering explode: false style: form - in: query name: offering schema: type: string description: Offering - in: query name: offering_uuid schema: type: string format: uuid - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: proposal schema: type: string description: Proposal - in: query name: proposal_uuid schema: type: string format: uuid - in: query name: resource schema: type: string description: Resource - in: query name: resource_uuid schema: type: string format: uuid tags: - proposal-requested-resources security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/ProviderRequestedResource' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' head: operationId: proposal_requested_resources_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: created schema: type: string format: date-time - in: query name: o schema: type: array items: type: string enum: - -created - -offering__name - -proposal__name - -resource__name - created - offering__name - proposal__name - resource__name description: |+ Ordering explode: false style: form - in: query name: offering schema: type: string description: Offering - in: query name: offering_uuid schema: type: string format: uuid - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: proposal schema: type: string description: Proposal - in: query name: proposal_uuid schema: type: string format: uuid - in: query name: resource schema: type: string description: Resource - in: query name: resource_uuid schema: type: string format: uuid tags: - proposal-requested-resources security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/proposal-requested-resources/{uuid}/: get: operationId: proposal_requested_resources_retrieve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - proposal-requested-resources security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ProviderRequestedResource' description: '' /api/proposal-reviews/: get: operationId: proposal_reviews_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: call_uuid schema: type: string format: uuid - in: query name: o schema: type: array items: type: string enum: - -created - -state - created - state description: |+ Ordering explode: false style: form - in: query name: organization_uuid schema: type: string format: uuid - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: proposal schema: type: string - in: query name: proposal_name schema: type: string - in: query name: proposal_uuid schema: type: string format: uuid - in: query name: reviewer_uuid schema: type: string format: uuid - in: query name: state schema: type: array items: type: string enum: - created - in_review - rejected - submitted explode: true style: form tags: - proposal-reviews security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/ProposalReview' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' post: operationId: proposal_reviews_create tags: - proposal-reviews requestBody: content: application/json: schema: $ref: '#/components/schemas/ProposalReviewRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/ProposalReview' description: '' head: operationId: proposal_reviews_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: call_uuid schema: type: string format: uuid - in: query name: o schema: type: array items: type: string enum: - -created - -state - created - state description: |+ Ordering explode: false style: form - in: query name: organization_uuid schema: type: string format: uuid - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: proposal schema: type: string - in: query name: proposal_name schema: type: string - in: query name: proposal_uuid schema: type: string format: uuid - in: query name: reviewer_uuid schema: type: string format: uuid - in: query name: state schema: type: array items: type: string enum: - created - in_review - rejected - submitted explode: true style: form tags: - proposal-reviews security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/proposal-reviews/{uuid}/: get: operationId: proposal_reviews_retrieve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - proposal-reviews security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ProposalReview' description: '' put: operationId: proposal_reviews_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - proposal-reviews requestBody: content: application/json: schema: $ref: '#/components/schemas/ProposalReviewRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ProposalReview' description: '' patch: operationId: proposal_reviews_partial_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - proposal-reviews requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedProposalReviewRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ProposalReview' description: '' delete: operationId: proposal_reviews_destroy parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - proposal-reviews security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '204': description: No response body /api/proposal-reviews/{uuid}/accept/: post: operationId: proposal_reviews_accept description: Accept a review, changing its state to IN_REVIEW. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - proposal-reviews security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/proposal-reviews/{uuid}/reject/: post: operationId: proposal_reviews_reject description: Reject a review, changing its state to REJECTED. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - proposal-reviews security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/proposal-reviews/{uuid}/submit/: post: operationId: proposal_reviews_submit description: Submit a review, changing its state to SUBMITTED. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - proposal-reviews requestBody: content: application/json: schema: $ref: '#/components/schemas/ReviewSubmitRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/provider-invoice-items/: get: operationId: provider_invoice_items_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: customer_uuid schema: type: string format: uuid - in: query name: invoice_month schema: type: integer - in: query name: invoice_year schema: type: integer - in: query name: o schema: type: array items: type: string enum: - -invoice_customer_name - -project_name - -resource_offering_name - -unit_price - invoice_customer_name - project_name - resource_offering_name - unit_price description: |+ Ordering explode: false style: form - in: query name: offering_uuid schema: type: string format: uuid - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: project_uuid schema: type: string format: uuid tags: - provider-invoice-items security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/InvoiceItem' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' head: operationId: provider_invoice_items_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: customer_uuid schema: type: string format: uuid - in: query name: invoice_month schema: type: integer - in: query name: invoice_year schema: type: integer - in: query name: o schema: type: array items: type: string enum: - -invoice_customer_name - -project_name - -resource_offering_name - -unit_price - invoice_customer_name - project_name - resource_offering_name - unit_price description: |+ Ordering explode: false style: form - in: query name: offering_uuid schema: type: string format: uuid - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: project_uuid schema: type: string format: uuid tags: - provider-invoice-items security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/provider-invoice-items/{id}/: get: operationId: provider_invoice_items_retrieve parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this invoice item. required: true tags: - provider-invoice-items security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/InvoiceItem' description: '' /api/public-maintenance-announcements/: get: operationId: public_maintenance_announcements_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: maintenance_type schema: type: integer - in: query name: o schema: type: array items: type: string enum: - -created - -name - -scheduled_end - -scheduled_start - created - name - scheduled_end - scheduled_start description: |+ Ordering explode: false style: form - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: scheduled_end_after schema: type: string format: date-time - in: query name: scheduled_end_before schema: type: string format: date-time - in: query name: scheduled_start_after schema: type: string format: date-time - in: query name: scheduled_start_before schema: type: string format: date-time - in: query name: service_provider_uuid schema: type: string format: uuid - in: query name: state schema: type: array items: type: string enum: - Cancelled - Completed - Draft - In progress - Scheduled explode: true style: form tags: - public-maintenance-announcements security: - tokenAuth: [] - waldurOIDCAuth: [] - {} responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/PublicMaintenanceAnnouncement' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' head: operationId: public_maintenance_announcements_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: maintenance_type schema: type: integer - in: query name: o schema: type: array items: type: string enum: - -created - -name - -scheduled_end - -scheduled_start - created - name - scheduled_end - scheduled_start description: |+ Ordering explode: false style: form - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: scheduled_end_after schema: type: string format: date-time - in: query name: scheduled_end_before schema: type: string format: date-time - in: query name: scheduled_start_after schema: type: string format: date-time - in: query name: scheduled_start_before schema: type: string format: date-time - in: query name: service_provider_uuid schema: type: string format: uuid - in: query name: state schema: type: array items: type: string enum: - Cancelled - Completed - Draft - In progress - Scheduled explode: true style: form tags: - public-maintenance-announcements security: - tokenAuth: [] - waldurOIDCAuth: [] - {} responses: '200': description: No response body /api/public-maintenance-announcements/{uuid}/: get: operationId: public_maintenance_announcements_retrieve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - public-maintenance-announcements security: - tokenAuth: [] - waldurOIDCAuth: [] - {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/PublicMaintenanceAnnouncement' description: '' /api/query/: post: operationId: query description: Execute SQL query against readonly database tags: - query requestBody: content: application/json: schema: $ref: '#/components/schemas/QueryRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: {} description: '' '400': description: No response body /api/rabbitmq-user-stats/: get: operationId: rabbitmq_user_stats_list parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - rabbitmq-user-stats security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/RmqUserStatsItem' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' /api/rabbitmq-vhost-stats/: get: operationId: rabbitmq_vhost_stats_list tags: - rabbitmq-vhost-stats security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/RmqVHostStatsItem' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' /api/rancher-apps/: get: operationId: rancher_apps_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: backend_id schema: type: string - in: query name: can_manage schema: type: boolean description: Can manage - in: query name: cluster_uuid schema: type: string format: uuid - in: query name: customer schema: type: string format: uuid - in: query name: customer_abbreviation schema: type: string - in: query name: customer_name schema: type: string - in: query name: customer_native_name schema: type: string - in: query name: customer_uuid schema: type: string format: uuid - in: query name: description schema: type: string - in: query name: external_ip schema: type: string - in: query name: field schema: type: array items: type: string enum: - access_url - answers - backend_id - catalog_name - created - customer - customer_abbreviation - customer_name - customer_native_name - description - error_message - error_traceback - external_url - is_limit_based - is_usage_based - marketplace_category_name - marketplace_category_uuid - marketplace_offering_name - marketplace_offering_plugin_options - marketplace_offering_uuid - marketplace_plan_uuid - marketplace_resource_state - marketplace_resource_uuid - modified - name - namespace - namespace_name - project - project_name - project_uuid - rancher_project - rancher_project_name - resource_type - runtime_state - service_name - service_settings - service_settings_error_message - service_settings_state - service_settings_uuid - state - template - template_name - url - uuid - version - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - in: query name: namespace_uuid schema: type: string format: uuid - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: project schema: type: string format: uuid - in: query name: project_name schema: type: string - in: query name: project_uuid schema: type: string format: uuid - in: query name: service_settings_name schema: type: string - in: query name: service_settings_uuid schema: type: string format: uuid - in: query name: state schema: type: array items: type: string enum: - CREATING - CREATION_SCHEDULED - DELETING - DELETION_SCHEDULED - ERRED - OK - UPDATE_SCHEDULED - UPDATING explode: true style: form - in: query name: template_uuid schema: type: string format: uuid - in: query name: uuid schema: type: string format: uuid tags: - rancher-apps security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/RancherApplication' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' post: operationId: rancher_apps_create tags: - rancher-apps requestBody: content: application/json: schema: $ref: '#/components/schemas/RancherApplicationRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/RancherApplication' description: '' head: operationId: rancher_apps_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: backend_id schema: type: string - in: query name: can_manage schema: type: boolean description: Can manage - in: query name: cluster_uuid schema: type: string format: uuid - in: query name: customer schema: type: string format: uuid - in: query name: customer_abbreviation schema: type: string - in: query name: customer_name schema: type: string - in: query name: customer_native_name schema: type: string - in: query name: customer_uuid schema: type: string format: uuid - in: query name: description schema: type: string - in: query name: external_ip schema: type: string - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - in: query name: namespace_uuid schema: type: string format: uuid - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: project schema: type: string format: uuid - in: query name: project_name schema: type: string - in: query name: project_uuid schema: type: string format: uuid - in: query name: service_settings_name schema: type: string - in: query name: service_settings_uuid schema: type: string format: uuid - in: query name: state schema: type: array items: type: string enum: - CREATING - CREATION_SCHEDULED - DELETING - DELETION_SCHEDULED - ERRED - OK - UPDATE_SCHEDULED - UPDATING explode: true style: form - in: query name: template_uuid schema: type: string format: uuid - in: query name: uuid schema: type: string format: uuid tags: - rancher-apps security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/rancher-apps/{uuid}/: get: operationId: rancher_apps_retrieve parameters: - in: query name: field schema: type: array items: type: string enum: - access_url - answers - backend_id - catalog_name - created - customer - customer_abbreviation - customer_name - customer_native_name - description - error_message - error_traceback - external_url - is_limit_based - is_usage_based - marketplace_category_name - marketplace_category_uuid - marketplace_offering_name - marketplace_offering_plugin_options - marketplace_offering_uuid - marketplace_plan_uuid - marketplace_resource_state - marketplace_resource_uuid - modified - name - namespace - namespace_name - project - project_name - project_uuid - rancher_project - rancher_project_name - resource_type - runtime_state - service_name - service_settings - service_settings_error_message - service_settings_state - service_settings_uuid - state - template - template_name - url - uuid - version - in: path name: uuid schema: type: string format: uuid required: true tags: - rancher-apps security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RancherApplication' description: '' put: operationId: rancher_apps_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - rancher-apps requestBody: content: application/json: schema: $ref: '#/components/schemas/RancherApplicationRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RancherApplication' description: '' patch: operationId: rancher_apps_partial_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - rancher-apps requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedRancherApplicationRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RancherApplication' description: '' delete: operationId: rancher_apps_destroy parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - rancher-apps security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '204': description: No response body /api/rancher-apps/{uuid}/pull/: post: operationId: rancher_apps_pull parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - rancher-apps security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/rancher-apps/{uuid}/unlink/: post: operationId: rancher_apps_unlink description: |- Delete resource from the database without scheduling operations on backend and without checking current state of the resource. It is intended to be used for removing resource stuck in transitioning state. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - rancher-apps security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/rancher-catalogs/: get: operationId: rancher_catalogs_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - rancher-catalogs security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/RancherCatalog' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' post: operationId: rancher_catalogs_create tags: - rancher-catalogs requestBody: content: application/json: schema: $ref: '#/components/schemas/RancherCatalogCreateRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/RancherCatalogCreate' description: '' head: operationId: rancher_catalogs_count description: Get number of items in the collection matching the request parameters. parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - rancher-catalogs security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/rancher-catalogs/{uuid}/: get: operationId: rancher_catalogs_retrieve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - rancher-catalogs security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RancherCatalog' description: '' put: operationId: rancher_catalogs_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - rancher-catalogs requestBody: content: application/json: schema: $ref: '#/components/schemas/RancherCatalogUpdateRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RancherCatalogUpdate' description: '' patch: operationId: rancher_catalogs_partial_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - rancher-catalogs requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedRancherCatalogRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RancherCatalog' description: '' delete: operationId: rancher_catalogs_destroy parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - rancher-catalogs security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '204': description: No response body /api/rancher-catalogs/{uuid}/refresh/: post: operationId: rancher_catalogs_refresh parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - rancher-catalogs requestBody: content: application/json: schema: $ref: '#/components/schemas/RancherCatalogRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RancherCatalog' description: '' /api/rancher-cluster-security-groups/: get: operationId: rancher_cluster_security_groups_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: cluster_uuid schema: type: string format: uuid - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - rancher-cluster-security-groups security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/ClusterSecurityGroup' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' head: operationId: rancher_cluster_security_groups_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: cluster_uuid schema: type: string format: uuid - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - rancher-cluster-security-groups security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/rancher-cluster-security-groups/{uuid}/: get: operationId: rancher_cluster_security_groups_retrieve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - rancher-cluster-security-groups security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ClusterSecurityGroup' description: '' put: operationId: rancher_cluster_security_groups_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - rancher-cluster-security-groups requestBody: content: application/json: schema: $ref: '#/components/schemas/ClusterSecurityGroupRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ClusterSecurityGroup' description: '' patch: operationId: rancher_cluster_security_groups_partial_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - rancher-cluster-security-groups requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedClusterSecurityGroupRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ClusterSecurityGroup' description: '' /api/rancher-cluster-templates/: get: operationId: rancher_cluster_templates_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - rancher-cluster-templates security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/RancherClusterTemplate' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' head: operationId: rancher_cluster_templates_count description: Get number of items in the collection matching the request parameters. parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - rancher-cluster-templates security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/rancher-cluster-templates/{uuid}/: get: operationId: rancher_cluster_templates_retrieve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - rancher-cluster-templates security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RancherClusterTemplate' description: '' /api/rancher-clusters/: get: operationId: rancher_clusters_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: backend_id schema: type: string - in: query name: can_manage schema: type: boolean description: Can manage - in: query name: customer schema: type: string format: uuid - in: query name: customer_abbreviation schema: type: string - in: query name: customer_name schema: type: string - in: query name: customer_native_name schema: type: string - in: query name: customer_uuid schema: type: string format: uuid - in: query name: description schema: type: string - in: query name: external_ip schema: type: string - in: query name: field schema: type: array items: type: string enum: - access_url - backend_id - capacity - created - customer - customer_abbreviation - customer_name - customer_native_name - description - error_message - error_traceback - install_longhorn - is_limit_based - is_usage_based - kubernetes_version - management_security_group - marketplace_category_name - marketplace_category_uuid - marketplace_offering_name - marketplace_offering_plugin_options - marketplace_offering_uuid - marketplace_plan_uuid - marketplace_resource_state - marketplace_resource_uuid - modified - name - nodes - project - project_name - project_uuid - public_ips - requested - resource_type - router_ips - runtime_state - security_groups - service_name - service_settings - service_settings_error_message - service_settings_state - service_settings_uuid - ssh_public_key - state - tenant - tenant_uuid - url - uuid - vm_project - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: project schema: type: string format: uuid - in: query name: project_name schema: type: string - in: query name: project_uuid schema: type: string format: uuid - in: query name: service_settings_name schema: type: string - in: query name: service_settings_uuid schema: type: string format: uuid - in: query name: state schema: type: array items: type: string enum: - CREATING - CREATION_SCHEDULED - DELETING - DELETION_SCHEDULED - ERRED - OK - UPDATE_SCHEDULED - UPDATING explode: true style: form - in: query name: uuid schema: type: string format: uuid tags: - rancher-clusters security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/RancherCluster' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' post: operationId: rancher_clusters_create tags: - rancher-clusters requestBody: content: application/json: schema: $ref: '#/components/schemas/RancherClusterRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/RancherCluster' description: '' head: operationId: rancher_clusters_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: backend_id schema: type: string - in: query name: can_manage schema: type: boolean description: Can manage - in: query name: customer schema: type: string format: uuid - in: query name: customer_abbreviation schema: type: string - in: query name: customer_name schema: type: string - in: query name: customer_native_name schema: type: string - in: query name: customer_uuid schema: type: string format: uuid - in: query name: description schema: type: string - in: query name: external_ip schema: type: string - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: project schema: type: string format: uuid - in: query name: project_name schema: type: string - in: query name: project_uuid schema: type: string format: uuid - in: query name: service_settings_name schema: type: string - in: query name: service_settings_uuid schema: type: string format: uuid - in: query name: state schema: type: array items: type: string enum: - CREATING - CREATION_SCHEDULED - DELETING - DELETION_SCHEDULED - ERRED - OK - UPDATE_SCHEDULED - UPDATING explode: true style: form - in: query name: uuid schema: type: string format: uuid tags: - rancher-clusters security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/rancher-clusters/{uuid}/: get: operationId: rancher_clusters_retrieve parameters: - in: query name: field schema: type: array items: type: string enum: - access_url - backend_id - capacity - created - customer - customer_abbreviation - customer_name - customer_native_name - description - error_message - error_traceback - install_longhorn - is_limit_based - is_usage_based - kubernetes_version - management_security_group - marketplace_category_name - marketplace_category_uuid - marketplace_offering_name - marketplace_offering_plugin_options - marketplace_offering_uuid - marketplace_plan_uuid - marketplace_resource_state - marketplace_resource_uuid - modified - name - nodes - project - project_name - project_uuid - public_ips - requested - resource_type - router_ips - runtime_state - security_groups - service_name - service_settings - service_settings_error_message - service_settings_state - service_settings_uuid - ssh_public_key - state - tenant - tenant_uuid - url - uuid - vm_project - in: path name: uuid schema: type: string format: uuid required: true tags: - rancher-clusters security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RancherCluster' description: '' put: operationId: rancher_clusters_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - rancher-clusters requestBody: content: application/json: schema: $ref: '#/components/schemas/RancherClusterRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RancherCluster' description: '' patch: operationId: rancher_clusters_partial_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - rancher-clusters requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedRancherClusterRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RancherCluster' description: '' delete: operationId: rancher_clusters_destroy parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - rancher-clusters security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '204': description: No response body /api/rancher-clusters/{uuid}/create_management_security_group/: post: operationId: rancher_clusters_create_management_security_group parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - rancher-clusters requestBody: content: application/json: schema: $ref: '#/components/schemas/RancherClusterRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RancherCluster' description: '' /api/rancher-clusters/{uuid}/import_yaml/: post: operationId: rancher_clusters_import_yaml parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - rancher-clusters requestBody: content: application/json: schema: $ref: '#/components/schemas/RancherImportYamlRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RancherImportYaml' description: '' /api/rancher-clusters/{uuid}/pull/: post: operationId: rancher_clusters_pull parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - rancher-clusters security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/rancher-clusters/{uuid}/unlink/: post: operationId: rancher_clusters_unlink description: |- Delete resource from the database without scheduling operations on backend and without checking current state of the resource. It is intended to be used for removing resource stuck in transitioning state. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - rancher-clusters security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/rancher-hpas/: get: operationId: rancher_hpas_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: cluster_uuid schema: type: string format: uuid - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - in: query name: namespace_uuid schema: type: string format: uuid - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: project_uuid schema: type: string format: uuid - in: query name: settings schema: type: string - in: query name: settings_uuid schema: type: string format: uuid - in: query name: workload_uuid schema: type: string format: uuid tags: - rancher-hpas security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/RancherHPA' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' post: operationId: rancher_hpas_create tags: - rancher-hpas requestBody: content: application/json: schema: $ref: '#/components/schemas/RancherHPARequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/RancherHPA' description: '' head: operationId: rancher_hpas_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: cluster_uuid schema: type: string format: uuid - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - in: query name: namespace_uuid schema: type: string format: uuid - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: project_uuid schema: type: string format: uuid - in: query name: settings schema: type: string - in: query name: settings_uuid schema: type: string format: uuid - in: query name: workload_uuid schema: type: string format: uuid tags: - rancher-hpas security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/rancher-hpas/{uuid}/: get: operationId: rancher_hpas_retrieve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - rancher-hpas security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RancherHPA' description: '' put: operationId: rancher_hpas_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - rancher-hpas requestBody: content: application/json: schema: $ref: '#/components/schemas/RancherHPARequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RancherHPA' description: '' patch: operationId: rancher_hpas_partial_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - rancher-hpas requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedRancherHPARequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RancherHPA' description: '' delete: operationId: rancher_hpas_destroy parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - rancher-hpas security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '204': description: No response body /api/rancher-hpas/{uuid}/pull/: post: operationId: rancher_hpas_pull parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - rancher-hpas security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/rancher-hpas/{uuid}/unlink/: post: operationId: rancher_hpas_unlink description: |- Delete resource from the database without scheduling operations on backend and without checking current state of the resource. It is intended to be used for removing resource stuck in transitioning state. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - rancher-hpas security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/rancher-hpas/{uuid}/yaml/: get: operationId: rancher_hpas_yaml_retrieve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - rancher-hpas security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RancherHPA' description: '' put: operationId: rancher_hpas_yaml_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - rancher-hpas requestBody: content: application/json: schema: $ref: '#/components/schemas/RancherHPARequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RancherHPA' description: '' /api/rancher-ingresses/: get: operationId: rancher_ingresses_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: backend_id schema: type: string - in: query name: can_manage schema: type: boolean description: Can manage - in: query name: cluster_uuid schema: type: string format: uuid - in: query name: customer schema: type: string format: uuid - in: query name: customer_abbreviation schema: type: string - in: query name: customer_name schema: type: string - in: query name: customer_native_name schema: type: string - in: query name: customer_uuid schema: type: string format: uuid - in: query name: description schema: type: string - in: query name: external_ip schema: type: string - in: query name: field schema: type: array items: type: string enum: - access_url - backend_id - created - customer - customer_abbreviation - customer_name - customer_native_name - description - error_message - error_traceback - is_limit_based - is_usage_based - marketplace_category_name - marketplace_category_uuid - marketplace_offering_name - marketplace_offering_plugin_options - marketplace_offering_uuid - marketplace_plan_uuid - marketplace_resource_state - marketplace_resource_uuid - modified - name - namespace - namespace_name - project - project_name - project_uuid - rancher_project - rancher_project_name - resource_type - rules - runtime_state - service_name - service_settings - service_settings_error_message - service_settings_state - service_settings_uuid - state - url - uuid - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - in: query name: namespace_uuid schema: type: string format: uuid - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: project schema: type: string format: uuid - in: query name: project_name schema: type: string - in: query name: project_uuid schema: type: string format: uuid - in: query name: rancher_project_uuid schema: type: string format: uuid - in: query name: service_settings_name schema: type: string - in: query name: service_settings_uuid schema: type: string format: uuid - in: query name: state schema: type: array items: type: string enum: - CREATING - CREATION_SCHEDULED - DELETING - DELETION_SCHEDULED - ERRED - OK - UPDATE_SCHEDULED - UPDATING explode: true style: form - in: query name: uuid schema: type: string format: uuid tags: - rancher-ingresses security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/RancherIngress' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' post: operationId: rancher_ingresses_create tags: - rancher-ingresses requestBody: content: application/json: schema: $ref: '#/components/schemas/RancherIngressRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/RancherIngress' description: '' head: operationId: rancher_ingresses_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: backend_id schema: type: string - in: query name: can_manage schema: type: boolean description: Can manage - in: query name: cluster_uuid schema: type: string format: uuid - in: query name: customer schema: type: string format: uuid - in: query name: customer_abbreviation schema: type: string - in: query name: customer_name schema: type: string - in: query name: customer_native_name schema: type: string - in: query name: customer_uuid schema: type: string format: uuid - in: query name: description schema: type: string - in: query name: external_ip schema: type: string - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - in: query name: namespace_uuid schema: type: string format: uuid - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: project schema: type: string format: uuid - in: query name: project_name schema: type: string - in: query name: project_uuid schema: type: string format: uuid - in: query name: rancher_project_uuid schema: type: string format: uuid - in: query name: service_settings_name schema: type: string - in: query name: service_settings_uuid schema: type: string format: uuid - in: query name: state schema: type: array items: type: string enum: - CREATING - CREATION_SCHEDULED - DELETING - DELETION_SCHEDULED - ERRED - OK - UPDATE_SCHEDULED - UPDATING explode: true style: form - in: query name: uuid schema: type: string format: uuid tags: - rancher-ingresses security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/rancher-ingresses/{uuid}/: get: operationId: rancher_ingresses_retrieve parameters: - in: query name: field schema: type: array items: type: string enum: - access_url - backend_id - created - customer - customer_abbreviation - customer_name - customer_native_name - description - error_message - error_traceback - is_limit_based - is_usage_based - marketplace_category_name - marketplace_category_uuid - marketplace_offering_name - marketplace_offering_plugin_options - marketplace_offering_uuid - marketplace_plan_uuid - marketplace_resource_state - marketplace_resource_uuid - modified - name - namespace - namespace_name - project - project_name - project_uuid - rancher_project - rancher_project_name - resource_type - rules - runtime_state - service_name - service_settings - service_settings_error_message - service_settings_state - service_settings_uuid - state - url - uuid - in: path name: uuid schema: type: string format: uuid required: true tags: - rancher-ingresses security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RancherIngress' description: '' put: operationId: rancher_ingresses_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - rancher-ingresses requestBody: content: application/json: schema: $ref: '#/components/schemas/RancherIngressRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RancherIngress' description: '' patch: operationId: rancher_ingresses_partial_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - rancher-ingresses requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedRancherIngressRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RancherIngress' description: '' delete: operationId: rancher_ingresses_destroy parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - rancher-ingresses security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '204': description: No response body /api/rancher-ingresses/{uuid}/pull/: post: operationId: rancher_ingresses_pull parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - rancher-ingresses security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/rancher-ingresses/{uuid}/unlink/: post: operationId: rancher_ingresses_unlink description: |- Delete resource from the database without scheduling operations on backend and without checking current state of the resource. It is intended to be used for removing resource stuck in transitioning state. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - rancher-ingresses security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/rancher-ingresses/{uuid}/yaml/: get: operationId: rancher_ingresses_yaml_retrieve parameters: - in: query name: field schema: type: array items: type: string enum: - access_url - backend_id - created - customer - customer_abbreviation - customer_name - customer_native_name - description - error_message - error_traceback - is_limit_based - is_usage_based - marketplace_category_name - marketplace_category_uuid - marketplace_offering_name - marketplace_offering_plugin_options - marketplace_offering_uuid - marketplace_plan_uuid - marketplace_resource_state - marketplace_resource_uuid - modified - name - namespace - namespace_name - project - project_name - project_uuid - rancher_project - rancher_project_name - resource_type - rules - runtime_state - service_name - service_settings - service_settings_error_message - service_settings_state - service_settings_uuid - state - url - uuid - in: path name: uuid schema: type: string format: uuid required: true tags: - rancher-ingresses security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RancherIngress' description: '' put: operationId: rancher_ingresses_yaml_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - rancher-ingresses requestBody: content: application/json: schema: $ref: '#/components/schemas/RancherIngressRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RancherIngress' description: '' /api/rancher-namespaces/: get: operationId: rancher_namespaces_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: cluster_uuid schema: type: string format: uuid - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - in: query name: o schema: type: array items: type: string enum: - -cluster_name - -name - -project_name - cluster_name - name - project_name description: |+ Ordering explode: false style: form - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: project_uuid schema: type: string format: uuid - in: query name: settings schema: type: string - in: query name: settings_uuid schema: type: string format: uuid tags: - rancher-namespaces security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/RancherNamespace' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' head: operationId: rancher_namespaces_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: cluster_uuid schema: type: string format: uuid - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - in: query name: o schema: type: array items: type: string enum: - -cluster_name - -name - -project_name - cluster_name - name - project_name description: |+ Ordering explode: false style: form - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: project_uuid schema: type: string format: uuid - in: query name: settings schema: type: string - in: query name: settings_uuid schema: type: string format: uuid tags: - rancher-namespaces security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/rancher-namespaces/{uuid}/: get: operationId: rancher_namespaces_retrieve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - rancher-namespaces security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RancherNamespace' description: '' /api/rancher-nodes/: get: operationId: rancher_nodes_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: cluster_uuid schema: type: string format: uuid - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - rancher-nodes security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/RancherNode' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' post: operationId: rancher_nodes_create tags: - rancher-nodes requestBody: content: application/json: schema: $ref: '#/components/schemas/RancherCreateNodeRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/RancherCreateNode' description: '' head: operationId: rancher_nodes_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: cluster_uuid schema: type: string format: uuid - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - rancher-nodes security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/rancher-nodes/{uuid}/: get: operationId: rancher_nodes_retrieve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - rancher-nodes security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RancherNode' description: '' delete: operationId: rancher_nodes_destroy parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - rancher-nodes security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '204': description: No response body /api/rancher-nodes/{uuid}/console/: get: operationId: rancher_nodes_console_retrieve description: Returns console URL for the node. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - rancher-nodes security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ConsoleUrl' description: '' /api/rancher-nodes/{uuid}/console_log/: get: operationId: rancher_nodes_console_log_retrieve description: Returns console log for the node. parameters: - in: query name: length schema: type: integer - in: path name: uuid schema: type: string format: uuid required: true tags: - rancher-nodes security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: string description: '' '404': description: No response body /api/rancher-nodes/{uuid}/link_openstack/: post: operationId: rancher_nodes_link_openstack description: Links node to OpenStack instance. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - rancher-nodes requestBody: content: application/json: schema: $ref: '#/components/schemas/LinkOpenstackRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/rancher-nodes/{uuid}/pull/: post: operationId: rancher_nodes_pull parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - rancher-nodes security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/rancher-nodes/{uuid}/unlink/: post: operationId: rancher_nodes_unlink description: |- Delete resource from the database without scheduling operations on backend and without checking current state of the resource. It is intended to be used for removing resource stuck in transitioning state. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - rancher-nodes security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/rancher-nodes/{uuid}/unlink_openstack/: post: operationId: rancher_nodes_unlink_openstack description: Unlinks node from OpenStack instance. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - rancher-nodes security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/rancher-projects/: get: operationId: rancher_projects_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: cluster_uuid schema: type: string format: uuid - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: settings schema: type: string - in: query name: settings_uuid schema: type: string format: uuid tags: - rancher-projects security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/RancherProject' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' head: operationId: rancher_projects_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: cluster_uuid schema: type: string format: uuid - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: settings schema: type: string - in: query name: settings_uuid schema: type: string format: uuid tags: - rancher-projects security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/rancher-projects/{uuid}/: get: operationId: rancher_projects_retrieve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - rancher-projects security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RancherProject' description: '' /api/rancher-projects/{uuid}/secrets/: get: operationId: rancher_projects_secrets_retrieve description: Returns project's secrets. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - rancher-projects security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RancherProject' description: '' /api/rancher-role-templates/: get: operationId: rancher_role_templates_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: name schema: type: string - in: query name: o schema: type: array items: type: string enum: - -name - -scope_type - name - scope_type description: |+ Ordering explode: false style: form - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: scope_type schema: type: string - in: query name: settings_uuid schema: type: string format: uuid tags: - rancher-role-templates security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/RoleTemplate' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' head: operationId: rancher_role_templates_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: name schema: type: string - in: query name: o schema: type: array items: type: string enum: - -name - -scope_type - name - scope_type description: |+ Ordering explode: false style: form - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: scope_type schema: type: string - in: query name: settings_uuid schema: type: string format: uuid tags: - rancher-role-templates security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/rancher-role-templates/{uuid}/: get: operationId: rancher_role_templates_retrieve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - rancher-role-templates security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RoleTemplate' description: '' /api/rancher-services/: get: operationId: rancher_services_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: backend_id schema: type: string - in: query name: can_manage schema: type: boolean description: Can manage - in: query name: cluster_uuid schema: type: string format: uuid - in: query name: customer schema: type: string format: uuid - in: query name: customer_abbreviation schema: type: string - in: query name: customer_name schema: type: string - in: query name: customer_native_name schema: type: string - in: query name: customer_uuid schema: type: string format: uuid - in: query name: description schema: type: string - in: query name: external_ip schema: type: string - in: query name: field schema: type: array items: type: string enum: - access_url - backend_id - cluster_ip - created - customer - customer_abbreviation - customer_name - customer_native_name - description - error_message - error_traceback - is_limit_based - is_usage_based - marketplace_category_name - marketplace_category_uuid - marketplace_offering_name - marketplace_offering_plugin_options - marketplace_offering_uuid - marketplace_plan_uuid - marketplace_resource_state - marketplace_resource_uuid - modified - name - namespace - namespace_name - project - project_name - project_uuid - resource_type - runtime_state - selector - service_name - service_settings - service_settings_error_message - service_settings_state - service_settings_uuid - state - target_workloads - url - uuid - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - in: query name: namespace_uuid schema: type: string format: uuid - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: project schema: type: string format: uuid - in: query name: project_name schema: type: string - in: query name: project_uuid schema: type: string format: uuid - in: query name: rancher_project_uuid schema: type: string format: uuid - in: query name: service_settings_name schema: type: string - in: query name: service_settings_uuid schema: type: string format: uuid - in: query name: state schema: type: array items: type: string enum: - CREATING - CREATION_SCHEDULED - DELETING - DELETION_SCHEDULED - ERRED - OK - UPDATE_SCHEDULED - UPDATING explode: true style: form - in: query name: uuid schema: type: string format: uuid tags: - rancher-services security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/RancherService' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' post: operationId: rancher_services_create tags: - rancher-services requestBody: content: application/json: schema: $ref: '#/components/schemas/RancherServiceRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/RancherService' description: '' head: operationId: rancher_services_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: backend_id schema: type: string - in: query name: can_manage schema: type: boolean description: Can manage - in: query name: cluster_uuid schema: type: string format: uuid - in: query name: customer schema: type: string format: uuid - in: query name: customer_abbreviation schema: type: string - in: query name: customer_name schema: type: string - in: query name: customer_native_name schema: type: string - in: query name: customer_uuid schema: type: string format: uuid - in: query name: description schema: type: string - in: query name: external_ip schema: type: string - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - in: query name: namespace_uuid schema: type: string format: uuid - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: project schema: type: string format: uuid - in: query name: project_name schema: type: string - in: query name: project_uuid schema: type: string format: uuid - in: query name: rancher_project_uuid schema: type: string format: uuid - in: query name: service_settings_name schema: type: string - in: query name: service_settings_uuid schema: type: string format: uuid - in: query name: state schema: type: array items: type: string enum: - CREATING - CREATION_SCHEDULED - DELETING - DELETION_SCHEDULED - ERRED - OK - UPDATE_SCHEDULED - UPDATING explode: true style: form - in: query name: uuid schema: type: string format: uuid tags: - rancher-services security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/rancher-services/{uuid}/: get: operationId: rancher_services_retrieve parameters: - in: query name: field schema: type: array items: type: string enum: - access_url - backend_id - cluster_ip - created - customer - customer_abbreviation - customer_name - customer_native_name - description - error_message - error_traceback - is_limit_based - is_usage_based - marketplace_category_name - marketplace_category_uuid - marketplace_offering_name - marketplace_offering_plugin_options - marketplace_offering_uuid - marketplace_plan_uuid - marketplace_resource_state - marketplace_resource_uuid - modified - name - namespace - namespace_name - project - project_name - project_uuid - resource_type - runtime_state - selector - service_name - service_settings - service_settings_error_message - service_settings_state - service_settings_uuid - state - target_workloads - url - uuid - in: path name: uuid schema: type: string format: uuid required: true tags: - rancher-services security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RancherService' description: '' put: operationId: rancher_services_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - rancher-services requestBody: content: application/json: schema: $ref: '#/components/schemas/RancherServiceRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RancherService' description: '' patch: operationId: rancher_services_partial_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - rancher-services requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedRancherServiceRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RancherService' description: '' delete: operationId: rancher_services_destroy parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - rancher-services security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '204': description: No response body /api/rancher-services/{uuid}/pull/: post: operationId: rancher_services_pull parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - rancher-services security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/rancher-services/{uuid}/unlink/: post: operationId: rancher_services_unlink description: |- Delete resource from the database without scheduling operations on backend and without checking current state of the resource. It is intended to be used for removing resource stuck in transitioning state. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - rancher-services security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/rancher-services/{uuid}/yaml/: get: operationId: rancher_services_yaml_retrieve parameters: - in: query name: field schema: type: array items: type: string enum: - access_url - backend_id - cluster_ip - created - customer - customer_abbreviation - customer_name - customer_native_name - description - error_message - error_traceback - is_limit_based - is_usage_based - marketplace_category_name - marketplace_category_uuid - marketplace_offering_name - marketplace_offering_plugin_options - marketplace_offering_uuid - marketplace_plan_uuid - marketplace_resource_state - marketplace_resource_uuid - modified - name - namespace - namespace_name - project - project_name - project_uuid - resource_type - runtime_state - selector - service_name - service_settings - service_settings_error_message - service_settings_state - service_settings_uuid - state - target_workloads - url - uuid - in: path name: uuid schema: type: string format: uuid required: true tags: - rancher-services security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RancherService' description: '' put: operationId: rancher_services_yaml_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - rancher-services requestBody: content: application/json: schema: $ref: '#/components/schemas/RancherServiceRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RancherService' description: '' /api/rancher-template-versions/{template_uuid}/{version}/: get: operationId: rancher_template_versions_retrieve parameters: - in: path name: template_uuid schema: type: string pattern: ^[a-f0-9]+$ required: true - in: path name: version schema: type: string pattern: ^[0-9.]+$ required: true tags: - rancher-template-versions security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/TemplateVersion' description: '' /api/rancher-templates/: get: operationId: rancher_templates_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: catalog_uuid schema: type: string format: uuid - in: query name: cluster_uuid schema: type: string format: uuid - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - in: query name: o schema: type: array items: type: string enum: - -catalog_name - -name - catalog_name - name description: |+ Ordering explode: false style: form - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: project_uuid schema: type: string format: uuid - in: query name: settings schema: type: string - in: query name: settings_uuid schema: type: string format: uuid tags: - rancher-templates security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/RancherTemplate' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' head: operationId: rancher_templates_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: catalog_uuid schema: type: string format: uuid - in: query name: cluster_uuid schema: type: string format: uuid - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - in: query name: o schema: type: array items: type: string enum: - -catalog_name - -name - catalog_name - name description: |+ Ordering explode: false style: form - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: project_uuid schema: type: string format: uuid - in: query name: settings schema: type: string - in: query name: settings_uuid schema: type: string format: uuid tags: - rancher-templates security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/rancher-templates/{uuid}/: get: operationId: rancher_templates_retrieve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - rancher-templates security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RancherTemplate' description: '' /api/rancher-users/: get: operationId: rancher_users_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: cluster_uuid schema: type: string format: uuid description: Cluster UUID - in: query name: is_active schema: type: boolean - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: settings_uuid schema: type: string format: uuid - in: query name: user_full_name schema: type: string description: User full name contains - in: query name: user_username schema: type: string - in: query name: user_uuid schema: type: string format: uuid tags: - rancher-users security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/RancherUser' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' head: operationId: rancher_users_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: cluster_uuid schema: type: string format: uuid description: Cluster UUID - in: query name: is_active schema: type: boolean - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: settings_uuid schema: type: string format: uuid - in: query name: user_full_name schema: type: string description: User full name contains - in: query name: user_username schema: type: string - in: query name: user_uuid schema: type: string format: uuid tags: - rancher-users security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/rancher-users/{uuid}/: get: operationId: rancher_users_retrieve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - rancher-users security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RancherUser' description: '' /api/rancher-workloads/: get: operationId: rancher_workloads_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: cluster_uuid schema: type: string format: uuid - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - in: query name: namespace_uuid schema: type: string format: uuid - in: query name: o schema: type: array items: type: string enum: - -cluster_name - -name - -namespace_name - -project_name - cluster_name - name - namespace_name - project_name description: |+ Ordering explode: false style: form - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: project_uuid schema: type: string format: uuid - in: query name: settings schema: type: string - in: query name: settings_uuid schema: type: string format: uuid tags: - rancher-workloads security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/RancherWorkload' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' post: operationId: rancher_workloads_create tags: - rancher-workloads requestBody: content: application/json: schema: $ref: '#/components/schemas/RancherWorkloadRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/RancherWorkload' description: '' head: operationId: rancher_workloads_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: cluster_uuid schema: type: string format: uuid - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - in: query name: namespace_uuid schema: type: string format: uuid - in: query name: o schema: type: array items: type: string enum: - -cluster_name - -name - -namespace_name - -project_name - cluster_name - name - namespace_name - project_name description: |+ Ordering explode: false style: form - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: project_uuid schema: type: string format: uuid - in: query name: settings schema: type: string - in: query name: settings_uuid schema: type: string format: uuid tags: - rancher-workloads security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/rancher-workloads/{uuid}/: get: operationId: rancher_workloads_retrieve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - rancher-workloads security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RancherWorkload' description: '' put: operationId: rancher_workloads_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - rancher-workloads requestBody: content: application/json: schema: $ref: '#/components/schemas/RancherWorkloadRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RancherWorkload' description: '' patch: operationId: rancher_workloads_partial_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - rancher-workloads requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedRancherWorkloadRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RancherWorkload' description: '' delete: operationId: rancher_workloads_destroy parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - rancher-workloads security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '204': description: No response body /api/rancher-workloads/{uuid}/redeploy/: post: operationId: rancher_workloads_redeploy parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - rancher-workloads security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/rancher-workloads/{uuid}/yaml/: get: operationId: rancher_workloads_yaml_retrieve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - rancher-workloads security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RancherWorkload' description: '' put: operationId: rancher_workloads_yaml_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - rancher-workloads requestBody: content: application/json: schema: $ref: '#/components/schemas/RancherWorkloadRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RancherWorkload' description: '' /api/remote-eduteams/: post: operationId: remote_eduteams description: Allows to pull user details from remote eduTEAMS instance. tags: - remote-eduteams requestBody: content: application/json: schema: $ref: '#/components/schemas/RemoteEduteamsRequestRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RemoteEduteamsUUID' description: '' /api/remote-waldur-api/cancel_termination/{uuid}: post: operationId: remote_waldur_api_cancel_termination description: Cancel termination order parameters: - in: path name: uuid schema: type: string pattern: ^[a-f0-9]+$ required: true tags: - remote-waldur-api security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/remote-waldur-api/import_offering/: post: operationId: remote_waldur_api_import_offering description: Create local offering from remote tags: - remote-waldur-api requestBody: content: application/json: schema: $ref: '#/components/schemas/RemoteOfferingCreateRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RemoteOfferingCreateResponse' description: '' /api/remote-waldur-api/pull_offering_details/{uuid}/: post: operationId: remote_waldur_api_pull_offering_details parameters: - in: path name: uuid schema: type: string pattern: ^[a-f0-9]+$ required: true tags: - remote-waldur-api security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/remote-waldur-api/pull_offering_invoices/{uuid}/: post: operationId: remote_waldur_api_pull_offering_invoices parameters: - in: path name: uuid schema: type: string pattern: ^[a-f0-9]+$ required: true tags: - remote-waldur-api security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/remote-waldur-api/pull_offering_orders/{uuid}/: post: operationId: remote_waldur_api_pull_offering_orders parameters: - in: path name: uuid schema: type: string pattern: ^[a-f0-9]+$ required: true tags: - remote-waldur-api security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/remote-waldur-api/pull_offering_resources/{uuid}/: post: operationId: remote_waldur_api_pull_offering_resources parameters: - in: path name: uuid schema: type: string pattern: ^[a-f0-9]+$ required: true tags: - remote-waldur-api security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/remote-waldur-api/pull_offering_robot_accounts/{uuid}/: post: operationId: remote_waldur_api_pull_offering_robot_accounts parameters: - in: path name: uuid schema: type: string pattern: ^[a-f0-9]+$ required: true tags: - remote-waldur-api security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/remote-waldur-api/pull_offering_usage/{uuid}/: post: operationId: remote_waldur_api_pull_offering_usage parameters: - in: path name: uuid schema: type: string pattern: ^[a-f0-9]+$ required: true tags: - remote-waldur-api security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/remote-waldur-api/pull_offering_users/{uuid}/: post: operationId: remote_waldur_api_pull_offering_users parameters: - in: path name: uuid schema: type: string pattern: ^[a-f0-9]+$ required: true tags: - remote-waldur-api security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/remote-waldur-api/pull_order/{uuid}: post: operationId: remote_waldur_api_pull_order description: Schedule order pull task parameters: - in: path name: uuid schema: type: string pattern: ^[a-f0-9]+$ required: true tags: - remote-waldur-api security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/remote-waldur-api/push_project_data/{uuid}/: post: operationId: remote_waldur_api_push_project_data parameters: - in: path name: uuid schema: type: string pattern: ^[a-f0-9]+$ required: true tags: - remote-waldur-api security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/remote-waldur-api/remote_categories/: post: operationId: remote_waldur_api_remote_categories description: List remote marketplace categories parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - remote-waldur-api requestBody: content: application/json: schema: $ref: '#/components/schemas/RemoteCredentialsRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/MarketplaceCategory' description: '' description: '' /api/remote-waldur-api/remote_customers/: post: operationId: remote_waldur_api_remote_customers description: List remote customers owned by current user parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - remote-waldur-api requestBody: content: application/json: schema: $ref: '#/components/schemas/RemoteCredentialsRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/RemoteCustomer' description: '' description: '' /api/remote-waldur-api/remote_resource_order_status/{resource_uuid}/: get: operationId: remote_waldur_api_remote_resource_order_status_retrieve description: Get remote order details parameters: - in: path name: resource_uuid schema: type: string pattern: ^[a-f0-9]+$ required: true tags: - remote-waldur-api security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RemoteResourceOrder' description: '' /api/remote-waldur-api/remote_resource_status/{resource_uuid}/: get: operationId: remote_waldur_api_remote_resource_status_retrieve description: Get remote resource sync status parameters: - in: path name: resource_uuid schema: type: string pattern: ^[a-f0-9]+$ required: true tags: - remote-waldur-api security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RemoteResourceSyncStatus' description: '' /api/remote-waldur-api/remote_resource_team_status/{resource_uuid}/: get: operationId: remote_waldur_api_remote_resource_team_status_list description: Get remote resource team members parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: path name: resource_uuid schema: type: string pattern: ^[a-f0-9]+$ required: true tags: - remote-waldur-api security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/RemoteResourceTeamMember' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' /api/remote-waldur-api/shared_offerings/: post: operationId: remote_waldur_api_shared_offerings description: List remote importable offerings for particular customer parameters: - in: query name: customer_uuid schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - remote-waldur-api requestBody: content: application/json: schema: $ref: '#/components/schemas/RemoteCredentialsRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/RemoteOffering' description: '' description: '' /api/remote-waldur-api/sync_resource/{uuid}/: post: operationId: remote_waldur_api_sync_resource parameters: - in: path name: uuid schema: type: string pattern: ^[a-f0-9]+$ required: true tags: - remote-waldur-api security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/remote-waldur-api/sync_resource_project_permissions/{uuid}/: post: operationId: remote_waldur_api_sync_resource_project_permissions parameters: - in: path name: uuid schema: type: string pattern: ^[a-f0-9]+$ required: true tags: - remote-waldur-api security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/roles/: get: operationId: roles_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: description schema: type: string - in: query name: field schema: type: array items: type: string enum: - content_type - description - description_ar - description_cs - description_da - description_de - description_en - description_es - description_et - description_fr - description_it - description_lt - description_lv - description_nb - description_ru - description_sv - is_active - is_system_role - name - permissions - users_count - uuid - in: query name: is_active schema: type: boolean - in: query name: name schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - roles security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/RoleDetails' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' post: operationId: roles_create tags: - roles requestBody: content: application/json: schema: $ref: '#/components/schemas/RoleModifyRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/RoleDetails' description: '' head: operationId: roles_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: description schema: type: string - in: query name: is_active schema: type: boolean - in: query name: name schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - roles security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/roles/{uuid}/: get: operationId: roles_retrieve parameters: - in: query name: field schema: type: array items: type: string enum: - content_type - description - description_ar - description_cs - description_da - description_de - description_en - description_es - description_et - description_fr - description_it - description_lt - description_lv - description_nb - description_ru - description_sv - is_active - is_system_role - name - permissions - users_count - uuid - in: path name: uuid schema: type: string format: uuid required: true tags: - roles security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RoleDetails' description: '' put: operationId: roles_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - roles requestBody: content: application/json: schema: $ref: '#/components/schemas/RoleModifyRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RoleDetails' description: '' patch: operationId: roles_partial_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - roles requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedRoleDetailsRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RoleDetails' description: '' delete: operationId: roles_destroy parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - roles security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '204': description: No response body /api/roles/{uuid}/disable/: post: operationId: roles_disable parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - roles security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/roles/{uuid}/enable/: post: operationId: roles_enable parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - roles security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/roles/{uuid}/update_descriptions/: put: operationId: roles_update_descriptions_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - roles requestBody: content: application/json: schema: $ref: '#/components/schemas/RoleDescriptionRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RoleDescription' description: '' /api/service-settings/: get: operationId: service_settings_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: customer schema: type: string format: uuid - in: query name: customer_uuid schema: type: string format: uuid - in: query name: field schema: type: array items: type: string enum: - customer - customer_name - customer_native_name - error_message - name - options - scope - scope_uuid - shared - state - terms_of_services - type - url - uuid - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - name: o required: false in: query description: Which field to use when ordering the results. schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: scope_uuid schema: type: string description: Scope UUID - in: query name: shared schema: type: boolean - in: query name: state schema: type: array items: type: string enum: - CREATING - CREATION_SCHEDULED - DELETING - DELETION_SCHEDULED - ERRED - OK - UPDATE_SCHEDULED - UPDATING explode: true style: form - in: query name: type schema: type: string tags: - service-settings security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/ServiceSettings' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' head: operationId: service_settings_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: customer schema: type: string format: uuid - in: query name: customer_uuid schema: type: string format: uuid - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - name: o required: false in: query description: Which field to use when ordering the results. schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: scope_uuid schema: type: string description: Scope UUID - in: query name: shared schema: type: boolean - in: query name: state schema: type: array items: type: string enum: - CREATING - CREATION_SCHEDULED - DELETING - DELETION_SCHEDULED - ERRED - OK - UPDATE_SCHEDULED - UPDATING explode: true style: form - in: query name: type schema: type: string tags: - service-settings security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/service-settings/{uuid}/: get: operationId: service_settings_retrieve parameters: - in: query name: field schema: type: array items: type: string enum: - customer - customer_name - customer_native_name - error_message - name - options - scope - scope_uuid - shared - state - terms_of_services - type - url - uuid - in: path name: uuid schema: type: string format: uuid required: true tags: - service-settings security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ServiceSettings' description: '' /api/slurm-allocation-user-usage/: get: operationId: slurm_allocation_user_usage_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: allocation schema: type: string - in: query name: allocation_uuid schema: type: string format: uuid - in: query name: month schema: type: integer - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: user schema: type: string - in: query name: user_uuid schema: type: string format: uuid - in: query name: year schema: type: integer tags: - slurm-allocation-user-usage security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/SlurmAllocationUserUsage' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' head: operationId: slurm_allocation_user_usage_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: allocation schema: type: string - in: query name: allocation_uuid schema: type: string format: uuid - in: query name: month schema: type: integer - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: user schema: type: string - in: query name: user_uuid schema: type: string format: uuid - in: query name: year schema: type: integer tags: - slurm-allocation-user-usage security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/slurm-allocation-user-usage/{id}/: get: operationId: slurm_allocation_user_usage_retrieve parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this allocation user usage. required: true tags: - slurm-allocation-user-usage security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/SlurmAllocationUserUsage' description: '' /api/slurm-allocations/: get: operationId: slurm_allocations_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: backend_id schema: type: string - in: query name: can_manage schema: type: boolean description: Can manage - in: query name: customer schema: type: string format: uuid - in: query name: customer_abbreviation schema: type: string - in: query name: customer_name schema: type: string - in: query name: customer_native_name schema: type: string - in: query name: customer_uuid schema: type: string format: uuid - in: query name: description schema: type: string - in: query name: external_ip schema: type: string - in: query name: field schema: type: array items: type: string enum: - access_url - backend_id - cpu_limit - cpu_usage - created - customer - customer_abbreviation - customer_name - customer_native_name - description - error_message - error_traceback - gateway - gpu_limit - gpu_usage - is_active - is_limit_based - is_usage_based - marketplace_category_name - marketplace_category_uuid - marketplace_offering_name - marketplace_offering_plugin_options - marketplace_offering_uuid - marketplace_plan_uuid - marketplace_resource_state - marketplace_resource_uuid - modified - name - project - project_name - project_uuid - ram_limit - ram_usage - resource_type - service_name - service_settings - service_settings_error_message - service_settings_state - service_settings_uuid - state - url - username - uuid - in: query name: is_active schema: type: boolean - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: project schema: type: string format: uuid - in: query name: project_name schema: type: string - in: query name: project_uuid schema: type: string format: uuid - in: query name: service_settings_name schema: type: string - in: query name: service_settings_uuid schema: type: string format: uuid - in: query name: state schema: type: array items: type: string enum: - CREATING - CREATION_SCHEDULED - DELETING - DELETION_SCHEDULED - ERRED - OK - UPDATE_SCHEDULED - UPDATING explode: true style: form - in: query name: uuid schema: type: string format: uuid tags: - slurm-allocations security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/SlurmAllocation' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' post: operationId: slurm_allocations_create tags: - slurm-allocations requestBody: content: application/json: schema: $ref: '#/components/schemas/SlurmAllocationRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/SlurmAllocation' description: '' head: operationId: slurm_allocations_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: backend_id schema: type: string - in: query name: can_manage schema: type: boolean description: Can manage - in: query name: customer schema: type: string format: uuid - in: query name: customer_abbreviation schema: type: string - in: query name: customer_name schema: type: string - in: query name: customer_native_name schema: type: string - in: query name: customer_uuid schema: type: string format: uuid - in: query name: description schema: type: string - in: query name: external_ip schema: type: string - in: query name: is_active schema: type: boolean - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: project schema: type: string format: uuid - in: query name: project_name schema: type: string - in: query name: project_uuid schema: type: string format: uuid - in: query name: service_settings_name schema: type: string - in: query name: service_settings_uuid schema: type: string format: uuid - in: query name: state schema: type: array items: type: string enum: - CREATING - CREATION_SCHEDULED - DELETING - DELETION_SCHEDULED - ERRED - OK - UPDATE_SCHEDULED - UPDATING explode: true style: form - in: query name: uuid schema: type: string format: uuid tags: - slurm-allocations security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/slurm-allocations/{uuid}/: get: operationId: slurm_allocations_retrieve parameters: - in: query name: field schema: type: array items: type: string enum: - access_url - backend_id - cpu_limit - cpu_usage - created - customer - customer_abbreviation - customer_name - customer_native_name - description - error_message - error_traceback - gateway - gpu_limit - gpu_usage - is_active - is_limit_based - is_usage_based - marketplace_category_name - marketplace_category_uuid - marketplace_offering_name - marketplace_offering_plugin_options - marketplace_offering_uuid - marketplace_plan_uuid - marketplace_resource_state - marketplace_resource_uuid - modified - name - project - project_name - project_uuid - ram_limit - ram_usage - resource_type - service_name - service_settings - service_settings_error_message - service_settings_state - service_settings_uuid - state - url - username - uuid - in: path name: uuid schema: type: string format: uuid required: true tags: - slurm-allocations security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/SlurmAllocation' description: '' put: operationId: slurm_allocations_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - slurm-allocations requestBody: content: application/json: schema: $ref: '#/components/schemas/SlurmAllocationRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/SlurmAllocation' description: '' patch: operationId: slurm_allocations_partial_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - slurm-allocations requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedSlurmAllocationRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/SlurmAllocation' description: '' delete: operationId: slurm_allocations_destroy parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - slurm-allocations security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '204': description: No response body /api/slurm-allocations/{uuid}/pull/: post: operationId: slurm_allocations_pull parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - slurm-allocations security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/slurm-allocations/{uuid}/set_limits/: post: operationId: slurm_allocations_set_limits parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - slurm-allocations requestBody: content: application/json: schema: $ref: '#/components/schemas/SlurmAllocationSetLimitsRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/SlurmAllocationSetLimits' description: '' /api/slurm-allocations/{uuid}/unlink/: post: operationId: slurm_allocations_unlink description: |- Delete resource from the database without scheduling operations on backend and without checking current state of the resource. It is intended to be used for removing resource stuck in transitioning state. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - slurm-allocations security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/slurm-associations/: get: operationId: slurm_associations_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: allocation schema: type: string - in: query name: allocation_uuid schema: type: string format: uuid - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - slurm-associations security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/SlurmAssociation' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' head: operationId: slurm_associations_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: allocation schema: type: string - in: query name: allocation_uuid schema: type: string format: uuid - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - slurm-associations security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/slurm-associations/{uuid}/: get: operationId: slurm_associations_retrieve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - slurm-associations security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/SlurmAssociation' description: '' /api/slurm-jobs/: get: operationId: slurm_jobs_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: field schema: type: array items: type: string enum: - access_url - backend_id - created - customer - customer_abbreviation - customer_name - customer_native_name - description - error_message - error_traceback - file - modified - name - project - project_name - project_uuid - report - resource_type - runtime_state - service_name - service_settings - service_settings_error_message - service_settings_state - service_settings_uuid - state - url - user - user_username - user_uuid - uuid - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - slurm-jobs security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/FirecrestJob' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' post: operationId: slurm_jobs_create tags: - slurm-jobs requestBody: content: application/json: schema: $ref: '#/components/schemas/FirecrestJobRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/FirecrestJob' description: '' head: operationId: slurm_jobs_count description: Get number of items in the collection matching the request parameters. parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - slurm-jobs security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/slurm-jobs/{uuid}/: get: operationId: slurm_jobs_retrieve parameters: - in: query name: field schema: type: array items: type: string enum: - access_url - backend_id - created - customer - customer_abbreviation - customer_name - customer_native_name - description - error_message - error_traceback - file - modified - name - project - project_name - project_uuid - report - resource_type - runtime_state - service_name - service_settings - service_settings_error_message - service_settings_state - service_settings_uuid - state - url - user - user_username - user_uuid - uuid - in: path name: uuid schema: type: string format: uuid required: true tags: - slurm-jobs security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/FirecrestJob' description: '' put: operationId: slurm_jobs_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - slurm-jobs requestBody: content: application/json: schema: $ref: '#/components/schemas/FirecrestJobRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/FirecrestJob' description: '' patch: operationId: slurm_jobs_partial_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - slurm-jobs requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedFirecrestJobRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/FirecrestJob' description: '' delete: operationId: slurm_jobs_destroy parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - slurm-jobs security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '204': description: No response body /api/slurm-jobs/{uuid}/pull/: post: operationId: slurm_jobs_pull parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - slurm-jobs security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/slurm-jobs/{uuid}/unlink/: post: operationId: slurm_jobs_unlink description: |- Delete resource from the database without scheduling operations on backend and without checking current state of the resource. It is intended to be used for removing resource stuck in transitioning state. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - slurm-jobs security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/support-attachments/: get: operationId: support_attachments_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: field schema: type: array items: type: string enum: - backend_id - created - destroy_is_available - file - file_name - file_size - issue - issue_key - mime_type - url - uuid - in: query name: issue schema: type: string - in: query name: issue_uuid schema: type: string format: uuid - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - support-attachments security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/Attachment' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' post: operationId: support_attachments_create tags: - support-attachments requestBody: content: application/json: schema: $ref: '#/components/schemas/AttachmentRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/Attachment' description: '' head: operationId: support_attachments_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: issue schema: type: string - in: query name: issue_uuid schema: type: string format: uuid - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - support-attachments security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/support-attachments/{uuid}/: get: operationId: support_attachments_retrieve parameters: - in: query name: field schema: type: array items: type: string enum: - backend_id - created - destroy_is_available - file - file_name - file_size - issue - issue_key - mime_type - url - uuid - in: path name: uuid schema: type: string format: uuid required: true tags: - support-attachments security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Attachment' description: '' delete: operationId: support_attachments_destroy parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - support-attachments security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '204': description: No response body /api/support-comments/: get: operationId: support_comments_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: author_name schema: type: string - in: query name: author_user schema: type: string - in: query name: description schema: type: string - in: query name: is_public schema: type: boolean - in: query name: issue schema: type: string - in: query name: issue_uuid schema: type: string format: uuid - in: query name: o schema: type: array items: type: string enum: - -created - -modified - created - modified description: |+ Ordering explode: false style: form - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: remote_id_is_set schema: type: boolean description: Remote ID is set. tags: - support-comments security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/Comment' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' head: operationId: support_comments_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: author_name schema: type: string - in: query name: author_user schema: type: string - in: query name: description schema: type: string - in: query name: is_public schema: type: boolean - in: query name: issue schema: type: string - in: query name: issue_uuid schema: type: string format: uuid - in: query name: o schema: type: array items: type: string enum: - -created - -modified - created - modified description: |+ Ordering explode: false style: form - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: remote_id_is_set schema: type: boolean description: Remote ID is set. tags: - support-comments security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/support-comments/{uuid}/: get: operationId: support_comments_retrieve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - support-comments security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Comment' description: '' put: operationId: support_comments_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - support-comments requestBody: content: application/json: schema: $ref: '#/components/schemas/CommentRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Comment' description: '' patch: operationId: support_comments_partial_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - support-comments requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedCommentRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Comment' description: '' delete: operationId: support_comments_destroy parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - support-comments security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '204': description: No response body /api/support-feedback-average-report/: get: operationId: support_feedback_average_report_retrieve tags: - support-feedback-average-report security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/support-feedback-report/: get: operationId: support_feedback_report_retrieve tags: - support-feedback-report security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/support-feedbacks/: get: operationId: support_feedbacks_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: created_after schema: type: string format: date-time - in: query name: created_before schema: type: string format: date-time - in: query name: evaluation schema: type: integer - in: query name: issue schema: type: string - in: query name: issue_key schema: type: string - in: query name: issue_uuid schema: type: string format: uuid - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: user schema: type: string - in: query name: user_full_name schema: type: string description: User full name contains - in: query name: user_uuid schema: type: string format: uuid tags: - support-feedbacks security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/Feedback' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' post: operationId: support_feedbacks_create tags: - support-feedbacks requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateFeedbackRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/CreateFeedback' description: '' head: operationId: support_feedbacks_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: created_after schema: type: string format: date-time - in: query name: created_before schema: type: string format: date-time - in: query name: evaluation schema: type: integer - in: query name: issue schema: type: string - in: query name: issue_key schema: type: string - in: query name: issue_uuid schema: type: string format: uuid - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: user schema: type: string - in: query name: user_full_name schema: type: string description: User full name contains - in: query name: user_uuid schema: type: string format: uuid tags: - support-feedbacks security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/support-feedbacks/{uuid}/: get: operationId: support_feedbacks_retrieve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - support-feedbacks security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Feedback' description: '' /api/support-issue-statuses/: get: operationId: support_issue_statuses_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - support-issue-statuses security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/IssueStatus' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' post: operationId: support_issue_statuses_create tags: - support-issue-statuses requestBody: content: application/json: schema: $ref: '#/components/schemas/IssueStatusRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/IssueStatus' description: '' head: operationId: support_issue_statuses_count description: Get number of items in the collection matching the request parameters. parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - support-issue-statuses security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/support-issue-statuses/{uuid}/: get: operationId: support_issue_statuses_retrieve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - support-issue-statuses security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/IssueStatus' description: '' put: operationId: support_issue_statuses_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - support-issue-statuses requestBody: content: application/json: schema: $ref: '#/components/schemas/IssueStatusRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/IssueStatus' description: '' patch: operationId: support_issue_statuses_partial_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - support-issue-statuses requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedIssueStatusRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/IssueStatus' description: '' delete: operationId: support_issue_statuses_destroy parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - support-issue-statuses security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '204': description: No response body /api/support-issues/: get: operationId: support_issues_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: assignee schema: type: string - in: query name: assignee_name schema: type: string - in: query name: caller schema: type: string - in: query name: caller_full_name schema: type: string description: Caller full name contains - in: query name: customer schema: type: string - in: query name: customer_uuid schema: type: string format: uuid - in: query name: key schema: type: string - in: query name: o schema: type: array items: type: string enum: - -assignee_name - -caller_first_name - -caller_last_name - -created - -customer_name - -key - -modified - -priority - -project_name - -remote_id - -reporter_name - -status - -summary - -type - assignee_name - caller_first_name - caller_last_name - created - customer_name - key - modified - priority - project_name - remote_id - reporter_name - status - summary - type description: |+ Ordering explode: false style: form - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: project schema: type: string - in: query name: project_uuid schema: type: string format: uuid - in: query name: query schema: type: string description: Summary or key contains - in: query name: remote_id schema: type: string - in: query name: reporter schema: type: string - in: query name: reporter_name schema: type: string - in: query name: resolution_year_month schema: type: string - in: query name: resource_external_ip schema: type: string description: Resource external IP - in: query name: resource_internal_ip schema: type: string description: Resource internal IP - in: query name: resource_uuid schema: type: string format: uuid description: Resource UUID - in: query name: status schema: type: string - in: query name: summary schema: type: string - in: query name: type schema: type: string tags: - support-issues security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/Issue' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' post: operationId: support_issues_create tags: - support-issues requestBody: content: application/json: schema: $ref: '#/components/schemas/IssueRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/Issue' description: '' head: operationId: support_issues_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: assignee schema: type: string - in: query name: assignee_name schema: type: string - in: query name: caller schema: type: string - in: query name: caller_full_name schema: type: string description: Caller full name contains - in: query name: customer schema: type: string - in: query name: customer_uuid schema: type: string format: uuid - in: query name: key schema: type: string - in: query name: o schema: type: array items: type: string enum: - -assignee_name - -caller_first_name - -caller_last_name - -created - -customer_name - -key - -modified - -priority - -project_name - -remote_id - -reporter_name - -status - -summary - -type - assignee_name - caller_first_name - caller_last_name - created - customer_name - key - modified - priority - project_name - remote_id - reporter_name - status - summary - type description: |+ Ordering explode: false style: form - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: project schema: type: string - in: query name: project_uuid schema: type: string format: uuid - in: query name: query schema: type: string description: Summary or key contains - in: query name: remote_id schema: type: string - in: query name: reporter schema: type: string - in: query name: reporter_name schema: type: string - in: query name: resolution_year_month schema: type: string - in: query name: resource_external_ip schema: type: string description: Resource external IP - in: query name: resource_internal_ip schema: type: string description: Resource internal IP - in: query name: resource_uuid schema: type: string format: uuid description: Resource UUID - in: query name: status schema: type: string - in: query name: summary schema: type: string - in: query name: type schema: type: string tags: - support-issues security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/support-issues/{uuid}/: get: operationId: support_issues_retrieve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - support-issues security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Issue' description: '' put: operationId: support_issues_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - support-issues requestBody: content: application/json: schema: $ref: '#/components/schemas/IssueRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Issue' description: '' patch: operationId: support_issues_partial_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - support-issues requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedIssueRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Issue' description: '' delete: operationId: support_issues_destroy parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - support-issues security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '204': description: No response body /api/support-issues/{uuid}/comment/: post: operationId: support_issues_comment parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - support-issues requestBody: content: application/json: schema: $ref: '#/components/schemas/CommentRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Comment' description: '' /api/support-issues/{uuid}/sync/: post: operationId: support_issues_sync parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - support-issues requestBody: content: application/json: schema: $ref: '#/components/schemas/IssueRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Issue' description: '' /api/support-jira-webhook/: post: operationId: support_jira_webhook tags: - support-jira-webhook requestBody: content: application/json: schema: $ref: '#/components/schemas/WebHookReceiverRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/WebHookReceiver' description: '' /api/support-priorities/: get: operationId: support_priorities_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - support-priorities security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/Priority' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' head: operationId: support_priorities_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - support-priorities security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/support-priorities/{uuid}/: get: operationId: support_priorities_retrieve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - support-priorities security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Priority' description: '' /api/support-smax-webhook/: post: operationId: support_smax_webhook tags: - support-smax-webhook requestBody: content: application/json: schema: $ref: '#/components/schemas/SmaxWebHookReceiverRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/SmaxWebHookReceiver' description: '' /api/support-statistics/: get: operationId: support_statistics_retrieve tags: - support-statistics security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/SupportStats' description: '' /api/support-templates/: get: operationId: support_templates_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - support-templates security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/Template' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' post: operationId: support_templates_create tags: - support-templates requestBody: content: application/json: schema: $ref: '#/components/schemas/TemplateRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/Template' description: '' head: operationId: support_templates_count description: Get number of items in the collection matching the request parameters. parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - support-templates security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/support-templates/{uuid}/: get: operationId: support_templates_retrieve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - support-templates security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Template' description: '' put: operationId: support_templates_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - support-templates requestBody: content: application/json: schema: $ref: '#/components/schemas/TemplateRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Template' description: '' patch: operationId: support_templates_partial_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - support-templates requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedTemplateRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Template' description: '' delete: operationId: support_templates_destroy parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - support-templates security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '204': description: No response body /api/support-templates/{uuid}/create_attachments/: post: operationId: support_templates_create_attachments description: This view attaches documents to template. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - support-templates requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateAttachmentsRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '201': description: No response body '400': description: No response body /api/support-templates/{uuid}/delete_attachments/: post: operationId: support_templates_delete_attachments parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - support-templates requestBody: content: application/json: schema: $ref: '#/components/schemas/DeleteAttachmentsRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/support-users/: get: operationId: support_users_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: backend_id schema: type: string - in: query name: name schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: user schema: type: integer tags: - support-users security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/SupportUser' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' head: operationId: support_users_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: backend_id schema: type: string - in: query name: name schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: user schema: type: integer tags: - support-users security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/support-users/{uuid}/: get: operationId: support_users_retrieve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - support-users security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/SupportUser' description: '' /api/support-zammad-webhook/: post: operationId: support_zammad_webhook tags: - support-zammad-webhook responses: '200': description: No response body /api/sync-issues/: get: operationId: sync_issues_retrieve description: This view triggers synchronization of issues from backend. tags: - sync-issues security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '202': description: No response body '403': description: No response body post: operationId: sync_issues description: This view triggers synchronization of issues from backend. tags: - sync-issues security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '202': description: No response body '403': description: No response body /api/user-agreements/: get: operationId: user_agreements_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: agreement_type schema: type: string enum: - PP - TOS - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - user-agreements security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/UserAgreement' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' post: operationId: user_agreements_create tags: - user-agreements requestBody: content: application/json: schema: $ref: '#/components/schemas/UserAgreementRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/UserAgreement' description: '' head: operationId: user_agreements_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: agreement_type schema: type: string enum: - PP - TOS - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' tags: - user-agreements security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/user-agreements/{uuid}/: get: operationId: user_agreements_retrieve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - user-agreements security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/UserAgreement' description: '' put: operationId: user_agreements_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - user-agreements requestBody: content: application/json: schema: $ref: '#/components/schemas/UserAgreementRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/UserAgreement' description: '' patch: operationId: user_agreements_partial_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - user-agreements requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedUserAgreementRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/UserAgreement' description: '' delete: operationId: user_agreements_destroy parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - user-agreements security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '204': description: No response body /api/user-group-invitations/: get: operationId: user_group_invitations_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: customer_uuid schema: type: string format: uuid - in: query name: is_active schema: type: boolean - in: query name: o schema: type: array items: type: string enum: - -created - created description: |+ Ordering explode: false style: form - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: role_name schema: type: string - in: query name: role_uuid schema: type: string format: uuid - in: query name: scope_type schema: type: string tags: - user-group-invitations security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/GroupInvitation' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' post: operationId: user_group_invitations_create tags: - user-group-invitations requestBody: content: application/json: schema: $ref: '#/components/schemas/GroupInvitationRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/GroupInvitation' description: '' head: operationId: user_group_invitations_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: customer_uuid schema: type: string format: uuid - in: query name: is_active schema: type: boolean - in: query name: o schema: type: array items: type: string enum: - -created - created description: |+ Ordering explode: false style: form - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: role_name schema: type: string - in: query name: role_uuid schema: type: string format: uuid - in: query name: scope_type schema: type: string tags: - user-group-invitations security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/user-group-invitations/{uuid}/: get: operationId: user_group_invitations_retrieve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - user-group-invitations security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/GroupInvitation' description: '' /api/user-group-invitations/{uuid}/cancel/: post: operationId: user_group_invitations_cancel description: Cancel group invitation parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - user-group-invitations security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/user-group-invitations/{uuid}/projects/: get: operationId: user_group_invitations_projects_list description: Return projects for group invitation parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: path name: uuid schema: type: string format: uuid required: true tags: - user-group-invitations security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/NestedProject' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' /api/user-group-invitations/{uuid}/submit_request/: post: operationId: user_group_invitations_submit_request parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - user-group-invitations security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/SubmitRequestResponse' description: '' /api/user-invitations/: get: operationId: user_invitations_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: civil_number schema: type: string - in: query name: customer_uuid schema: type: string format: uuid - in: query name: email schema: type: string - in: query name: o schema: type: array items: type: string enum: - -created - -created_by - -email - -state - created - created_by - email - state description: |+ Ordering explode: false style: form - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: role_name schema: type: string - in: query name: role_uuid schema: type: string format: uuid - in: query name: scope_description schema: type: string - in: query name: scope_name schema: type: string - in: query name: scope_type schema: type: string - in: query name: state schema: type: array items: type: string enum: - accepted - canceled - expired - pending - project - rejected - requested explode: true style: form tags: - user-invitations security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/Invitation' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' post: operationId: user_invitations_create tags: - user-invitations requestBody: content: application/json: schema: $ref: '#/components/schemas/InvitationRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/Invitation' description: '' head: operationId: user_invitations_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: civil_number schema: type: string - in: query name: customer_uuid schema: type: string format: uuid - in: query name: email schema: type: string - in: query name: o schema: type: array items: type: string enum: - -created - -created_by - -email - -state - created - created_by - email - state description: |+ Ordering explode: false style: form - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: role_name schema: type: string - in: query name: role_uuid schema: type: string format: uuid - in: query name: scope_description schema: type: string - in: query name: scope_name schema: type: string - in: query name: scope_type schema: type: string - in: query name: state schema: type: array items: type: string enum: - accepted - canceled - expired - pending - project - rejected - requested explode: true style: form tags: - user-invitations security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/user-invitations/{uuid}/: get: operationId: user_invitations_retrieve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - user-invitations security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Invitation' description: '' /api/user-invitations/{uuid}/accept/: post: operationId: user_invitations_accept description: Accept invitation for current user. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - user-invitations security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/user-invitations/{uuid}/cancel/: post: operationId: user_invitations_cancel parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - user-invitations security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/user-invitations/{uuid}/check/: post: operationId: user_invitations_check parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - user-invitations security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/InvitationCheck' description: '' /api/user-invitations/{uuid}/delete/: post: operationId: user_invitations_delete parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - user-invitations security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/user-invitations/{uuid}/details/: get: operationId: user_invitations_details_retrieve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - user-invitations security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/VisibleInvitationDetails' description: '' /api/user-invitations/{uuid}/send/: post: operationId: user_invitations_send parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - user-invitations security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/user-invitations/approve/: post: operationId: user_invitations_approve description: |- For user's convenience invitation approval is performed without authentication. User UUID and invitation UUID is encoded into cryptographically signed token. tags: - user-invitations requestBody: content: application/json: schema: $ref: '#/components/schemas/TokenRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/user-invitations/reject/: post: operationId: user_invitations_reject description: |- For user's convenience invitation reject action is performed without authentication. User UUID and invitation UUID is encoded into cryptographically signed token. tags: - user-invitations requestBody: content: application/json: schema: $ref: '#/components/schemas/TokenRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/user-permission-requests/: get: operationId: user_permission_requests_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: created_by schema: type: string format: uuid - in: query name: customer_uuid schema: type: string format: uuid - in: query name: invitation schema: type: string format: uuid - in: query name: o schema: type: array items: type: string enum: - -created - -state - created - state description: |+ Ordering explode: false style: form - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: state schema: type: array items: type: string enum: - approved - canceled - draft - pending - rejected explode: true style: form tags: - user-permission-requests security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/PermissionRequest' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' head: operationId: user_permission_requests_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: created_by schema: type: string format: uuid - in: query name: customer_uuid schema: type: string format: uuid - in: query name: invitation schema: type: string format: uuid - in: query name: o schema: type: array items: type: string enum: - -created - -state - created - state description: |+ Ordering explode: false style: form - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: state schema: type: array items: type: string enum: - approved - canceled - draft - pending - rejected explode: true style: form tags: - user-permission-requests security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/user-permission-requests/{uuid}/: get: operationId: user_permission_requests_retrieve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - user-permission-requests security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PermissionRequest' description: '' /api/user-permission-requests/{uuid}/approve/: post: operationId: user_permission_requests_approve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - user-permission-requests requestBody: content: application/json: schema: $ref: '#/components/schemas/ReviewCommentRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ReviewComment' description: '' /api/user-permission-requests/{uuid}/cancel_request/: post: operationId: user_permission_requests_cancel_request description: Cancel permission request. Users can cancel their own requests, staff can cancel any request. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - user-permission-requests security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/CancelRequestResponse' description: '' /api/user-permission-requests/{uuid}/reject/: post: operationId: user_permission_requests_reject parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - user-permission-requests requestBody: content: application/json: schema: $ref: '#/components/schemas/ReviewCommentRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ReviewComment' description: '' /api/user-permissions/: get: operationId: user_permissions_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: created schema: type: string format: date-time description: Created after - in: query name: expiration_time schema: type: string format: date-time - in: query name: full_name schema: type: string description: User full name contains - in: query name: modified schema: type: string format: date-time description: Modified after - in: query name: native_name schema: type: string - in: query name: o schema: type: array items: type: string enum: - -created - -email - -expiration_time - -full_name - -native_name - -role - -username - created - email - expiration_time - full_name - native_name - role - username description: |+ Ordering explode: false style: form - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: role_name schema: type: string description: Role name contains - in: query name: role_uuid schema: type: string format: uuid description: Role UUID - in: query name: scope_name schema: type: string description: Scope name - in: query name: scope_type schema: type: string description: Scope type - in: query name: scope_uuid schema: type: string description: Scope UUID - in: query name: user schema: type: string format: uuid - in: query name: user_slug schema: type: string description: User slug contains - in: query name: user_url schema: type: string - in: query name: username schema: type: string tags: - user-permissions security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/Permission' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' head: operationId: user_permissions_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: created schema: type: string format: date-time description: Created after - in: query name: expiration_time schema: type: string format: date-time - in: query name: full_name schema: type: string description: User full name contains - in: query name: modified schema: type: string format: date-time description: Modified after - in: query name: native_name schema: type: string - in: query name: o schema: type: array items: type: string enum: - -created - -email - -expiration_time - -full_name - -native_name - -role - -username - created - email - expiration_time - full_name - native_name - role - username description: |+ Ordering explode: false style: form - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: role_name schema: type: string description: Role name contains - in: query name: role_uuid schema: type: string format: uuid description: Role UUID - in: query name: scope_name schema: type: string description: Scope name - in: query name: scope_type schema: type: string description: Scope type - in: query name: scope_uuid schema: type: string description: Scope UUID - in: query name: user schema: type: string format: uuid - in: query name: user_slug schema: type: string description: User slug contains - in: query name: user_url schema: type: string - in: query name: username schema: type: string tags: - user-permissions security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/user-permissions/{uuid}/: get: operationId: user_permissions_retrieve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - user-permissions security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Permission' description: '' /api/users/: get: operationId: users_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: agreement_date schema: type: string format: date-time description: Agreement date after - in: query name: civil_number schema: type: string - in: query name: customer_uuid schema: type: string format: uuid - in: query name: date_joined schema: type: string format: date-time description: Date joined after - in: query name: description schema: type: string - in: query name: email schema: type: string - in: query name: field schema: type: array items: type: string enum: - affiliations - agree_with_policy - agreement_date - civil_number - date_joined - description - email - first_name - full_name - has_active_session - identity_provider_fields - identity_provider_label - identity_provider_management_url - identity_provider_name - identity_source - image - is_active - is_staff - is_support - job_title - last_name - native_name - notifications_enabled - organization - permissions - phone_number - preferred_language - registration_method - requested_email - slug - token - token_expires_at - token_lifetime - url - username - uuid - in: query name: full_name schema: type: string description: Full name - in: query name: is_active schema: type: boolean - in: query name: is_staff schema: type: boolean - in: query name: is_support schema: type: boolean - in: query name: job_title schema: type: string - in: query name: modified schema: type: string format: date-time description: Date modified after - in: query name: native_name schema: type: string - in: query name: o schema: type: array items: type: string enum: - -description - -email - -full_name - -is_active - -is_staff - -is_support - -job_title - -native_name - -organization - -phone_number - -registration_method - -username - description - email - full_name - is_active - is_staff - is_support - job_title - native_name - organization - phone_number - registration_method - username description: |+ Ordering explode: false style: form - in: query name: organization schema: type: string - in: query name: organization_roles schema: type: string description: Organization roles - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: phone_number schema: type: string - in: query name: project_roles schema: type: string description: Project roles - in: query name: project_uuid schema: type: string format: uuid - in: query name: query schema: type: string description: Filter by first name, last name, civil number, username or email - in: query name: registration_method schema: type: string - in: query name: user_keyword schema: type: string description: User keyword - in: query name: username schema: type: string - in: query name: username_list schema: type: string description: Comma-separated usernames tags: - users security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/User' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' post: operationId: users_create tags: - users requestBody: content: application/json: schema: $ref: '#/components/schemas/UserRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/User' description: '' head: operationId: users_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: agreement_date schema: type: string format: date-time description: Agreement date after - in: query name: civil_number schema: type: string - in: query name: customer_uuid schema: type: string format: uuid - in: query name: date_joined schema: type: string format: date-time description: Date joined after - in: query name: description schema: type: string - in: query name: email schema: type: string - in: query name: full_name schema: type: string description: Full name - in: query name: is_active schema: type: boolean - in: query name: is_staff schema: type: boolean - in: query name: is_support schema: type: boolean - in: query name: job_title schema: type: string - in: query name: modified schema: type: string format: date-time description: Date modified after - in: query name: native_name schema: type: string - in: query name: o schema: type: array items: type: string enum: - -description - -email - -full_name - -is_active - -is_staff - -is_support - -job_title - -native_name - -organization - -phone_number - -registration_method - -username - description - email - full_name - is_active - is_staff - is_support - job_title - native_name - organization - phone_number - registration_method - username description: |+ Ordering explode: false style: form - in: query name: organization schema: type: string - in: query name: organization_roles schema: type: string description: Organization roles - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: phone_number schema: type: string - in: query name: project_roles schema: type: string description: Project roles - in: query name: project_uuid schema: type: string format: uuid - in: query name: query schema: type: string description: Filter by first name, last name, civil number, username or email - in: query name: registration_method schema: type: string - in: query name: user_keyword schema: type: string description: User keyword - in: query name: username schema: type: string - in: query name: username_list schema: type: string description: Comma-separated usernames tags: - users security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/users/{uuid}/: get: operationId: users_retrieve parameters: - in: query name: field schema: type: array items: type: string enum: - affiliations - agree_with_policy - agreement_date - civil_number - date_joined - description - email - first_name - full_name - has_active_session - identity_provider_fields - identity_provider_label - identity_provider_management_url - identity_provider_name - identity_source - image - is_active - is_staff - is_support - job_title - last_name - native_name - notifications_enabled - organization - permissions - phone_number - preferred_language - registration_method - requested_email - slug - token - token_expires_at - token_lifetime - url - username - uuid - in: path name: uuid schema: type: string format: uuid required: true tags: - users security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/User' description: '' put: operationId: users_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - users requestBody: content: application/json: schema: $ref: '#/components/schemas/UserRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/User' description: '' patch: operationId: users_partial_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - users requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedUserRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/User' description: '' delete: operationId: users_destroy parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - users security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '204': description: No response body /api/users/{uuid}/cancel_change_email/: post: operationId: users_cancel_change_email description: Cancel email update request parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - users security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/users/{uuid}/change_email/: post: operationId: users_change_email description: Allows to change email for user. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - users requestBody: content: application/json: schema: $ref: '#/components/schemas/UserEmailChangeRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/users/{uuid}/change_password/: post: operationId: users_change_password description: Allows staff user to change password for any user. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - users requestBody: content: application/json: schema: $ref: '#/components/schemas/PasswordChangeRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/users/{uuid}/pull_remote_user/: post: operationId: users_pull_remote_user description: Pulls remote user data from eduTEAMS. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - users security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/users/{uuid}/refresh_token/: post: operationId: users_refresh_token description: Allows to refresh user auth token. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - users security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/UserAuthToken' description: '' /api/users/{uuid}/token/: get: operationId: users_token_retrieve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - users security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/UserAuthToken' description: '' /api/users/confirm_email/: post: operationId: users_confirm_email description: Confirm email update using code tags: - users requestBody: content: application/json: schema: $ref: '#/components/schemas/ConfirmEmailRequestRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/users/me/: get: operationId: users_me_retrieve description: Get current user details, including authentication token. parameters: - in: query name: field schema: type: array items: type: string enum: - affiliations - agree_with_policy - agreement_date - civil_number - date_joined - description - email - first_name - full_name - has_active_session - identity_provider_fields - identity_provider_label - identity_provider_management_url - identity_provider_name - identity_source - image - is_active - is_staff - is_support - job_title - last_name - native_name - notifications_enabled - organization - permissions - phone_number - preferred_language - registration_method - requested_email - slug - token - token_expires_at - token_lifetime - url - username - uuid tags: - users security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/User' description: '' head: operationId: users_me_count description: Get number of items in the collection matching the request parameters. tags: - users security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/version/: get: operationId: version_retrieve description: Retrieve current version of the application and the latest available version from GitHub (if available). tags: - version security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Version' description: '' /api/vmware-clusters/: get: operationId: vmware_clusters_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: customer_uuid schema: type: string format: uuid description: Customer UUID - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: settings schema: type: string - in: query name: settings_uuid schema: type: string format: uuid tags: - vmware-clusters security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/VmwareCluster' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' head: operationId: vmware_clusters_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: customer_uuid schema: type: string format: uuid description: Customer UUID - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: settings schema: type: string - in: query name: settings_uuid schema: type: string format: uuid tags: - vmware-clusters security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/vmware-clusters/{uuid}/: get: operationId: vmware_clusters_retrieve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - vmware-clusters security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/VmwareCluster' description: '' /api/vmware-datastores/: get: operationId: vmware_datastores_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: customer_uuid schema: type: string format: uuid description: Customer UUID - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: settings schema: type: string - in: query name: settings_uuid schema: type: string format: uuid tags: - vmware-datastores security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/VmwareDatastore' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' head: operationId: vmware_datastores_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: customer_uuid schema: type: string format: uuid description: Customer UUID - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: settings schema: type: string - in: query name: settings_uuid schema: type: string format: uuid tags: - vmware-datastores security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/vmware-datastores/{uuid}/: get: operationId: vmware_datastores_retrieve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - vmware-datastores security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/VmwareDatastore' description: '' /api/vmware-disks/: get: operationId: vmware_disks_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: backend_id schema: type: string - in: query name: can_manage schema: type: boolean description: Can manage - in: query name: customer schema: type: string format: uuid - in: query name: customer_abbreviation schema: type: string - in: query name: customer_name schema: type: string - in: query name: customer_native_name schema: type: string - in: query name: customer_uuid schema: type: string format: uuid - in: query name: description schema: type: string - in: query name: external_ip schema: type: string - in: query name: field schema: type: array items: type: string enum: - access_url - backend_id - created - customer - customer_abbreviation - customer_name - customer_native_name - description - error_message - error_traceback - is_limit_based - is_usage_based - marketplace_category_name - marketplace_category_uuid - marketplace_offering_name - marketplace_offering_plugin_options - marketplace_offering_uuid - marketplace_plan_uuid - marketplace_resource_state - marketplace_resource_uuid - modified - name - project - project_name - project_uuid - resource_type - service_name - service_settings - service_settings_error_message - service_settings_state - service_settings_uuid - size - state - url - uuid - vm - vm_name - vm_uuid - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: project schema: type: string format: uuid - in: query name: project_name schema: type: string - in: query name: project_uuid schema: type: string format: uuid - in: query name: service_settings_name schema: type: string - in: query name: service_settings_uuid schema: type: string format: uuid - in: query name: state schema: type: array items: type: string enum: - CREATING - CREATION_SCHEDULED - DELETING - DELETION_SCHEDULED - ERRED - OK - UPDATE_SCHEDULED - UPDATING explode: true style: form - in: query name: uuid schema: type: string format: uuid - in: query name: vm schema: type: string - in: query name: vm_uuid schema: type: string format: uuid tags: - vmware-disks security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/VmwareDisk' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' head: operationId: vmware_disks_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: backend_id schema: type: string - in: query name: can_manage schema: type: boolean description: Can manage - in: query name: customer schema: type: string format: uuid - in: query name: customer_abbreviation schema: type: string - in: query name: customer_name schema: type: string - in: query name: customer_native_name schema: type: string - in: query name: customer_uuid schema: type: string format: uuid - in: query name: description schema: type: string - in: query name: external_ip schema: type: string - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: project schema: type: string format: uuid - in: query name: project_name schema: type: string - in: query name: project_uuid schema: type: string format: uuid - in: query name: service_settings_name schema: type: string - in: query name: service_settings_uuid schema: type: string format: uuid - in: query name: state schema: type: array items: type: string enum: - CREATING - CREATION_SCHEDULED - DELETING - DELETION_SCHEDULED - ERRED - OK - UPDATE_SCHEDULED - UPDATING explode: true style: form - in: query name: uuid schema: type: string format: uuid - in: query name: vm schema: type: string - in: query name: vm_uuid schema: type: string format: uuid tags: - vmware-disks security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/vmware-disks/{uuid}/: get: operationId: vmware_disks_retrieve parameters: - in: query name: field schema: type: array items: type: string enum: - access_url - backend_id - created - customer - customer_abbreviation - customer_name - customer_native_name - description - error_message - error_traceback - is_limit_based - is_usage_based - marketplace_category_name - marketplace_category_uuid - marketplace_offering_name - marketplace_offering_plugin_options - marketplace_offering_uuid - marketplace_plan_uuid - marketplace_resource_state - marketplace_resource_uuid - modified - name - project - project_name - project_uuid - resource_type - service_name - service_settings - service_settings_error_message - service_settings_state - service_settings_uuid - size - state - url - uuid - vm - vm_name - vm_uuid - in: path name: uuid schema: type: string format: uuid required: true tags: - vmware-disks security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/VmwareDisk' description: '' delete: operationId: vmware_disks_destroy parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - vmware-disks security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '204': description: No response body /api/vmware-disks/{uuid}/extend/: post: operationId: vmware_disks_extend description: Increase disk capacity parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - vmware-disks requestBody: content: application/json: schema: $ref: '#/components/schemas/VmwareDiskExtendRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/VmwareDiskExtend' description: '' /api/vmware-disks/{uuid}/pull/: post: operationId: vmware_disks_pull parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - vmware-disks security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/vmware-disks/{uuid}/unlink/: post: operationId: vmware_disks_unlink description: |- Delete resource from the database without scheduling operations on backend and without checking current state of the resource. It is intended to be used for removing resource stuck in transitioning state. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - vmware-disks security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/vmware-folders/: get: operationId: vmware_folders_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: customer_uuid schema: type: string format: uuid description: Customer UUID - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: settings schema: type: string - in: query name: settings_uuid schema: type: string format: uuid tags: - vmware-folders security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/VmwareFolder' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' head: operationId: vmware_folders_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: customer_uuid schema: type: string format: uuid description: Customer UUID - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: settings schema: type: string - in: query name: settings_uuid schema: type: string format: uuid tags: - vmware-folders security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/vmware-folders/{uuid}/: get: operationId: vmware_folders_retrieve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - vmware-folders security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/VmwareFolder' description: '' /api/vmware-limits/{uuid}/: get: operationId: vmware_limits_retrieve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - vmware-limits security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/VmwareLimit' description: '' /api/vmware-networks/: get: operationId: vmware_networks_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: customer_pair_uuid schema: type: string format: uuid description: Customer UUID - in: query name: customer_uuid schema: type: string format: uuid description: Customer UUID - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: settings schema: type: string - in: query name: settings_uuid schema: type: string format: uuid tags: - vmware-networks security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/VmwareNetwork' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' head: operationId: vmware_networks_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: customer_pair_uuid schema: type: string format: uuid description: Customer UUID - in: query name: customer_uuid schema: type: string format: uuid description: Customer UUID - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: settings schema: type: string - in: query name: settings_uuid schema: type: string format: uuid tags: - vmware-networks security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/vmware-networks/{uuid}/: get: operationId: vmware_networks_retrieve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - vmware-networks security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/VmwareNetwork' description: '' /api/vmware-ports/: get: operationId: vmware_ports_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: backend_id schema: type: string - in: query name: can_manage schema: type: boolean description: Can manage - in: query name: customer schema: type: string format: uuid - in: query name: customer_abbreviation schema: type: string - in: query name: customer_name schema: type: string - in: query name: customer_native_name schema: type: string - in: query name: customer_uuid schema: type: string format: uuid - in: query name: description schema: type: string - in: query name: external_ip schema: type: string - in: query name: field schema: type: array items: type: string enum: - access_url - backend_id - created - customer - customer_abbreviation - customer_name - customer_native_name - description - error_message - error_traceback - is_limit_based - is_usage_based - mac_address - marketplace_category_name - marketplace_category_uuid - marketplace_offering_name - marketplace_offering_plugin_options - marketplace_offering_uuid - marketplace_plan_uuid - marketplace_resource_state - marketplace_resource_uuid - modified - name - network - network_name - project - project_name - project_uuid - resource_type - service_name - service_settings - service_settings_error_message - service_settings_state - service_settings_uuid - state - url - uuid - vm - vm_name - vm_uuid - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - in: query name: network schema: type: string - in: query name: network_uuid schema: type: string format: uuid - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: project schema: type: string format: uuid - in: query name: project_name schema: type: string - in: query name: project_uuid schema: type: string format: uuid - in: query name: service_settings_name schema: type: string - in: query name: service_settings_uuid schema: type: string format: uuid - in: query name: state schema: type: array items: type: string enum: - CREATING - CREATION_SCHEDULED - DELETING - DELETION_SCHEDULED - ERRED - OK - UPDATE_SCHEDULED - UPDATING explode: true style: form - in: query name: uuid schema: type: string format: uuid - in: query name: vm schema: type: string - in: query name: vm_uuid schema: type: string format: uuid tags: - vmware-ports security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/VmwarePort' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' head: operationId: vmware_ports_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: backend_id schema: type: string - in: query name: can_manage schema: type: boolean description: Can manage - in: query name: customer schema: type: string format: uuid - in: query name: customer_abbreviation schema: type: string - in: query name: customer_name schema: type: string - in: query name: customer_native_name schema: type: string - in: query name: customer_uuid schema: type: string format: uuid - in: query name: description schema: type: string - in: query name: external_ip schema: type: string - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - in: query name: network schema: type: string - in: query name: network_uuid schema: type: string format: uuid - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: project schema: type: string format: uuid - in: query name: project_name schema: type: string - in: query name: project_uuid schema: type: string format: uuid - in: query name: service_settings_name schema: type: string - in: query name: service_settings_uuid schema: type: string format: uuid - in: query name: state schema: type: array items: type: string enum: - CREATING - CREATION_SCHEDULED - DELETING - DELETION_SCHEDULED - ERRED - OK - UPDATE_SCHEDULED - UPDATING explode: true style: form - in: query name: uuid schema: type: string format: uuid - in: query name: vm schema: type: string - in: query name: vm_uuid schema: type: string format: uuid tags: - vmware-ports security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/vmware-ports/{uuid}/: get: operationId: vmware_ports_retrieve parameters: - in: query name: field schema: type: array items: type: string enum: - access_url - backend_id - created - customer - customer_abbreviation - customer_name - customer_native_name - description - error_message - error_traceback - is_limit_based - is_usage_based - mac_address - marketplace_category_name - marketplace_category_uuid - marketplace_offering_name - marketplace_offering_plugin_options - marketplace_offering_uuid - marketplace_plan_uuid - marketplace_resource_state - marketplace_resource_uuid - modified - name - network - network_name - project - project_name - project_uuid - resource_type - service_name - service_settings - service_settings_error_message - service_settings_state - service_settings_uuid - state - url - uuid - vm - vm_name - vm_uuid - in: path name: uuid schema: type: string format: uuid required: true tags: - vmware-ports security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/VmwarePort' description: '' delete: operationId: vmware_ports_destroy parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - vmware-ports security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '204': description: No response body /api/vmware-ports/{uuid}/pull/: post: operationId: vmware_ports_pull parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - vmware-ports security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/vmware-ports/{uuid}/unlink/: post: operationId: vmware_ports_unlink description: |- Delete resource from the database without scheduling operations on backend and without checking current state of the resource. It is intended to be used for removing resource stuck in transitioning state. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - vmware-ports security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/vmware-templates/: get: operationId: vmware_templates_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: settings schema: type: string - in: query name: settings_uuid schema: type: string format: uuid tags: - vmware-templates security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/VmwareTemplate' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' head: operationId: vmware_templates_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: settings schema: type: string - in: query name: settings_uuid schema: type: string format: uuid tags: - vmware-templates security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/vmware-templates/{uuid}/: get: operationId: vmware_templates_retrieve parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - vmware-templates security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/VmwareTemplate' description: '' /api/vmware-virtual-machine/: get: operationId: vmware_virtual_machine_list description: Mixin to optimize HEAD requests for DRF views bypassing serializer processing parameters: - in: query name: backend_id schema: type: string - in: query name: can_manage schema: type: boolean description: Can manage - in: query name: customer schema: type: string format: uuid - in: query name: customer_abbreviation schema: type: string - in: query name: customer_name schema: type: string - in: query name: customer_native_name schema: type: string - in: query name: customer_uuid schema: type: string format: uuid - in: query name: description schema: type: string - in: query name: external_ip schema: type: string - in: query name: field schema: type: array items: type: string enum: - access_url - backend_id - cluster - cluster_name - cores - cores_per_socket - created - customer - customer_abbreviation - customer_name - customer_native_name - datastore - datastore_name - description - disk - disks - error_message - error_traceback - folder - folder_name - guest_os - guest_os_name - guest_power_state - is_limit_based - is_usage_based - marketplace_category_name - marketplace_category_uuid - marketplace_offering_name - marketplace_offering_plugin_options - marketplace_offering_uuid - marketplace_plan_uuid - marketplace_resource_state - marketplace_resource_uuid - modified - name - networks - ports - project - project_name - project_uuid - ram - resource_type - runtime_state - service_name - service_settings - service_settings_error_message - service_settings_state - service_settings_uuid - state - template - template_name - tools_installed - tools_state - url - uuid - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: project schema: type: string format: uuid - in: query name: project_name schema: type: string - in: query name: project_uuid schema: type: string format: uuid - in: query name: runtime_state schema: type: string - in: query name: service_settings_name schema: type: string - in: query name: service_settings_uuid schema: type: string format: uuid - in: query name: state schema: type: array items: type: string enum: - CREATING - CREATION_SCHEDULED - DELETING - DELETION_SCHEDULED - ERRED - OK - UPDATE_SCHEDULED - UPDATING explode: true style: form - in: query name: uuid schema: type: string format: uuid tags: - vmware-virtual-machine security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/VmwareVirtualMachine' description: '' description: '' headers: x-result-count: $ref: '#/components/headers/XResultCount' post: operationId: vmware_virtual_machine_create tags: - vmware-virtual-machine requestBody: content: application/json: schema: $ref: '#/components/schemas/VmwareVirtualMachineRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/VmwareVirtualMachine' description: '' head: operationId: vmware_virtual_machine_count description: Get number of items in the collection matching the request parameters. parameters: - in: query name: backend_id schema: type: string - in: query name: can_manage schema: type: boolean description: Can manage - in: query name: customer schema: type: string format: uuid - in: query name: customer_abbreviation schema: type: string - in: query name: customer_name schema: type: string - in: query name: customer_native_name schema: type: string - in: query name: customer_uuid schema: type: string format: uuid - in: query name: description schema: type: string - in: query name: external_ip schema: type: string - in: query name: name schema: type: string - in: query name: name_exact schema: type: string - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - in: query name: project schema: type: string format: uuid - in: query name: project_name schema: type: string - in: query name: project_uuid schema: type: string format: uuid - in: query name: runtime_state schema: type: string - in: query name: service_settings_name schema: type: string - in: query name: service_settings_uuid schema: type: string format: uuid - in: query name: state schema: type: array items: type: string enum: - CREATING - CREATION_SCHEDULED - DELETING - DELETION_SCHEDULED - ERRED - OK - UPDATE_SCHEDULED - UPDATING explode: true style: form - in: query name: uuid schema: type: string format: uuid tags: - vmware-virtual-machine security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/vmware-virtual-machine/{uuid}/: get: operationId: vmware_virtual_machine_retrieve parameters: - in: query name: field schema: type: array items: type: string enum: - access_url - backend_id - cluster - cluster_name - cores - cores_per_socket - created - customer - customer_abbreviation - customer_name - customer_native_name - datastore - datastore_name - description - disk - disks - error_message - error_traceback - folder - folder_name - guest_os - guest_os_name - guest_power_state - is_limit_based - is_usage_based - marketplace_category_name - marketplace_category_uuid - marketplace_offering_name - marketplace_offering_plugin_options - marketplace_offering_uuid - marketplace_plan_uuid - marketplace_resource_state - marketplace_resource_uuid - modified - name - networks - ports - project - project_name - project_uuid - ram - resource_type - runtime_state - service_name - service_settings - service_settings_error_message - service_settings_state - service_settings_uuid - state - template - template_name - tools_installed - tools_state - url - uuid - in: path name: uuid schema: type: string format: uuid required: true tags: - vmware-virtual-machine security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/VmwareVirtualMachine' description: '' put: operationId: vmware_virtual_machine_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - vmware-virtual-machine requestBody: content: application/json: schema: $ref: '#/components/schemas/VmwareVirtualMachineRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/VmwareVirtualMachine' description: '' patch: operationId: vmware_virtual_machine_partial_update parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - vmware-virtual-machine requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedVmwareVirtualMachineRequest' security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/VmwareVirtualMachine' description: '' delete: operationId: vmware_virtual_machine_destroy parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - vmware-virtual-machine security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '204': description: No response body /api/vmware-virtual-machine/{uuid}/console/: get: operationId: vmware_virtual_machine_console_retrieve description: This endpoint provides access to Virtual Machine Remote Console aka VMRC. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - vmware-virtual-machine security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ConsoleUrl' description: '' /api/vmware-virtual-machine/{uuid}/create_disk/: post: operationId: vmware_virtual_machine_create_disk parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - vmware-virtual-machine requestBody: content: application/json: schema: $ref: '#/components/schemas/VmwareDiskRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/VmwareDisk' description: '' /api/vmware-virtual-machine/{uuid}/create_port/: post: operationId: vmware_virtual_machine_create_port parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - vmware-virtual-machine requestBody: content: application/json: schema: $ref: '#/components/schemas/VmwarePortRequest' required: true security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/VmwarePort' description: '' /api/vmware-virtual-machine/{uuid}/pull/: post: operationId: vmware_virtual_machine_pull parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - vmware-virtual-machine security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/vmware-virtual-machine/{uuid}/reboot_guest/: post: operationId: vmware_virtual_machine_reboot_guest parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - vmware-virtual-machine security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/vmware-virtual-machine/{uuid}/reset/: post: operationId: vmware_virtual_machine_reset parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - vmware-virtual-machine security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/vmware-virtual-machine/{uuid}/shutdown_guest/: post: operationId: vmware_virtual_machine_shutdown_guest parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - vmware-virtual-machine security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/vmware-virtual-machine/{uuid}/start/: post: operationId: vmware_virtual_machine_start parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - vmware-virtual-machine security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/vmware-virtual-machine/{uuid}/stop/: post: operationId: vmware_virtual_machine_stop parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - vmware-virtual-machine security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/vmware-virtual-machine/{uuid}/suspend/: post: operationId: vmware_virtual_machine_suspend parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - vmware-virtual-machine security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/vmware-virtual-machine/{uuid}/unlink/: post: operationId: vmware_virtual_machine_unlink description: |- Delete resource from the database without scheduling operations on backend and without checking current state of the resource. It is intended to be used for removing resource stuck in transitioning state. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - vmware-virtual-machine security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body /api/vmware-virtual-machine/{uuid}/web_console/: get: operationId: vmware_virtual_machine_web_console_retrieve description: This endpoint provides access to HTML Console aka WMKS. parameters: - in: path name: uuid schema: type: string format: uuid required: true tags: - vmware-virtual-machine security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ConsoleUrl' description: '' /projects/{uuid}/sync_user_roles/: post: operationId: projects_sync_user_roles description: Trigger user role sync for this project. Sends a notification to RabbitMQ that this project needs user role synchronization. parameters: - in: path name: uuid schema: type: string pattern: ^[a-f0-9]+$ required: true tags: - projects security: - tokenAuth: [] - waldurOIDCAuth: [] responses: '200': description: No response body components: schemas: AccessSubnet: type: object description: '' properties: uuid: type: string format: uuid readOnly: true inet: type: string description: type: string maxLength: 2000 customer: type: string format: uri required: - customer - inet - uuid AccessSubnetRequest: type: object description: '' properties: inet: type: string minLength: 1 description: type: string maxLength: 2000 customer: type: string format: uri required: - customer - inet AccountNameGenerationPolicyEnum: enum: - project_slug description: '' AdminAnnouncement: type: object description: '' properties: uuid: type: string format: uuid readOnly: true description: type: string maxLength: 2000 active_from: type: string format: date-time active_to: type: string format: date-time is_active: type: boolean readOnly: true type: $ref: '#/components/schemas/AdminAnnouncementTypeEnum' created: type: string format: date-time readOnly: true maintenance_uuid: type: string readOnly: true maintenance_name: type: string readOnly: true maintenance_type: type: string readOnly: true maintenance_state: type: string readOnly: true maintenance_scheduled_start: type: string format: date-time readOnly: true maintenance_scheduled_end: type: string format: date-time readOnly: true maintenance_service_provider: type: string readOnly: true maintenance_affected_offerings: type: array items: type: object properties: uuid: type: string format: uuid name: type: string impact_level: type: string impact_level_display: type: string impact_description: type: string readOnly: true required: [] AdminAnnouncementRequest: type: object description: '' properties: description: type: string maxLength: 2000 active_from: type: string format: date-time active_to: type: string format: date-time type: $ref: '#/components/schemas/AdminAnnouncementTypeEnum' required: - active_from - active_to AdminAnnouncementTypeEnum: enum: - information - warning - danger type: string description: '' AgreementTypeEnum: enum: - TOS - PP type: string description: '' AllocationTimeEnum: enum: - on_decision - fixed_date type: string description: '' Answer: type: object description: '' properties: uuid: type: string format: uuid readOnly: true question_description: type: string readOnly: true question_type: type: string readOnly: true question_required: type: boolean readOnly: true answer_data: description: Flexible answer storage for different question types requires_review: type: boolean readOnly: true description: Internal flag - this answer requires additional review user: type: integer readOnly: true user_name: type: string readOnly: true created: type: string format: date-time readOnly: true modified: type: string format: date-time readOnly: true required: - created - modified - question_description - question_required - question_type - requires_review - user - user_name - uuid AnswerSubmitRequest: type: object description: '' properties: question_uuid: type: string format: uuid answer_data: nullable: true required: - answer_data - question_uuid AnswerSubmitResponse: type: object description: '' properties: detail: type: string completion: $ref: '#/components/schemas/ChecklistCompletion' required: - completion - detail Attachment: type: object description: '' properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true issue: type: string format: uri issue_key: type: string readOnly: true created: type: string format: date-time readOnly: true file: type: string format: uri mime_type: type: string readOnly: true file_size: type: integer readOnly: true file_name: type: string readOnly: true backend_id: type: string readOnly: true destroy_is_available: type: boolean readOnly: true required: [] AttachmentRequest: type: object description: '' properties: issue: type: string format: uri file: type: string format: binary required: - file - issue AuthResult: type: object properties: uuid: type: string format: uuid readOnly: true token: type: string readOnly: true phone: type: string maxLength: 30 message: type: string readOnly: true description: This message will be shown to user. state: allOf: - $ref: '#/components/schemas/AuthResultStateEnum' readOnly: true error_message: type: string readOnly: true details: type: string readOnly: true description: Cancellation details. required: - details - error_message - message - phone - state - token - uuid description: '' AuthResultRequest: type: object properties: phone: type: string minLength: 1 maxLength: 30 required: - phone description: '' AuthResultStateEnum: enum: - Scheduled - Processing - OK - Canceled - Erred type: string description: '' AuthResultUUIDRequest: type: object properties: uuid: type: string format: uuid description: UUID of the authentication result. required: - uuid description: '' AuthToken: type: object properties: url: type: string format: uri readOnly: true created: type: string format: date-time readOnly: true user: type: string format: uri user_first_name: type: string readOnly: true user_last_name: type: string readOnly: true user_username: type: string description: Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters readOnly: true user_is_active: type: boolean title: Active description: Designates whether this user should be treated as active. Unselect this instead of deleting accounts. readOnly: true user_token_lifetime: type: integer maximum: 2147483647 minimum: 60 nullable: true description: Token lifetime in seconds. readOnly: true required: - created - url - user - user_first_name - user_is_active - user_last_name - user_token_lifetime - user_username description: '' AwsImage: type: object description: '' properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true name: type: string maxLength: 150 region: allOf: - $ref: '#/components/schemas/AwsRegion' readOnly: true required: - name - region - url - uuid AwsInstance: type: object description: '' properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true name: type: string maxLength: 150 description: type: string maxLength: 2000 service_name: type: string readOnly: true service_settings: type: string format: uri service_settings_uuid: type: string format: uuid readOnly: true service_settings_state: type: string readOnly: true service_settings_error_message: type: string readOnly: true project: type: string format: uri project_name: type: string readOnly: true project_uuid: type: string format: uuid readOnly: true customer: type: string format: uri readOnly: true customer_name: type: string readOnly: true customer_native_name: type: string readOnly: true customer_abbreviation: type: string readOnly: true error_message: type: string readOnly: true error_traceback: type: string readOnly: true resource_type: type: string readOnly: true state: allOf: - $ref: '#/components/schemas/CoreStates' readOnly: true created: type: string format: date-time readOnly: true modified: type: string format: date-time readOnly: true backend_id: type: string readOnly: true access_url: type: string nullable: true readOnly: true start_time: type: string format: date-time readOnly: true nullable: true cores: type: integer readOnly: true description: Number of cores in a VM ram: type: integer readOnly: true description: Memory size in MiB disk: type: integer readOnly: true description: Disk size in MiB min_ram: type: integer readOnly: true description: Minimum memory size in MiB min_disk: type: integer readOnly: true description: Minimum disk size in MiB user_data: type: string description: Additional data that will be added to instance on provisioning external_ips: type: array items: type: string format: ipv4 readOnly: true internal_ips: type: array items: type: string format: ipv4 readOnly: true latitude: type: number format: double readOnly: true nullable: true longitude: type: number format: double readOnly: true nullable: true key_name: type: string readOnly: true key_fingerprint: type: string readOnly: true image_name: type: string readOnly: true marketplace_offering_uuid: type: string nullable: true readOnly: true marketplace_offering_name: type: string nullable: true readOnly: true marketplace_offering_plugin_options: type: object additionalProperties: {} nullable: true readOnly: true marketplace_category_uuid: type: string nullable: true readOnly: true marketplace_category_name: type: string nullable: true readOnly: true marketplace_resource_uuid: type: string nullable: true readOnly: true marketplace_plan_uuid: type: string nullable: true readOnly: true marketplace_resource_state: type: string nullable: true readOnly: true is_usage_based: type: boolean nullable: true readOnly: true is_limit_based: type: boolean nullable: true readOnly: true required: [] AwsInstanceRequest: type: object description: '' properties: name: type: string minLength: 1 maxLength: 150 description: type: string maxLength: 2000 service_settings: type: string format: uri project: type: string format: uri ssh_public_key: type: string format: uri writeOnly: true user_data: type: string description: Additional data that will be added to instance on provisioning region: type: string format: uri writeOnly: true image: type: string format: uri writeOnly: true size: type: string format: uri writeOnly: true required: - image - name - project - region - service_settings - size AwsInstanceResize: type: object description: '' properties: size: type: string format: uri required: - size AwsInstanceResizeRequest: type: object description: '' properties: size: type: string format: uri required: - size AwsRegion: type: object description: '' properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true name: type: string maxLength: 150 required: - name - url - uuid AwsSize: type: object description: '' properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true name: type: string readOnly: true cores: type: integer maximum: 32767 minimum: 0 description: Number of cores in a VM ram: type: integer maximum: 2147483647 minimum: 0 description: Memory size in MiB disk: type: integer maximum: 2147483647 minimum: 0 description: Disk size in MiB regions: type: array items: $ref: '#/components/schemas/AwsRegion' readOnly: true description: type: string readOnly: true required: - cores - description - disk - name - ram - regions - url - uuid AwsVolume: type: object description: '' properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true name: type: string maxLength: 150 description: type: string maxLength: 2000 service_name: type: string readOnly: true service_settings: type: string format: uri service_settings_uuid: type: string format: uuid readOnly: true service_settings_state: type: string readOnly: true service_settings_error_message: type: string readOnly: true project: type: string format: uri project_name: type: string readOnly: true project_uuid: type: string format: uuid readOnly: true customer: type: string format: uri readOnly: true customer_name: type: string readOnly: true customer_native_name: type: string readOnly: true customer_abbreviation: type: string readOnly: true error_message: type: string readOnly: true error_traceback: type: string readOnly: true resource_type: type: string readOnly: true state: allOf: - $ref: '#/components/schemas/CoreStates' readOnly: true created: type: string format: date-time readOnly: true modified: type: string format: date-time readOnly: true backend_id: type: string readOnly: true access_url: type: string nullable: true readOnly: true size: type: integer maximum: 2147483647 minimum: 0 description: Size of volume in gigabytes volume_type: $ref: '#/components/schemas/VolumeTypeEnum' device: type: string readOnly: true nullable: true instance: type: string format: uri readOnly: true nullable: true runtime_state: type: string readOnly: true marketplace_offering_uuid: type: string nullable: true readOnly: true marketplace_offering_name: type: string nullable: true readOnly: true marketplace_offering_plugin_options: type: object additionalProperties: {} nullable: true readOnly: true marketplace_category_uuid: type: string nullable: true readOnly: true marketplace_category_name: type: string nullable: true readOnly: true marketplace_resource_uuid: type: string nullable: true readOnly: true marketplace_plan_uuid: type: string nullable: true readOnly: true marketplace_resource_state: type: string nullable: true readOnly: true is_usage_based: type: boolean nullable: true readOnly: true is_limit_based: type: boolean nullable: true readOnly: true required: [] AwsVolumeAttach: type: object description: '' properties: instance: type: string format: uri device: type: string description: The device name for attachment. For example, use /dev/sd[f-p] for Linux instances. maxLength: 128 required: - device - instance AwsVolumeAttachRequest: type: object description: '' properties: instance: type: string format: uri device: type: string minLength: 1 description: The device name for attachment. For example, use /dev/sd[f-p] for Linux instances. maxLength: 128 required: - device - instance AwsVolumeRequest: type: object description: '' properties: name: type: string minLength: 1 maxLength: 150 description: type: string maxLength: 2000 service_settings: type: string format: uri project: type: string format: uri size: type: integer maximum: 2147483647 minimum: 0 description: Size of volume in gigabytes region: type: string format: uri writeOnly: true volume_type: $ref: '#/components/schemas/VolumeTypeEnum' required: - name - project - region - service_settings - size - volume_type AzureImage: type: object description: '' properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true publisher: type: string maxLength: 255 name: type: string maxLength: 150 sku: type: string maxLength: 255 version: type: string maxLength: 255 required: - name - publisher - sku - url - uuid - version AzureLocation: type: object description: '' properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true name: type: string maxLength: 150 latitude: type: number format: double nullable: true longitude: type: number format: double nullable: true required: - name - url - uuid AzurePublicIP: type: object description: '' properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true name: type: string pattern: ^[a-zA-Z][a-zA-Z0-9._-]+$ maxLength: 80 description: type: string maxLength: 2000 service_name: type: string readOnly: true service_settings: type: string format: uri service_settings_uuid: type: string format: uuid readOnly: true service_settings_state: type: string readOnly: true service_settings_error_message: type: string readOnly: true project: type: string format: uri project_name: type: string readOnly: true project_uuid: type: string format: uuid readOnly: true customer: type: string format: uri readOnly: true customer_name: type: string readOnly: true customer_native_name: type: string readOnly: true customer_abbreviation: type: string readOnly: true error_message: type: string readOnly: true error_traceback: type: string readOnly: true resource_type: type: string readOnly: true state: allOf: - $ref: '#/components/schemas/CoreStates' readOnly: true created: type: string format: date-time readOnly: true modified: type: string format: date-time readOnly: true backend_id: type: string readOnly: true access_url: type: string nullable: true readOnly: true location: type: string format: uri resource_group: type: string format: uri marketplace_offering_uuid: type: string nullable: true readOnly: true marketplace_offering_name: type: string nullable: true readOnly: true marketplace_offering_plugin_options: type: object additionalProperties: {} nullable: true readOnly: true marketplace_category_uuid: type: string nullable: true readOnly: true marketplace_category_name: type: string nullable: true readOnly: true marketplace_resource_uuid: type: string nullable: true readOnly: true marketplace_plan_uuid: type: string nullable: true readOnly: true marketplace_resource_state: type: string nullable: true readOnly: true is_usage_based: type: boolean nullable: true readOnly: true is_limit_based: type: boolean nullable: true readOnly: true required: [] AzurePublicIPRequest: type: object description: '' properties: name: type: string minLength: 1 pattern: ^[a-zA-Z][a-zA-Z0-9._-]+$ maxLength: 80 description: type: string maxLength: 2000 service_settings: type: string format: uri project: type: string format: uri location: type: string format: uri resource_group: type: string format: uri required: - location - name - project - resource_group - service_settings AzureResourceGroup: type: object description: '' properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true name: type: string pattern: ^[-\w._()]+$ maxLength: 90 description: type: string maxLength: 2000 service_name: type: string readOnly: true service_settings: type: string format: uri service_settings_uuid: type: string format: uuid readOnly: true service_settings_state: type: string readOnly: true service_settings_error_message: type: string readOnly: true project: type: string format: uri project_name: type: string readOnly: true project_uuid: type: string format: uuid readOnly: true customer: type: string format: uri readOnly: true customer_name: type: string readOnly: true customer_native_name: type: string readOnly: true customer_abbreviation: type: string readOnly: true error_message: type: string readOnly: true error_traceback: type: string readOnly: true resource_type: type: string readOnly: true state: allOf: - $ref: '#/components/schemas/CoreStates' readOnly: true created: type: string format: date-time readOnly: true modified: type: string format: date-time readOnly: true backend_id: type: string readOnly: true access_url: type: string nullable: true readOnly: true location: type: string format: uri marketplace_offering_uuid: type: string nullable: true readOnly: true marketplace_offering_name: type: string nullable: true readOnly: true marketplace_offering_plugin_options: type: object additionalProperties: {} nullable: true readOnly: true marketplace_category_uuid: type: string nullable: true readOnly: true marketplace_category_name: type: string nullable: true readOnly: true marketplace_resource_uuid: type: string nullable: true readOnly: true marketplace_plan_uuid: type: string nullable: true readOnly: true marketplace_resource_state: type: string nullable: true readOnly: true is_usage_based: type: boolean nullable: true readOnly: true is_limit_based: type: boolean nullable: true readOnly: true required: [] AzureSize: type: object description: '' properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true name: type: string maxLength: 150 max_data_disk_count: type: integer maximum: 2147483647 minimum: 0 memory_in_mb: type: integer maximum: 2147483647 minimum: 0 number_of_cores: type: integer maximum: 2147483647 minimum: 0 os_disk_size_in_mb: type: integer maximum: 2147483647 minimum: 0 resource_disk_size_in_mb: type: integer maximum: 2147483647 minimum: 0 required: - max_data_disk_count - memory_in_mb - name - number_of_cores - os_disk_size_in_mb - resource_disk_size_in_mb - url - uuid AzureSqlDatabase: type: object description: '' properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true name: type: string maxLength: 150 description: type: string maxLength: 2000 service_name: type: string readOnly: true service_settings: type: string format: uri service_settings_uuid: type: string format: uuid readOnly: true service_settings_state: type: string readOnly: true service_settings_error_message: type: string readOnly: true project: type: string format: uri project_name: type: string readOnly: true project_uuid: type: string format: uuid readOnly: true customer: type: string format: uri readOnly: true customer_name: type: string readOnly: true customer_native_name: type: string readOnly: true customer_abbreviation: type: string readOnly: true error_message: type: string readOnly: true error_traceback: type: string readOnly: true resource_type: type: string readOnly: true state: allOf: - $ref: '#/components/schemas/CoreStates' readOnly: true created: type: string format: date-time readOnly: true modified: type: string format: date-time readOnly: true backend_id: type: string readOnly: true access_url: type: string nullable: true readOnly: true server: type: string format: uri charset: type: string nullable: true maxLength: 255 collation: type: string nullable: true maxLength: 255 resource_group_name: type: string readOnly: true location_name: type: string readOnly: true server_name: type: string readOnly: true server_uuid: type: string format: uuid readOnly: true server_marketplace_uuid: type: string format: uuid readOnly: true marketplace_offering_uuid: type: string nullable: true readOnly: true marketplace_offering_name: type: string nullable: true readOnly: true marketplace_offering_plugin_options: type: object additionalProperties: {} nullable: true readOnly: true marketplace_category_uuid: type: string nullable: true readOnly: true marketplace_category_name: type: string nullable: true readOnly: true marketplace_resource_uuid: type: string nullable: true readOnly: true marketplace_plan_uuid: type: string nullable: true readOnly: true marketplace_resource_state: type: string nullable: true readOnly: true is_usage_based: type: boolean nullable: true readOnly: true is_limit_based: type: boolean nullable: true readOnly: true required: [] AzureSqlDatabaseCreate: type: object properties: name: type: string maxLength: 150 description: type: string maxLength: 2000 required: - name description: '' AzureSqlDatabaseCreateRequest: type: object properties: name: type: string minLength: 1 maxLength: 150 description: type: string maxLength: 2000 required: - name description: '' AzureSqlDatabaseRequest: type: object description: '' properties: name: type: string minLength: 1 maxLength: 150 description: type: string maxLength: 2000 service_settings: type: string format: uri project: type: string format: uri server: type: string format: uri charset: type: string nullable: true maxLength: 255 collation: type: string nullable: true maxLength: 255 required: - name - project - server - service_settings AzureSqlServer: type: object description: '' properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true name: type: string pattern: ^[a-z0-9][a-z0-9-]+[a-z0-9]$ maxLength: 80 description: type: string maxLength: 2000 service_name: type: string readOnly: true service_settings: type: string format: uri service_settings_uuid: type: string format: uuid readOnly: true service_settings_state: type: string readOnly: true service_settings_error_message: type: string readOnly: true project: type: string format: uri project_name: type: string readOnly: true project_uuid: type: string format: uuid readOnly: true customer: type: string format: uri readOnly: true customer_name: type: string readOnly: true customer_native_name: type: string readOnly: true customer_abbreviation: type: string readOnly: true error_message: type: string readOnly: true error_traceback: type: string readOnly: true resource_type: type: string readOnly: true state: allOf: - $ref: '#/components/schemas/CoreStates' readOnly: true created: type: string format: date-time readOnly: true modified: type: string format: date-time readOnly: true backend_id: type: string readOnly: true access_url: type: string nullable: true readOnly: true resource_group: type: string format: uri readOnly: true username: type: string readOnly: true password: type: string readOnly: true storage_mb: type: integer maximum: 4194304 minimum: 5120 nullable: true fqdn: type: string readOnly: true nullable: true resource_group_name: type: string readOnly: true location_name: type: string readOnly: true marketplace_offering_uuid: type: string nullable: true readOnly: true marketplace_offering_name: type: string nullable: true readOnly: true marketplace_offering_plugin_options: type: object additionalProperties: {} nullable: true readOnly: true marketplace_category_uuid: type: string nullable: true readOnly: true marketplace_category_name: type: string nullable: true readOnly: true marketplace_resource_uuid: type: string nullable: true readOnly: true marketplace_plan_uuid: type: string nullable: true readOnly: true marketplace_resource_state: type: string nullable: true readOnly: true is_usage_based: type: boolean nullable: true readOnly: true is_limit_based: type: boolean nullable: true readOnly: true required: [] AzureSqlServerRequest: type: object description: '' properties: name: type: string minLength: 1 pattern: ^[a-z0-9][a-z0-9-]+[a-z0-9]$ maxLength: 80 description: type: string maxLength: 2000 service_settings: type: string format: uri project: type: string format: uri location: type: string format: uri writeOnly: true storage_mb: type: integer maximum: 4194304 minimum: 5120 nullable: true required: - location - name - project - service_settings AzureVirtualMachine: type: object description: '' properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true name: type: string pattern: ^[a-zA-Z][a-zA-Z0-9-]{0,13}[a-zA-Z0-9]$ maxLength: 15 description: type: string maxLength: 2000 service_name: type: string readOnly: true service_settings: type: string format: uri service_settings_uuid: type: string format: uuid readOnly: true service_settings_state: type: string readOnly: true service_settings_error_message: type: string readOnly: true project: type: string format: uri project_name: type: string readOnly: true project_uuid: type: string format: uuid readOnly: true customer: type: string format: uri readOnly: true customer_name: type: string readOnly: true customer_native_name: type: string readOnly: true customer_abbreviation: type: string readOnly: true error_message: type: string readOnly: true error_traceback: type: string readOnly: true resource_type: type: string readOnly: true state: allOf: - $ref: '#/components/schemas/CoreStates' readOnly: true created: type: string format: date-time readOnly: true modified: type: string format: date-time readOnly: true backend_id: type: string readOnly: true access_url: type: string nullable: true readOnly: true start_time: type: string format: date-time readOnly: true nullable: true cores: type: integer readOnly: true description: Number of cores in a VM ram: type: integer readOnly: true description: Memory size in MiB disk: type: integer readOnly: true description: Disk size in MiB min_ram: type: integer readOnly: true description: Minimum memory size in MiB min_disk: type: integer readOnly: true description: Minimum disk size in MiB user_data: type: string description: Additional data that will be added to instance on provisioning maxLength: 87380 external_ips: type: array items: type: string format: ipv4 readOnly: true internal_ips: type: array items: type: string format: ipv4 readOnly: true latitude: type: number format: double readOnly: true nullable: true longitude: type: number format: double readOnly: true nullable: true key_name: type: string readOnly: true key_fingerprint: type: string readOnly: true image_name: type: string readOnly: true image: type: string format: uri size: type: string format: uri runtime_state: type: string readOnly: true resource_group: type: string format: uri readOnly: true username: type: string readOnly: true password: type: string readOnly: true resource_group_name: type: string readOnly: true location_name: type: string readOnly: true size_name: type: string readOnly: true marketplace_offering_uuid: type: string nullable: true readOnly: true marketplace_offering_name: type: string nullable: true readOnly: true marketplace_offering_plugin_options: type: object additionalProperties: {} nullable: true readOnly: true marketplace_category_uuid: type: string nullable: true readOnly: true marketplace_category_name: type: string nullable: true readOnly: true marketplace_resource_uuid: type: string nullable: true readOnly: true marketplace_plan_uuid: type: string nullable: true readOnly: true marketplace_resource_state: type: string nullable: true readOnly: true is_usage_based: type: boolean nullable: true readOnly: true is_limit_based: type: boolean nullable: true readOnly: true required: [] AzureVirtualMachineRequest: type: object description: '' properties: name: type: string minLength: 1 pattern: ^[a-zA-Z][a-zA-Z0-9-]{0,13}[a-zA-Z0-9]$ maxLength: 15 description: type: string maxLength: 2000 service_settings: type: string format: uri project: type: string format: uri ssh_public_key: type: string format: uri writeOnly: true nullable: true user_data: type: string description: Additional data that will be added to instance on provisioning maxLength: 87380 image: type: string format: uri size: type: string format: uri location: type: string format: uri writeOnly: true required: - image - location - name - project - service_settings - size BackendIdRequest: type: object properties: backend_id: type: string maxLength: 255 description: '' BackendMetadata: type: object properties: state: type: string readOnly: true runtime_state: type: string readOnly: true action: type: string readOnly: true instance_name: type: string readOnly: true nullable: true required: [] description: '' BackendResource: type: object description: '' properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true name: type: string maxLength: 150 created: type: string format: date-time readOnly: true modified: type: string format: date-time readOnly: true project: type: string format: uuid project_name: type: string readOnly: true project_url: type: string format: uri readOnly: true offering: type: string format: uuid offering_name: type: string readOnly: true offering_url: type: string format: uri readOnly: true backend_id: type: string maxLength: 255 backend_metadata: {} required: - created - modified - name - offering - offering_name - offering_url - project - project_name - project_url - url - uuid BackendResourceImportRequest: type: object properties: plan: type: string format: uuid description: '' BackendResourceReq: type: object description: '' properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true created: type: string format: date-time readOnly: true modified: type: string format: date-time readOnly: true started: type: string format: date-time readOnly: true nullable: true description: Time when request processing started finished: type: string format: date-time readOnly: true nullable: true description: Time when request processing finished state: allOf: - $ref: '#/components/schemas/BackendResourceReqStateEnum' readOnly: true offering: type: string format: uuid offering_name: type: string readOnly: true offering_url: type: string format: uri readOnly: true error_message: type: string readOnly: true error_traceback: type: string readOnly: true required: - created - error_message - error_traceback - finished - modified - offering - offering_name - offering_url - started - state - url - uuid BackendResourceReqRequest: type: object description: '' properties: offering: type: string format: uuid required: - offering BackendResourceReqStateEnum: enum: - Sent - Processing - Done - Erred type: string description: '' BackendResourceRequest: type: object description: '' properties: name: type: string minLength: 1 maxLength: 150 project: type: string format: uuid offering: type: string format: uuid backend_id: type: string maxLength: 255 backend_metadata: {} required: - name - offering - project BackendResourceRequestSetErredRequest: type: object description: '' properties: error_message: type: string error_traceback: type: string BaseComponentUsage: type: object description: '' properties: uuid: type: string format: uuid readOnly: true created: type: string format: date-time readOnly: true description: type: string maxLength: 2000 type: type: string description: Unique internal name of the measured unit, for example floating_ip. readOnly: true name: type: string description: Display name for the measured unit, for example, Floating IP. readOnly: true measured_unit: type: string description: Unit of measurement, for example, GB. readOnly: true usage: type: string format: decimal pattern: ^-?\d{0,18}(?:\.\d{0,2})?$ date: type: string format: date-time recurring: type: boolean description: Reported value is reused every month until changed. required: - created - date - measured_unit - name - type - uuid BaseProviderPlan: type: object description: '' properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true name: type: string maxLength: 150 description: type: string article_code: type: string maxLength: 30 max_amount: type: integer maximum: 32767 minimum: 1 nullable: true description: Maximum number of plans that could be active. Plan is disabled when maximum amount is reached. archived: type: boolean description: Forbids creation of new resources. is_active: type: boolean readOnly: true unit_price: type: string format: decimal pattern: ^-?\d{0,12}(?:\.\d{0,10})?$ unit: $ref: '#/components/schemas/BillingUnit' init_price: type: number format: double readOnly: true switch_price: type: number format: double readOnly: true backend_id: type: string maxLength: 255 organization_groups: type: array items: $ref: '#/components/schemas/OrganizationGroup' readOnly: true prices: type: object additionalProperties: type: number format: double readOnly: true future_prices: type: object additionalProperties: type: number format: double readOnly: true quotas: type: object additionalProperties: type: number format: double readOnly: true resources_count: type: integer readOnly: true plan_type: type: string readOnly: true minimal_price: type: number format: double readOnly: true required: [] BaseProviderPlanRequest: type: object description: '' properties: name: type: string minLength: 1 maxLength: 150 description: type: string article_code: type: string maxLength: 30 max_amount: type: integer maximum: 32767 minimum: 1 nullable: true description: Maximum number of plans that could be active. Plan is disabled when maximum amount is reached. archived: type: boolean description: Forbids creation of new resources. unit_price: type: string format: decimal pattern: ^-?\d{0,12}(?:\.\d{0,10})?$ unit: $ref: '#/components/schemas/BillingUnit' backend_id: type: string maxLength: 255 required: - name BasePublicPlan: type: object description: '' properties: url: type: string format: uri uuid: type: string format: uuid readOnly: true name: type: string maxLength: 150 description: type: string article_code: type: string maxLength: 30 max_amount: type: integer maximum: 32767 minimum: 1 nullable: true description: Maximum number of plans that could be active. Plan is disabled when maximum amount is reached. archived: type: boolean description: Forbids creation of new resources. is_active: type: boolean readOnly: true unit_price: type: string format: decimal pattern: ^-?\d{0,12}(?:\.\d{0,10})?$ unit: $ref: '#/components/schemas/BillingUnit' init_price: type: number format: double readOnly: true switch_price: type: number format: double readOnly: true backend_id: type: string maxLength: 255 organization_groups: type: array items: $ref: '#/components/schemas/OrganizationGroup' readOnly: true prices: type: object additionalProperties: type: number format: double readOnly: true future_prices: type: object additionalProperties: type: number format: double readOnly: true quotas: type: object additionalProperties: type: number format: double readOnly: true resources_count: type: integer readOnly: true plan_type: type: string readOnly: true minimal_price: type: number format: double readOnly: true required: [] BasePublicPlanRequest: type: object description: '' properties: url: type: string format: uri name: type: string minLength: 1 maxLength: 150 description: type: string article_code: type: string maxLength: 30 max_amount: type: integer maximum: 32767 minimum: 1 nullable: true description: Maximum number of plans that could be active. Plan is disabled when maximum amount is reached. archived: type: boolean description: Forbids creation of new resources. unit_price: type: string format: decimal pattern: ^-?\d{0,12}(?:\.\d{0,10})?$ unit: $ref: '#/components/schemas/BillingUnit' backend_id: type: string maxLength: 255 required: - name - url BasicCustomer: type: object properties: uuid: type: string format: uuid readOnly: true name: type: string maxLength: 150 required: - name - uuid description: '' BasicUser: type: object properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true username: type: string description: Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters pattern: ^[0-9a-z_.@+-]+$ maxLength: 128 full_name: type: string readOnly: true native_name: type: string maxLength: 100 email: type: string format: email title: Email address maxLength: 320 image: type: string format: uri nullable: true required: [] description: '' BillingTypeEnum: enum: - fixed - usage - limit - one - few type: string description: '' BillingUnit: enum: - month - quarter - half_month - day - hour - quantity type: string description: '' BlankEnum: enum: - '' description: '' Booking: type: object properties: created_by_full_name: type: string nullable: true readOnly: true start: type: string format: date-time end: type: string format: date-time required: - created_by_full_name - end - start description: '' BookingResource: type: object description: '' properties: offering: type: string format: uri offering_name: type: string readOnly: true offering_uuid: type: string format: uuid readOnly: true offering_description: type: string readOnly: true offering_image: type: string format: uri readOnly: true offering_thumbnail: type: string format: uri readOnly: true offering_type: type: string readOnly: true offering_shared: type: boolean description: Accessible to all customers. readOnly: true offering_billable: type: boolean description: Purchase and usage is invoiced. readOnly: true offering_plugin_options: description: Public data used by specific plugin, such as storage mode for OpenStack. readOnly: true provider_name: type: string readOnly: true provider_uuid: type: string format: uuid readOnly: true category_title: type: string readOnly: true category_uuid: type: string format: uuid readOnly: true category_icon: type: string format: uri readOnly: true plan: type: string format: uri plan_unit: allOf: - $ref: '#/components/schemas/BillingUnit' readOnly: true nullable: true plan_name: type: string readOnly: true nullable: true plan_uuid: type: string format: uuid readOnly: true nullable: true plan_description: type: string readOnly: true nullable: true attributes: type: object additionalProperties: {} readOnly: true limits: type: object additionalProperties: type: integer readOnly: true uuid: type: string format: uuid readOnly: true created: type: string format: date-time readOnly: true modified: type: string format: date-time readOnly: true url: type: string format: uri readOnly: true scope: type: string readOnly: true description: type: string readOnly: true state: allOf: - $ref: '#/components/schemas/ResourceState' readOnly: true resource_uuid: type: string format: uuid readOnly: true nullable: true backend_id: type: string readOnly: true effective_id: type: string readOnly: true resource_type: type: string nullable: true readOnly: true project: type: string format: uri readOnly: true project_uuid: type: string format: uuid readOnly: true project_name: type: string readOnly: true project_description: type: string readOnly: true project_end_date: type: string format: date nullable: true description: The date is inclusive. Once reached, all project resource will be scheduled for termination. readOnly: true project_end_date_requested_by: type: string format: uri readOnly: true customer_uuid: type: string format: uuid readOnly: true customer_name: type: string readOnly: true offering_slug: type: string readOnly: true parent_offering_uuid: type: string format: uuid readOnly: true parent_offering_name: type: string readOnly: true parent_offering_slug: type: string readOnly: true parent_uuid: type: string format: uuid readOnly: true parent_name: type: string readOnly: true backend_metadata: allOf: - $ref: '#/components/schemas/BackendMetadata' readOnly: true is_usage_based: type: boolean readOnly: true is_limit_based: type: boolean readOnly: true name: type: string maxLength: 150 slug: type: string maxLength: 50 pattern: ^[-a-zA-Z0-9_]+$ current_usages: type: object additionalProperties: type: integer readOnly: true can_terminate: type: boolean readOnly: true report: type: array items: $ref: '#/components/schemas/ReportSection' readOnly: true end_date: type: string format: date nullable: true description: The date is inclusive. Once reached, a resource will be scheduled for termination. end_date_requested_by: type: string format: uri readOnly: true nullable: true username: type: string nullable: true readOnly: true limit_usage: type: object additionalProperties: type: number format: double readOnly: true downscaled: type: boolean restrict_member_access: type: boolean readOnly: true paused: type: boolean endpoints: type: array items: $ref: '#/components/schemas/NestedEndpoint' readOnly: true error_message: type: string readOnly: true error_traceback: type: string readOnly: true offering_customer_uuid: type: string format: uuid readOnly: true options: readOnly: true nullable: true available_actions: type: array items: type: string readOnly: true last_sync: type: string format: date-time readOnly: true order_in_progress: allOf: - $ref: '#/components/schemas/OrderDetails' readOnly: true nullable: true creation_order: allOf: - $ref: '#/components/schemas/OrderDetails' readOnly: true nullable: true service_settings_uuid: type: string format: uuid readOnly: true project_slug: type: string readOnly: true customer_slug: type: string readOnly: true user_requires_reconsent: type: boolean description: Check if the current user needs to re-consent for this resource's offering. readOnly: true created_by: type: string format: uri readOnly: true created_by_username: type: string description: Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters readOnly: true created_by_full_name: type: string readOnly: true consumer_reviewed_by: type: string format: uri readOnly: true consumer_reviewed_by_username: type: string description: Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters readOnly: true consumer_reviewed_by_full_name: type: string readOnly: true slots: type: array items: $ref: '#/components/schemas/BookingSlot' readOnly: true required: [] BookingSlot: type: object properties: start: type: string format: date-time end: type: string format: date-time backend_id: type: string maxLength: 255 required: [] description: '' BroadcastMessage: type: object description: '' properties: uuid: type: string format: uuid readOnly: true created: type: string format: date-time readOnly: true subject: type: string maxLength: 1000 body: type: string query: {} author_full_name: type: string readOnly: true emails: readOnly: true state: allOf: - $ref: '#/components/schemas/BroadcastMessageStateEnum' readOnly: true send_at: type: string format: date nullable: true required: [] BroadcastMessageRequest: type: object description: '' properties: subject: type: string minLength: 1 maxLength: 1000 body: type: string minLength: 1 query: {} send_at: type: string format: date nullable: true required: - body - query - subject BroadcastMessageStateEnum: enum: - DRAFT - SCHEDULED - SENT type: string description: '' CallAttachDocumentsRequest: type: object properties: documents: type: array items: type: string format: binary description: type: string minLength: 1 required: - documents description: '' CallComplianceOverview: type: object description: '' properties: checklist: type: object additionalProperties: {} nullable: true readOnly: true proposals: type: array items: {} readOnly: true required: - checklist - proposals CallComplianceReviewRequest: type: object description: '' properties: proposal_uuid: type: string format: uuid review_notes: type: string required: - proposal_uuid CallDetachDocumentsRequest: type: object properties: documents: type: array items: type: string format: uuid required: - documents description: '' CallDocument: type: object properties: uuid: type: string format: uuid readOnly: true file: type: string format: uri nullable: true description: Documentation for call for proposals. file_name: type: string readOnly: true file_size: type: integer readOnly: true description: type: string maxLength: 2000 created: type: string format: date-time readOnly: true required: [] description: '' CallDocumentRequest: type: object properties: file: type: string format: binary nullable: true description: Documentation for call for proposals. description: type: string maxLength: 2000 description: '' CallManagingOrganisation: type: object description: '' properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true created: type: string format: date-time readOnly: true description: type: string maxLength: 2000 customer: type: string format: uri customer_name: type: string readOnly: true customer_uuid: type: string format: uuid readOnly: true customer_image: type: string format: uri readOnly: true customer_abbreviation: type: string readOnly: true customer_native_name: type: string readOnly: true customer_country: type: string readOnly: true image: type: string format: uri nullable: true required: - created - customer - customer_abbreviation - customer_country - customer_image - customer_name - customer_native_name - customer_uuid - url - uuid CallManagingOrganisationRequest: type: object description: '' properties: description: type: string maxLength: 2000 customer: type: string format: uri image: type: string format: binary nullable: true required: - customer CallManagingOrganisationStat: type: object properties: open_calls: type: integer readOnly: true active_rounds: type: integer readOnly: true accepted_proposals: type: integer readOnly: true pending_proposals: type: integer readOnly: true pending_review: type: integer readOnly: true rounds_closing_in_one_week: type: integer readOnly: true calls_closing_in_one_week: type: integer readOnly: true offering_requests_pending: type: integer readOnly: true required: - accepted_proposals - active_rounds - calls_closing_in_one_week - offering_requests_pending - open_calls - pending_proposals - pending_review - rounds_closing_in_one_week description: '' CallResourceTemplate: type: object description: '' properties: uuid: type: string format: uuid readOnly: true url: type: string readOnly: true name: type: string maxLength: 255 description: type: string maxLength: 2000 attributes: {} limits: {} is_required: type: boolean description: If True, every proposal must include this resource type requested_offering: type: string format: uri requested_offering_name: type: string readOnly: true requested_offering_uuid: type: string format: uuid readOnly: true requested_offering_plan: allOf: - $ref: '#/components/schemas/BasePublicPlan' readOnly: true created_by: type: string format: uri readOnly: true nullable: true created_by_name: type: string readOnly: true created: type: string format: date-time readOnly: true required: [] CallResourceTemplateRequest: type: object description: '' properties: name: type: string minLength: 1 maxLength: 255 description: type: string maxLength: 2000 attributes: {} limits: {} is_required: type: boolean description: If True, every proposal must include this resource type requested_offering: type: string format: uri required: - name - requested_offering CallRound: type: object properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true start_time: type: string format: date-time cutoff_time: type: string format: date-time call_uuid: type: string format: uuid readOnly: true call_name: type: string readOnly: true status: allOf: - $ref: '#/components/schemas/StatusEnum' readOnly: true required: - call_name - call_uuid - cutoff_time - start_time - status - url - uuid description: '' CallStates: enum: - draft - active - archived type: string description: '' Campaign: type: object description: '' properties: uuid: type: string format: uuid readOnly: true name: type: string maxLength: 150 url: type: string format: uri readOnly: true start_date: type: string format: date description: Starting from this date, the campaign is active. end_date: type: string format: date description: The last day the campaign is active. coupon: type: string description: If coupon is empty, campaign is available to all users. maxLength: 255 discount_type: $ref: '#/components/schemas/DiscountTypeEnum' discount: type: integer maximum: 2147483647 minimum: -2147483648 stock: type: integer maximum: 2147483647 minimum: 0 nullable: true description: type: string maxLength: 2000 months: type: integer maximum: 2147483647 minimum: 0 description: How many months in a row should the related service (when activated) get special deal (0 for indefinitely until active) auto_apply: type: boolean state: type: string readOnly: true service_provider: type: string format: uri offerings: type: array items: $ref: '#/components/schemas/CampaignOffering' readOnly: true required_offerings: type: array items: type: string format: uuid required: - discount - discount_type - end_date - name - offerings - service_provider - start_date - state - url - uuid CampaignOffering: type: object properties: uuid: type: string format: uuid readOnly: true name: type: string maxLength: 150 required: - name - uuid description: '' CampaignRequest: type: object description: '' properties: name: type: string minLength: 1 maxLength: 150 start_date: type: string format: date description: Starting from this date, the campaign is active. end_date: type: string format: date description: The last day the campaign is active. coupon: type: string description: If coupon is empty, campaign is available to all users. maxLength: 255 discount_type: $ref: '#/components/schemas/DiscountTypeEnum' discount: type: integer maximum: 2147483647 minimum: -2147483648 stock: type: integer maximum: 2147483647 minimum: 0 nullable: true description: type: string maxLength: 2000 months: type: integer maximum: 2147483647 minimum: 0 description: How many months in a row should the related service (when activated) get special deal (0 for indefinitely until active) auto_apply: type: boolean service_provider: type: string format: uri offerings: type: array items: type: string format: uuid writeOnly: true writeOnly: true required_offerings: type: array items: type: string format: uuid required: - discount - discount_type - end_date - name - offerings - service_provider - start_date CancelRequestResponse: type: object properties: uuid: type: string description: UUID of the canceled permission request scope_name: type: string description: Name of the invitation scope scope_uuid: type: string description: UUID of the invitation scope required: - scope_name - scope_uuid - uuid description: '' CategoryColumn: type: object properties: uuid: type: string format: uuid readOnly: true index: type: integer maximum: 32767 minimum: 0 description: Index allows to reorder columns. title: type: string description: Title is rendered as column header. maxLength: 255 attribute: type: string description: Resource attribute is rendered as table cell. maxLength: 255 widget: nullable: true description: Widget field allows to customise table cell rendering. oneOf: - $ref: '#/components/schemas/WidgetEnum' - $ref: '#/components/schemas/BlankEnum' - $ref: '#/components/schemas/NullEnum' category: type: string format: uri required: - category - index - title - uuid description: '' CategoryColumnRequest: type: object properties: index: type: integer maximum: 32767 minimum: 0 description: Index allows to reorder columns. title: type: string minLength: 1 description: Title is rendered as column header. maxLength: 255 attribute: type: string description: Resource attribute is rendered as table cell. maxLength: 255 widget: nullable: true description: Widget field allows to customise table cell rendering. oneOf: - $ref: '#/components/schemas/WidgetEnum' - $ref: '#/components/schemas/BlankEnum' - $ref: '#/components/schemas/NullEnum' category: type: string format: uri required: - category - index - title description: '' CategoryComponent: type: object properties: type: type: string description: Unique internal name of the measured unit, for example floating_ip. pattern: ^[a-zA-Z0-9_\-\/:]+$ maxLength: 50 name: type: string description: Display name for the measured unit, for example, Floating IP. maxLength: 150 description: type: string maxLength: 2000 measured_unit: type: string description: Unit of measurement, for example, GB. maxLength: 30 required: [] description: '' CategoryComponentRequest: type: object properties: type: type: string minLength: 1 description: Unique internal name of the measured unit, for example floating_ip. pattern: ^[a-zA-Z0-9_\-\/:]+$ maxLength: 50 name: type: string minLength: 1 description: Display name for the measured unit, for example, Floating IP. maxLength: 150 description: type: string maxLength: 2000 measured_unit: type: string description: Unit of measurement, for example, GB. maxLength: 30 required: - name - type description: '' CategoryComponentUsage: type: object description: '' properties: name: type: string description: Display name for the measured unit, for example, Floating IP. readOnly: true type: type: string description: Unique internal name of the measured unit, for example floating_ip. readOnly: true measured_unit: type: string description: Unit of measurement, for example, GB. readOnly: true category_title: type: string readOnly: true category_uuid: type: string format: uuid readOnly: true date: type: string format: date reported_usage: type: integer maximum: 9223372036854775807 minimum: -9223372036854775808 format: int64 nullable: true fixed_usage: type: integer maximum: 9223372036854775807 minimum: -9223372036854775808 format: int64 nullable: true scope: type: string required: [] CategoryComponents: type: object properties: uuid: type: string format: uuid readOnly: true type: type: string description: Unique internal name of the measured unit, for example floating_ip. pattern: ^[a-zA-Z0-9_\-\/:]+$ maxLength: 50 name: type: string description: Display name for the measured unit, for example, Floating IP. maxLength: 150 description: type: string maxLength: 2000 measured_unit: type: string description: Unit of measurement, for example, GB. maxLength: 30 category: $ref: '#/components/schemas/CategorySerializerForForNestedFields' required: - category - name - type - uuid description: '' CategoryComponentsRequest: type: object properties: type: type: string minLength: 1 description: Unique internal name of the measured unit, for example floating_ip. pattern: ^[a-zA-Z0-9_\-\/:]+$ maxLength: 50 name: type: string minLength: 1 description: Display name for the measured unit, for example, Floating IP. maxLength: 150 description: type: string maxLength: 2000 measured_unit: type: string description: Unit of measurement, for example, GB. maxLength: 30 category: $ref: '#/components/schemas/CategorySerializerForForNestedFieldsRequest' required: - category - name - type description: '' CategoryGroup: type: object description: '' properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true title: type: string maxLength: 255 description: type: string icon: type: string format: uri nullable: true required: [] CategoryGroupRequest: type: object description: '' properties: title: type: string minLength: 1 maxLength: 255 description: type: string icon: type: string format: binary nullable: true required: - title CategoryHelpArticle: type: object properties: title: type: string nullable: true maxLength: 255 url: type: string format: uri maxLength: 200 required: [] description: '' CategoryHelpArticleRequest: type: object properties: title: type: string nullable: true maxLength: 255 url: type: string format: uri minLength: 1 maxLength: 200 required: - url description: '' CategoryHelpArticles: type: object properties: title: type: string nullable: true maxLength: 255 url: type: string format: uri maxLength: 200 categories: type: array items: $ref: '#/components/schemas/CategorySerializerForForNestedFields' required: - categories - url description: '' CategoryHelpArticlesRequest: type: object properties: title: type: string nullable: true maxLength: 255 url: type: string format: uri minLength: 1 maxLength: 200 categories: type: array items: $ref: '#/components/schemas/CategorySerializerForForNestedFieldsRequest' required: - categories - url description: '' CategorySerializerForForNestedFields: type: object properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true title: type: string maxLength: 255 required: - title - url - uuid description: '' CategorySerializerForForNestedFieldsRequest: type: object properties: title: type: string minLength: 1 maxLength: 255 required: - title description: '' Checklist: type: object description: '' properties: uuid: type: string format: uuid readOnly: true url: type: string format: uri readOnly: true name: type: string maxLength: 150 description: type: string maxLength: 2000 checklist_type: allOf: - $ref: '#/components/schemas/ChecklistTypeEnum' description: Type of compliance this checklist addresses questions_count: type: integer readOnly: true category_name: type: string readOnly: true category_uuid: type: string format: uuid readOnly: true category: type: string format: uuid nullable: true description: Category of the checklist required: - category_name - category_uuid - name - questions_count - url - uuid ChecklistCategory: type: object properties: uuid: type: string format: uuid readOnly: true icon: type: string format: uri nullable: true url: type: string format: uri readOnly: true name: type: string maxLength: 150 description: type: string maxLength: 2000 checklists_count: type: integer readOnly: true required: - checklists_count - name - url - uuid description: '' ChecklistCategoryRequest: type: object properties: icon: type: string format: binary nullable: true name: type: string minLength: 1 maxLength: 150 description: type: string maxLength: 2000 required: - name description: '' ChecklistCompletion: type: object description: '' properties: uuid: type: string format: uuid readOnly: true is_completed: type: boolean readOnly: true description: Whether all required questions have been answered completion_percentage: type: number format: double readOnly: true unanswered_required_questions: type: array items: {} readOnly: true checklist_name: type: string readOnly: true checklist_description: type: string readOnly: true created: type: string format: date-time readOnly: true modified: type: string format: date-time readOnly: true required: - checklist_description - checklist_name - completion_percentage - created - is_completed - modified - unanswered_required_questions - uuid ChecklistCompletionReviewer: type: object description: '' properties: uuid: type: string format: uuid readOnly: true is_completed: type: boolean readOnly: true description: Whether all required questions have been answered completion_percentage: type: number format: double readOnly: true unanswered_required_questions: type: array items: {} readOnly: true checklist_name: type: string readOnly: true checklist_description: type: string readOnly: true created: type: string format: date-time readOnly: true modified: type: string format: date-time readOnly: true requires_review: type: boolean readOnly: true description: Whether any answers triggered review requirements reviewed_by: type: integer nullable: true description: User who reviewed the checklist completion reviewed_by_name: type: string readOnly: true reviewed_at: type: string format: date-time nullable: true review_notes: type: string description: Notes from the reviewer review_trigger_summary: type: array items: {} readOnly: true required: - checklist_description - checklist_name - completion_percentage - created - is_completed - modified - requires_review - review_trigger_summary - reviewed_by_name - unanswered_required_questions - uuid ChecklistInfo: type: object description: '' properties: uuid: type: string format: uuid readOnly: true name: type: string readOnly: true checklist_type: type: string readOnly: true required: - checklist_type - name - uuid ChecklistOperators: enum: - equals - not_equals - contains - in - not_in type: string description: '' ChecklistRequest: type: object description: '' properties: name: type: string minLength: 1 maxLength: 150 description: type: string maxLength: 2000 checklist_type: allOf: - $ref: '#/components/schemas/ChecklistTypeEnum' description: Type of compliance this checklist addresses category: type: string format: uuid nullable: true description: Category of the checklist required: - name ChecklistResponse: type: object description: '' properties: checklist: type: object additionalProperties: {} readOnly: true completion: $ref: '#/components/schemas/ChecklistCompletion' questions: type: array items: $ref: '#/components/schemas/QuestionWithAnswer' required: - checklist - completion - questions ChecklistReviewerResponse: type: object description: '' properties: checklist: type: object additionalProperties: {} readOnly: true completion: $ref: '#/components/schemas/ChecklistCompletionReviewer' questions: type: array items: $ref: '#/components/schemas/QuestionWithAnswerReviewer' required: - checklist - completion - questions ChecklistTypeEnum: enum: - project_compliance - proposal_compliance - offering_compliance - project_metadata type: string description: '' ClusterSecurityGroup: type: object properties: uuid: type: string format: uuid readOnly: true name: type: string readOnly: true description: type: string readOnly: true rules: type: array items: $ref: '#/components/schemas/RancherClusterSecurityGroupRule' required: - description - name - rules - uuid description: '' ClusterSecurityGroupRequest: type: object properties: rules: type: array items: $ref: '#/components/schemas/RancherClusterSecurityGroupRuleRequest' required: - rules description: '' Comment: type: object description: '' properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true issue: type: string format: uri readOnly: true issue_key: type: string readOnly: true description: type: string is_public: type: boolean author_name: type: string readOnly: true author_uuid: type: string format: uuid readOnly: true author_user: type: string format: uri readOnly: true author_email: type: string format: email title: Email address readOnly: true backend_id: type: string readOnly: true nullable: true remote_id: type: string nullable: true maxLength: 255 created: type: string format: date-time readOnly: true update_is_available: type: boolean readOnly: true destroy_is_available: type: boolean readOnly: true required: - author_email - author_name - author_user - author_uuid - backend_id - created - description - destroy_is_available - issue - issue_key - update_is_available - url - uuid CommentRequest: type: object description: '' properties: description: type: string minLength: 1 is_public: type: boolean required: - description ComplianceOverview: type: object description: '' properties: total_projects: type: integer readOnly: true projects_with_completions: type: integer readOnly: true fully_completed_projects: type: integer readOnly: true projects_requiring_review: type: integer readOnly: true average_completion_percentage: type: number format: double readOnly: true required: - average_completion_percentage - fully_completed_projects - projects_requiring_review - projects_with_completions - total_projects ComponentStats: type: object properties: type: type: string readOnly: true name: type: string readOnly: true description: type: string readOnly: true measured_unit: type: string readOnly: true billing_type: type: string readOnly: true usage: type: integer readOnly: true limit_usage: type: integer readOnly: true limit: type: integer readOnly: true offering_name: type: string readOnly: true offering_uuid: type: string format: uuid readOnly: true required: - billing_type - description - limit - limit_usage - measured_unit - name - offering_name - offering_uuid - type - usage description: '' ComponentUsage: type: object description: '' properties: uuid: type: string format: uuid readOnly: true created: type: string format: date-time readOnly: true description: type: string maxLength: 2000 type: type: string description: Unique internal name of the measured unit, for example floating_ip. readOnly: true name: type: string description: Display name for the measured unit, for example, Floating IP. readOnly: true measured_unit: type: string description: Unit of measurement, for example, GB. readOnly: true usage: type: integer readOnly: true date: type: string format: date-time recurring: type: boolean description: Reported value is reused every month until changed. resource_name: type: string readOnly: true resource_uuid: type: string format: uuid readOnly: true offering_name: type: string readOnly: true offering_uuid: type: string format: uuid readOnly: true project_name: type: string readOnly: true project_uuid: type: string readOnly: true customer_name: type: string readOnly: true customer_uuid: type: string readOnly: true billing_period: type: string format: date modified_by: type: integer nullable: true required: [] ComponentUsageCreateRequest: type: object properties: usages: type: array items: $ref: '#/components/schemas/ComponentUsageItemRequest' plan_period: type: string format: uuid resource: type: string format: uuid required: - usages description: '' ComponentUsageItemRequest: type: object properties: type: type: string minLength: 1 amount: type: string format: decimal pattern: ^-?\d{0,18}(?:\.\d{0,2})?$ description: type: string recurring: type: boolean default: false required: - amount - type description: '' ComponentUsagesPerMonthStats: type: object properties: usage: type: string format: decimal pattern: ^-?\d{0,18}(?:\.\d{0,2})?$ offering_uuid: type: string format: uuid component_type: type: string offering_country: type: string readOnly: true organization_group_name: type: string readOnly: true organization_group_uuid: type: string readOnly: true month: type: integer year: type: integer required: - component_type - month - offering_country - offering_uuid - organization_group_name - organization_group_uuid - usage - year description: '' ComponentUsagesPerProject: type: object properties: project_uuid: type: string format: uuid component_type: type: string usage: type: integer readOnly: true required: - component_type - project_uuid - usage description: '' ComponentUsagesStats: type: object properties: usage: type: string format: decimal pattern: ^-?\d{0,18}(?:\.\d{0,2})?$ offering_uuid: type: string format: uuid component_type: type: string offering_country: type: string readOnly: true organization_group_name: type: string readOnly: true organization_group_uuid: type: string readOnly: true required: - component_type - offering_country - offering_uuid - organization_group_name - organization_group_uuid - usage description: '' ComponentUserUsage: type: object description: '' properties: uuid: type: string format: uuid readOnly: true user: type: string format: uri username: type: string maxLength: 100 component_usage: type: string format: uri usage: type: integer readOnly: true measured_unit: type: string description: Unit of measurement, for example, GB. readOnly: true description: type: string maxLength: 2000 created: type: string format: date-time readOnly: true modified: type: string format: date-time readOnly: true backend_id: type: string maxLength: 255 resource_name: type: string readOnly: true resource_uuid: type: string format: uuid readOnly: true offering_name: type: string readOnly: true offering_uuid: type: string format: uuid readOnly: true project_name: type: string readOnly: true project_uuid: type: string format: uuid readOnly: true customer_name: type: string readOnly: true customer_uuid: type: string format: uuid readOnly: true component_type: type: string description: Unique internal name of the measured unit, for example floating_ip. readOnly: true date: type: string format: date-time readOnly: true billing_period: type: string format: date readOnly: true required: [] ComponentUserUsageCreateRequest: type: object properties: usage: type: string format: decimal pattern: ^-?\d{0,18}(?:\.\d{0,2})?$ username: type: string minLength: 1 maxLength: 100 user: type: string format: uri required: - username description: '' ComponentUserUsageLimit: type: object properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true resource: type: string format: uri component: type: string format: uuid component_type: type: string description: Unique internal name of the measured unit, for example floating_ip. readOnly: true user: type: string format: uri limit: type: string format: decimal pattern: ^-?\d{0,18}(?:\.\d{0,2})?$ required: - component - component_type - resource - url - user - uuid description: '' ComponentUserUsageLimitRequest: type: object properties: resource: type: string format: uri component: type: string format: uuid user: type: string format: uri limit: type: string format: decimal pattern: ^-?\d{0,18}(?:\.\d{0,2})?$ required: - component - resource - user description: '' ComponentsUsageStats: type: object properties: components: type: array items: $ref: '#/components/schemas/ComponentStats' readOnly: true required: - components description: '' ConfirmEmailRequestRequest: type: object properties: code: type: string minLength: 1 required: - code description: '' ConsoleUrl: type: object properties: url: type: string format: uri readOnly: true required: - url description: '' ConstanceSettings: type: object properties: SITE_NAME: type: string SITE_DESCRIPTION: type: string HOMEPORT_URL: type: string RANCHER_USERNAME_INPUT_LABEL: type: string SITE_ADDRESS: type: string SITE_EMAIL: type: string SITE_PHONE: type: string CURRENCY_NAME: type: string THUMBNAIL_SIZE: type: string ANONYMOUS_USER_CAN_VIEW_OFFERINGS: type: boolean ANONYMOUS_USER_CAN_VIEW_PLANS: type: boolean NOTIFY_STAFF_ABOUT_APPROVALS: type: boolean NOTIFY_ABOUT_RESOURCE_CHANGE: type: boolean DISABLE_SENDING_NOTIFICATIONS_ABOUT_RESOURCE_UPDATE: type: boolean MARKETPLACE_LANDING_PAGE: type: string ENABLE_STALE_RESOURCE_NOTIFICATIONS: type: boolean TELEMETRY_URL: type: string TELEMETRY_VERSION: type: integer SCRIPT_RUN_MODE: type: string DOCKER_CLIENT: type: string DOCKER_RUN_OPTIONS: type: string DOCKER_SCRIPT_DIR: type: string DOCKER_REMOVE_CONTAINER: type: boolean DOCKER_IMAGES: type: string DOCKER_VOLUME_NAME: type: string K8S_NAMESPACE: type: string K8S_CONFIG_PATH: type: string K8S_JOB_TIMEOUT: type: integer ENABLE_STRICT_CHECK_ACCEPTING_INVITATION: type: boolean INVITATION_DISABLE_MULTIPLE_ROLES: type: boolean DEFAULT_IDP: type: string DOCS_URL: type: string format: uri SHORT_PAGE_TITLE: type: string FULL_PAGE_TITLE: type: string BRAND_COLOR: type: string pattern: ^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$ HERO_LINK_LABEL: type: string HERO_LINK_URL: type: string format: uri SUPPORT_PORTAL_URL: type: string format: uri COMMON_FOOTER_TEXT: type: string COMMON_FOOTER_HTML: type: string LANGUAGE_CHOICES: type: string DISABLE_DARK_THEME: type: boolean POWERED_BY_LOGO: type: string format: uri nullable: true HERO_IMAGE: type: string format: uri nullable: true MARKETPLACE_HERO_IMAGE: type: string format: uri nullable: true CALL_MANAGEMENT_HERO_IMAGE: type: string format: uri nullable: true SIDEBAR_LOGO: type: string format: uri nullable: true SIDEBAR_LOGO_DARK: type: string format: uri nullable: true SIDEBAR_LOGO_MOBILE: type: string format: uri nullable: true SIDEBAR_STYLE: type: string SITE_LOGO: type: string format: uri nullable: true LOGIN_LOGO: type: string format: uri nullable: true FAVICON: type: string format: uri nullable: true OFFERING_LOGO_PLACEHOLDER: type: string format: uri nullable: true WALDUR_SUPPORT_ENABLED: type: boolean WALDUR_SUPPORT_ACTIVE_BACKEND_TYPE: type: string WALDUR_SUPPORT_DISPLAY_REQUEST_TYPE: type: boolean ATLASSIAN_USE_OLD_API: type: boolean ATLASSIAN_USE_TEENAGE_API: type: boolean ATLASSIAN_USE_AUTOMATIC_REQUEST_MAPPING: type: boolean ATLASSIAN_MAP_WALDUR_USERS_TO_SERVICEDESK_AGENTS: type: boolean ATLASSIAN_STRANGE_SETTING: type: integer ATLASSIAN_API_URL: type: string format: uri ATLASSIAN_USERNAME: type: string ATLASSIAN_PASSWORD: type: string ATLASSIAN_EMAIL: type: string format: email ATLASSIAN_TOKEN: type: string ATLASSIAN_VERIFY_SSL: type: boolean ATLASSIAN_PROJECT_ID: type: string ATLASSIAN_SHARED_USERNAME: type: boolean ATLASSIAN_CUSTOM_ISSUE_FIELD_MAPPING_ENABLED: type: boolean ATLASSIAN_DEFAULT_OFFERING_ISSUE_TYPE: type: string ATLASSIAN_EXCLUDED_ATTACHMENT_TYPES: type: string ATLASSIAN_PULL_PRIORITIES: type: boolean ATLASSIAN_ISSUE_TYPES: type: string ATLASSIAN_DESCRIPTION_TEMPLATE: type: string ATLASSIAN_SUMMARY_TEMPLATE: type: string ATLASSIAN_AFFECTED_RESOURCE_FIELD: type: string ATLASSIAN_IMPACT_FIELD: type: string ATLASSIAN_ORGANISATION_FIELD: type: string ATLASSIAN_RESOLUTION_SLA_FIELD: type: string ATLASSIAN_PROJECT_FIELD: type: string ATLASSIAN_REPORTER_FIELD: type: string ATLASSIAN_CALLER_FIELD: type: string ATLASSIAN_SLA_FIELD: type: string ATLASSIAN_LINKED_ISSUE_TYPE: type: string ATLASSIAN_SATISFACTION_FIELD: type: string ATLASSIAN_REQUEST_FEEDBACK_FIELD: type: string ATLASSIAN_TEMPLATE_FIELD: type: string ZAMMAD_API_URL: type: string format: uri ZAMMAD_TOKEN: type: string ZAMMAD_GROUP: type: string ZAMMAD_ARTICLE_TYPE: type: string ZAMMAD_COMMENT_MARKER: type: string ZAMMAD_COMMENT_PREFIX: type: string ZAMMAD_COMMENT_COOLDOWN_DURATION: type: integer SMAX_API_URL: type: string format: uri SMAX_TENANT_ID: type: string SMAX_LOGIN: type: string SMAX_PASSWORD: type: string SMAX_ORGANISATION_FIELD: type: string SMAX_PROJECT_FIELD: type: string SMAX_AFFECTED_RESOURCE_FIELD: type: string SMAX_TIMES_TO_PULL: type: integer SMAX_SECONDS_TO_WAIT: type: integer SMAX_CREATION_SOURCE_NAME: type: string SMAX_REQUESTS_OFFERING: type: string SMAX_VERIFY_SSL: type: boolean ENABLE_MOCK_SERVICE_ACCOUNT_BACKEND: type: boolean PROPOSAL_REVIEW_DURATION: type: integer USER_TABLE_COLUMNS: type: string AUTO_APPROVE_USER_TOS: type: boolean FREEIPA_ENABLED: type: boolean FREEIPA_HOSTNAME: type: string FREEIPA_USERNAME: type: string FREEIPA_PASSWORD: type: string FREEIPA_VERIFY_SSL: type: boolean FREEIPA_USERNAME_PREFIX: type: string FREEIPA_GROUPNAME_PREFIX: type: string FREEIPA_BLACKLISTED_USERNAMES: type: array items: type: string FREEIPA_GROUP_SYNCHRONIZATION_ENABLED: type: boolean KEYCLOAK_ICON: type: string format: uri nullable: true COUNTRIES: type: array items: type: string OIDC_AUTH_URL: type: string OIDC_INTROSPECTION_URL: type: string OIDC_CLIENT_ID: type: string OIDC_CLIENT_SECRET: type: string OIDC_USER_FIELD: type: string OIDC_CACHE_TIMEOUT: type: integer DEACTIVATE_USER_IF_NO_ROLES: type: boolean MAINTENANCE_ANNOUNCEMENT_NOTIFY_BEFORE_MINUTES: type: integer MAINTENANCE_ANNOUNCEMENT_NOTIFY_SYSTEM: type: array items: type: string ENFORCE_USER_CONSENT_FOR_OFFERINGS: type: boolean description: '' ConstanceSettingsRequest: type: object properties: SITE_NAME: type: string SITE_DESCRIPTION: type: string HOMEPORT_URL: type: string RANCHER_USERNAME_INPUT_LABEL: type: string SITE_ADDRESS: type: string SITE_EMAIL: type: string SITE_PHONE: type: string CURRENCY_NAME: type: string THUMBNAIL_SIZE: type: string ANONYMOUS_USER_CAN_VIEW_OFFERINGS: type: boolean ANONYMOUS_USER_CAN_VIEW_PLANS: type: boolean NOTIFY_STAFF_ABOUT_APPROVALS: type: boolean NOTIFY_ABOUT_RESOURCE_CHANGE: type: boolean DISABLE_SENDING_NOTIFICATIONS_ABOUT_RESOURCE_UPDATE: type: boolean MARKETPLACE_LANDING_PAGE: type: string ENABLE_STALE_RESOURCE_NOTIFICATIONS: type: boolean TELEMETRY_URL: type: string TELEMETRY_VERSION: type: integer SCRIPT_RUN_MODE: type: string DOCKER_CLIENT: type: string minLength: 1 DOCKER_RUN_OPTIONS: type: string minLength: 1 DOCKER_SCRIPT_DIR: type: string DOCKER_REMOVE_CONTAINER: type: boolean DOCKER_IMAGES: type: string minLength: 1 DOCKER_VOLUME_NAME: type: string K8S_NAMESPACE: type: string K8S_CONFIG_PATH: type: string K8S_JOB_TIMEOUT: type: integer ENABLE_STRICT_CHECK_ACCEPTING_INVITATION: type: boolean INVITATION_DISABLE_MULTIPLE_ROLES: type: boolean DEFAULT_IDP: type: string DOCS_URL: type: string format: uri SHORT_PAGE_TITLE: type: string FULL_PAGE_TITLE: type: string BRAND_COLOR: type: string pattern: ^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$ HERO_LINK_LABEL: type: string HERO_LINK_URL: type: string format: uri SUPPORT_PORTAL_URL: type: string format: uri COMMON_FOOTER_TEXT: type: string minLength: 1 COMMON_FOOTER_HTML: type: string minLength: 1 LANGUAGE_CHOICES: type: string DISABLE_DARK_THEME: type: boolean POWERED_BY_LOGO: type: string format: binary nullable: true HERO_IMAGE: type: string format: binary nullable: true MARKETPLACE_HERO_IMAGE: type: string format: binary nullable: true CALL_MANAGEMENT_HERO_IMAGE: type: string format: binary nullable: true SIDEBAR_LOGO: type: string format: binary nullable: true SIDEBAR_LOGO_DARK: type: string format: binary nullable: true SIDEBAR_LOGO_MOBILE: type: string format: binary nullable: true SIDEBAR_STYLE: type: string SITE_LOGO: type: string format: binary nullable: true LOGIN_LOGO: type: string format: binary nullable: true FAVICON: type: string format: binary nullable: true OFFERING_LOGO_PLACEHOLDER: type: string format: binary nullable: true WALDUR_SUPPORT_ENABLED: type: boolean WALDUR_SUPPORT_ACTIVE_BACKEND_TYPE: type: string WALDUR_SUPPORT_DISPLAY_REQUEST_TYPE: type: boolean ATLASSIAN_USE_OLD_API: type: boolean ATLASSIAN_USE_TEENAGE_API: type: boolean ATLASSIAN_USE_AUTOMATIC_REQUEST_MAPPING: type: boolean ATLASSIAN_MAP_WALDUR_USERS_TO_SERVICEDESK_AGENTS: type: boolean ATLASSIAN_STRANGE_SETTING: type: integer ATLASSIAN_API_URL: type: string format: uri ATLASSIAN_USERNAME: type: string ATLASSIAN_PASSWORD: type: string ATLASSIAN_EMAIL: type: string format: email minLength: 1 ATLASSIAN_TOKEN: type: string ATLASSIAN_VERIFY_SSL: type: boolean ATLASSIAN_PROJECT_ID: type: string ATLASSIAN_SHARED_USERNAME: type: boolean ATLASSIAN_CUSTOM_ISSUE_FIELD_MAPPING_ENABLED: type: boolean ATLASSIAN_DEFAULT_OFFERING_ISSUE_TYPE: type: string ATLASSIAN_EXCLUDED_ATTACHMENT_TYPES: type: string ATLASSIAN_PULL_PRIORITIES: type: boolean ATLASSIAN_ISSUE_TYPES: type: string ATLASSIAN_DESCRIPTION_TEMPLATE: type: string ATLASSIAN_SUMMARY_TEMPLATE: type: string ATLASSIAN_AFFECTED_RESOURCE_FIELD: type: string ATLASSIAN_IMPACT_FIELD: type: string ATLASSIAN_ORGANISATION_FIELD: type: string ATLASSIAN_RESOLUTION_SLA_FIELD: type: string ATLASSIAN_PROJECT_FIELD: type: string ATLASSIAN_REPORTER_FIELD: type: string ATLASSIAN_CALLER_FIELD: type: string ATLASSIAN_SLA_FIELD: type: string ATLASSIAN_LINKED_ISSUE_TYPE: type: string ATLASSIAN_SATISFACTION_FIELD: type: string ATLASSIAN_REQUEST_FEEDBACK_FIELD: type: string ATLASSIAN_TEMPLATE_FIELD: type: string ZAMMAD_API_URL: type: string format: uri ZAMMAD_TOKEN: type: string ZAMMAD_GROUP: type: string ZAMMAD_ARTICLE_TYPE: type: string ZAMMAD_COMMENT_MARKER: type: string ZAMMAD_COMMENT_PREFIX: type: string ZAMMAD_COMMENT_COOLDOWN_DURATION: type: integer SMAX_API_URL: type: string format: uri SMAX_TENANT_ID: type: string SMAX_LOGIN: type: string SMAX_PASSWORD: type: string SMAX_ORGANISATION_FIELD: type: string SMAX_PROJECT_FIELD: type: string SMAX_AFFECTED_RESOURCE_FIELD: type: string SMAX_TIMES_TO_PULL: type: integer SMAX_SECONDS_TO_WAIT: type: integer SMAX_CREATION_SOURCE_NAME: type: string SMAX_REQUESTS_OFFERING: type: string SMAX_VERIFY_SSL: type: boolean ENABLE_MOCK_SERVICE_ACCOUNT_BACKEND: type: boolean PROPOSAL_REVIEW_DURATION: type: integer USER_TABLE_COLUMNS: type: string AUTO_APPROVE_USER_TOS: type: boolean FREEIPA_ENABLED: type: boolean FREEIPA_HOSTNAME: type: string FREEIPA_USERNAME: type: string FREEIPA_PASSWORD: type: string FREEIPA_VERIFY_SSL: type: boolean FREEIPA_USERNAME_PREFIX: type: string FREEIPA_GROUPNAME_PREFIX: type: string FREEIPA_BLACKLISTED_USERNAMES: type: array items: type: string minLength: 1 FREEIPA_GROUP_SYNCHRONIZATION_ENABLED: type: boolean KEYCLOAK_ICON: type: string format: binary nullable: true COUNTRIES: type: array items: type: string minLength: 1 OIDC_AUTH_URL: type: string OIDC_INTROSPECTION_URL: type: string OIDC_CLIENT_ID: type: string OIDC_CLIENT_SECRET: type: string OIDC_USER_FIELD: type: string OIDC_CACHE_TIMEOUT: type: integer DEACTIVATE_USER_IF_NO_ROLES: type: boolean MAINTENANCE_ANNOUNCEMENT_NOTIFY_BEFORE_MINUTES: type: integer MAINTENANCE_ANNOUNCEMENT_NOTIFY_SYSTEM: type: array items: type: string minLength: 1 ENFORCE_USER_CONSENT_FOR_OFFERINGS: type: boolean description: '' ContainerFormatEnum: enum: - bare - ovf - aki - ami - ari type: string description: '' CoreAuthToken: type: object properties: token: type: string readOnly: true required: - token description: '' CoreStates: enum: - CREATION_SCHEDULED - CREATING - UPDATE_SCHEDULED - UPDATING - DELETION_SCHEDULED - DELETING - OK - ERRED type: string description: '' CostsForPeriod: type: object properties: total_price: type: string readOnly: true start_date: type: string format: date readOnly: true end_date: type: string format: date readOnly: true required: - end_date - start_date - total_price description: '' CountProjectsOfServiceProviders: type: object properties: service_provider_uuid: type: string format: uuid readOnly: true customer_uuid: type: string format: uuid readOnly: true customer_name: type: string readOnly: true customer_organization_group_uuid: type: string readOnly: true customer_organization_group_name: type: string readOnly: true count: type: integer readOnly: true required: - count - customer_name - customer_organization_group_name - customer_organization_group_uuid - customer_uuid - service_provider_uuid description: '' CountProjectsOfServiceProvidersGroupedByOecd: type: object properties: service_provider_uuid: type: string format: uuid readOnly: true customer_uuid: type: string format: uuid readOnly: true customer_name: type: string readOnly: true customer_organization_group_uuid: type: string readOnly: true customer_organization_group_name: type: string readOnly: true count: type: integer readOnly: true oecd_fos_2007_name: type: string readOnly: true required: - count - customer_name - customer_organization_group_name - customer_organization_group_uuid - customer_uuid - oecd_fos_2007_name - service_provider_uuid description: '' CountStats: type: object properties: name: type: string readOnly: true uuid: type: string readOnly: true count: type: integer readOnly: true required: - count - name - uuid description: '' CountUniqueUsersConnectedWithActiveResourcesOfServiceProvider: type: object properties: customer_uuid: type: string format: uuid readOnly: true customer_name: type: string readOnly: true count_users: type: integer readOnly: true required: - count_users - customer_name - customer_uuid description: '' CountUsersOfServiceProviders: type: object properties: service_provider_uuid: type: string format: uuid readOnly: true customer_uuid: type: string format: uuid readOnly: true customer_name: type: string readOnly: true customer_organization_group_uuid: type: string readOnly: true customer_organization_group_name: type: string readOnly: true count: type: integer readOnly: true required: - count - customer_name - customer_organization_group_name - customer_organization_group_uuid - customer_uuid - service_provider_uuid description: '' Country: type: object properties: label: type: string readOnly: true value: type: string readOnly: true required: - label - value description: '' CountryEnum: enum: - AL - AT - BE - BG - BA - CH - CY - CZ - DE - DK - ES - EE - FI - FR - GB - GE - GR - HR - HU - IE - IS - IT - LT - LU - LV - MC - MK - MT - NL - 'NO' - PL - PT - RO - RS - SK - SI - SE - UA - EU type: string description: '' CourseAccount: type: object properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true created: type: string format: date-time readOnly: true modified: type: string format: date-time readOnly: true project: type: string format: uuid project_uuid: type: string format: uuid readOnly: true project_name: type: string readOnly: true user_uuid: type: string format: uuid readOnly: true username: type: string readOnly: true customer_uuid: type: string format: uuid readOnly: true customer_name: type: string readOnly: true state: allOf: - $ref: '#/components/schemas/ServiceAccountState' readOnly: true email: type: string format: email maxLength: 320 description: type: string maxLength: 2000 error_message: type: string readOnly: true error_traceback: type: string required: - created - customer_name - customer_uuid - error_message - modified - project - project_name - project_uuid - state - url - user_uuid - username - uuid description: '' CourseAccountCreateNested: type: object properties: email: type: string format: email maxLength: 320 description: type: string maxLength: 2000 description: '' CourseAccountCreateNestedRequest: type: object properties: email: type: string format: email minLength: 1 maxLength: 320 description: type: string maxLength: 2000 description: '' CourseAccountRequest: type: object properties: project: type: string format: uuid email: type: string format: email minLength: 1 maxLength: 320 description: type: string maxLength: 2000 error_traceback: type: string required: - project description: '' CourseAccountsBulkCreate: type: object properties: course_accounts: type: array items: $ref: '#/components/schemas/CourseAccountCreateNested' project: type: string format: uuid required: - course_accounts - project description: '' CourseAccountsBulkCreateRequest: type: object properties: course_accounts: type: array items: $ref: '#/components/schemas/CourseAccountCreateNestedRequest' project: type: string format: uuid required: - course_accounts - project description: '' CreateAttachmentsRequest: type: object properties: attachments: type: array items: type: string format: binary required: - attachments description: '' CreateCustomerCredit: type: object properties: uuid: type: string format: uuid readOnly: true url: type: string format: uri readOnly: true value: type: string format: decimal pattern: ^-?\d{0,11}(?:\.\d{0,5})?$ customer: type: string format: uri customer_name: type: string readOnly: true customer_uuid: type: string format: uuid readOnly: true customer_slug: type: string readOnly: true offerings: type: array items: type: string format: uri nullable: true end_date: type: string format: date nullable: true expected_consumption: type: string format: decimal pattern: ^-?\d{0,11}(?:\.\d{0,5})?$ minimal_consumption: type: number format: double readOnly: true minimal_consumption_logic: $ref: '#/components/schemas/MinimalConsumptionLogicEnum' grace_coefficient: type: string format: decimal pattern: ^-?\d{0,3}(?:\.\d{0,0})?$ apply_as_minimal_consumption: type: boolean allocated_to_projects: type: number format: double readOnly: true consumption_last_month: type: number format: double readOnly: true required: - allocated_to_projects - consumption_last_month - customer - customer_name - customer_slug - customer_uuid - minimal_consumption - url - uuid description: '' CreateCustomerCreditRequest: type: object properties: value: type: string format: decimal pattern: ^-?\d{0,11}(?:\.\d{0,5})?$ customer: type: string format: uri offerings: type: array items: type: string format: uri nullable: true end_date: type: string format: date nullable: true expected_consumption: type: string format: decimal pattern: ^-?\d{0,11}(?:\.\d{0,5})?$ minimal_consumption_logic: $ref: '#/components/schemas/MinimalConsumptionLogicEnum' grace_coefficient: type: string format: decimal pattern: ^-?\d{0,3}(?:\.\d{0,0})?$ apply_as_minimal_consumption: type: boolean required: - customer description: '' CreateFeedback: type: object properties: uuid: type: string format: uuid readOnly: true issue: type: string format: uri readOnly: true comment: type: string evaluation: type: integer maximum: 10 minimum: 1 required: - evaluation - issue - uuid description: '' CreateFeedbackRequest: type: object properties: comment: type: string evaluation: type: integer maximum: 10 minimum: 1 token: type: string writeOnly: true minLength: 1 required: - evaluation - token description: '' CreateRouter: type: object properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true tenant: type: string format: uri description: OpenStack tenant this router belongs to name: type: string project: type: string format: uri readOnly: true service_settings: type: string format: uri readOnly: true required: - name - project - service_settings - tenant - url - uuid description: '' CreateRouterRequest: type: object properties: tenant: type: string format: uri description: OpenStack tenant this router belongs to name: type: string minLength: 1 required: - name - tenant description: '' Customer: type: object description: '' properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true created: type: string format: date-time readOnly: true organization_groups: type: array items: $ref: '#/components/schemas/OrganizationGroup' readOnly: true display_name: type: string readOnly: true projects: type: array items: $ref: '#/components/schemas/PermissionProject' readOnly: true backend_id: type: string description: Organization identifier in another application. maxLength: 255 image: type: string format: uri nullable: true blocked: type: boolean readOnly: true archived: type: boolean readOnly: true default_tax_percent: type: string format: decimal pattern: ^-?\d{0,3}(?:\.\d{0,2})?$ readOnly: true accounting_start_date: type: string format: date-time readOnly: true title: Start date of accounting projects_count: type: integer readOnly: true users_count: type: integer readOnly: true sponsor_number: type: integer maximum: 2147483647 minimum: 0 readOnly: true nullable: true description: External ID of the sponsor covering the costs country_name: type: string readOnly: true max_service_accounts: type: integer maximum: 32767 minimum: 0 readOnly: true nullable: true description: Maximum number of service accounts allowed project_metadata_checklist: type: string format: uuid readOnly: true nullable: true name: type: string maxLength: 150 slug: type: string maxLength: 50 pattern: ^[-a-zA-Z0-9_]+$ native_name: type: string maxLength: 160 abbreviation: type: string maxLength: 12 description: type: string maxLength: 2000 contact_details: type: string maxLength: 500 agreement_number: type: string readOnly: true maxLength: 160 email: type: string format: email title: Email address maxLength: 75 phone_number: type: string maxLength: 255 access_subnets: type: string readOnly: true description: Enter a comma separated list of IPv4 or IPv6 CIDR addresses from where connection to self-service is allowed. registration_code: type: string maxLength: 160 homepage: type: string format: uri maxLength: 255 domain: type: string readOnly: true maxLength: 255 vat_code: type: string description: VAT number maxLength: 20 postal: type: string maxLength: 20 address: type: string maxLength: 300 bank_name: type: string maxLength: 150 latitude: type: number format: double nullable: true longitude: type: number format: double nullable: true bank_account: type: string maxLength: 50 country: oneOf: - $ref: '#/components/schemas/CountryEnum' - $ref: '#/components/schemas/BlankEnum' payment_profiles: type: array items: $ref: '#/components/schemas/PaymentProfile' readOnly: true customer_credit: type: number format: double nullable: true readOnly: true customer_unallocated_credit: type: number format: double nullable: true readOnly: true is_service_provider: type: boolean readOnly: true service_provider: type: string format: uri readOnly: true nullable: true service_provider_uuid: type: string format: uuid readOnly: true nullable: true call_managing_organization_uuid: type: string nullable: true readOnly: true billing_price_estimate: allOf: - $ref: '#/components/schemas/NestedPriceEstimate' readOnly: true required: [] CustomerCredit: type: object properties: uuid: type: string format: uuid readOnly: true url: type: string format: uri readOnly: true value: type: string format: decimal pattern: ^-?\d{0,11}(?:\.\d{0,5})?$ customer: type: string format: uri customer_name: type: string readOnly: true customer_uuid: type: string format: uuid readOnly: true customer_slug: type: string readOnly: true offerings: type: array items: $ref: '#/components/schemas/NestedProviderOffering' readOnly: true end_date: type: string format: date nullable: true expected_consumption: type: string format: decimal pattern: ^-?\d{0,11}(?:\.\d{0,5})?$ minimal_consumption: type: number format: double readOnly: true minimal_consumption_logic: $ref: '#/components/schemas/MinimalConsumptionLogicEnum' grace_coefficient: type: string format: decimal pattern: ^-?\d{0,3}(?:\.\d{0,0})?$ apply_as_minimal_consumption: type: boolean allocated_to_projects: type: number format: double readOnly: true consumption_last_month: type: number format: double readOnly: true required: - allocated_to_projects - consumption_last_month - customer - customer_name - customer_slug - customer_uuid - minimal_consumption - offerings - url - uuid description: '' CustomerCreditConsumption: type: object properties: date: type: string format: date readOnly: true price: type: string format: decimal pattern: ^-?\d{0,20}(?:\.\d{0,2})?$ readOnly: true required: - date - price description: '' CustomerCreditRequest: type: object properties: value: type: string format: decimal pattern: ^-?\d{0,11}(?:\.\d{0,5})?$ customer: type: string format: uri end_date: type: string format: date nullable: true expected_consumption: type: string format: decimal pattern: ^-?\d{0,11}(?:\.\d{0,5})?$ minimal_consumption_logic: $ref: '#/components/schemas/MinimalConsumptionLogicEnum' grace_coefficient: type: string format: decimal pattern: ^-?\d{0,3}(?:\.\d{0,0})?$ apply_as_minimal_consumption: type: boolean required: - customer description: '' CustomerDetails: type: object properties: name: type: string maxLength: 150 address: type: string maxLength: 300 country: type: string maxLength: 2 country_name: type: string nullable: true readOnly: true email: type: string format: email title: Email address maxLength: 75 postal: type: string maxLength: 20 phone_number: type: string maxLength: 255 bank_name: type: string maxLength: 150 bank_account: type: string maxLength: 50 vat_code: type: string description: VAT number maxLength: 20 required: [] description: '' CustomerEstimatedCostPolicy: type: object description: '' properties: uuid: type: string format: uuid readOnly: true url: type: string format: uri readOnly: true scope: type: string format: uri scope_name: type: string readOnly: true scope_uuid: type: string format: uuid readOnly: true actions: type: string maxLength: 255 created: type: string format: date-time readOnly: true created_by_full_name: type: string readOnly: true created_by_username: type: string readOnly: true has_fired: type: boolean readOnly: true fired_datetime: type: string format: date-time readOnly: true options: description: Fields for saving actions extra data. Keys are name of actions. limit_cost: type: integer maximum: 2147483647 minimum: -2147483648 period: allOf: - $ref: '#/components/schemas/PeriodEnum' minimum: -2147483648 maximum: 2147483647 period_name: type: string readOnly: true customer_credit: type: integer readOnly: true billing_price_estimate: allOf: - $ref: '#/components/schemas/NestedPriceEstimate' readOnly: true required: - actions - billing_price_estimate - created - created_by_full_name - created_by_username - customer_credit - fired_datetime - has_fired - limit_cost - period_name - scope - scope_name - scope_uuid - url - uuid CustomerEstimatedCostPolicyRequest: type: object description: '' properties: scope: type: string format: uri actions: type: string minLength: 1 maxLength: 255 options: description: Fields for saving actions extra data. Keys are name of actions. limit_cost: type: integer maximum: 2147483647 minimum: -2147483648 period: allOf: - $ref: '#/components/schemas/PeriodEnum' minimum: -2147483648 maximum: 2147483647 required: - actions - limit_cost - scope CustomerIndustryFlagStats: type: object properties: name: type: string readOnly: true uuid: type: string readOnly: true count: type: integer readOnly: true abbreviation: type: string readOnly: true is_industry: type: string required: - abbreviation - count - is_industry - name - uuid description: '' CustomerMemberCount: type: object properties: uuid: type: string format: uuid readOnly: true name: type: string readOnly: true abbreviation: type: string readOnly: true count: type: integer readOnly: true has_resources: type: boolean readOnly: true required: - abbreviation - count - has_resources - name - uuid description: '' CustomerOecdCodeStats: type: object properties: name: type: string readOnly: true uuid: type: string readOnly: true count: type: integer readOnly: true abbreviation: type: string readOnly: true oecd: type: string required: - abbreviation - count - name - oecd - uuid description: '' CustomerPermissionReview: type: object description: '' properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true reviewer_full_name: type: string readOnly: true nullable: true reviewer_uuid: type: string format: uuid readOnly: true nullable: true is_pending: type: boolean readOnly: true created: type: string format: date-time readOnly: true closed: type: string format: date-time readOnly: true nullable: true customer_uuid: type: string format: uuid readOnly: true customer_name: type: string readOnly: true required: - closed - created - customer_name - customer_uuid - is_pending - reviewer_full_name - reviewer_uuid - url - uuid CustomerQuotas: type: object properties: customer_name: type: string readOnly: true customer_abbreviation: type: string readOnly: true value: type: integer readOnly: true required: - customer_abbreviation - customer_name - value description: '' CustomerRequest: type: object description: '' properties: backend_id: type: string description: Organization identifier in another application. maxLength: 255 image: type: string format: binary nullable: true name: type: string minLength: 1 maxLength: 150 native_name: type: string maxLength: 160 abbreviation: type: string maxLength: 12 description: type: string maxLength: 2000 contact_details: type: string maxLength: 500 email: type: string format: email title: Email address maxLength: 75 phone_number: type: string maxLength: 255 registration_code: type: string maxLength: 160 homepage: type: string format: uri maxLength: 255 vat_code: type: string description: VAT number maxLength: 20 postal: type: string maxLength: 20 address: type: string maxLength: 300 bank_name: type: string maxLength: 150 latitude: type: number format: double nullable: true longitude: type: number format: double nullable: true bank_account: type: string maxLength: 50 country: oneOf: - $ref: '#/components/schemas/CountryEnum' - $ref: '#/components/schemas/BlankEnum' required: - name CustomerServiceAccount: type: object properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true created: type: string format: date-time readOnly: true modified: type: string format: date-time readOnly: true username: type: string maxLength: 32 description: type: string error_message: type: string readOnly: true error_traceback: type: string state: allOf: - $ref: '#/components/schemas/ServiceAccountState' readOnly: true token: type: string nullable: true readOnly: true email: type: string format: email maxLength: 320 expires_at: type: string nullable: true readOnly: true preferred_identifier: type: string maxLength: 32 customer: type: string format: uuid customer_uuid: type: string format: uuid readOnly: true customer_name: type: string readOnly: true required: - created - customer - customer_name - customer_uuid - error_message - expires_at - modified - state - token - url - uuid description: '' CustomerServiceAccountRequest: type: object properties: username: type: string maxLength: 32 description: type: string error_traceback: type: string email: type: string format: email minLength: 1 maxLength: 320 preferred_identifier: type: string maxLength: 32 customer: type: string format: uuid required: - customer description: '' CustomerUser: type: object description: '' properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true username: type: string description: Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters pattern: ^[0-9a-z_.@+-]+$ maxLength: 128 full_name: type: string readOnly: true email: type: string format: email title: Email address maxLength: 320 role_name: type: string nullable: true readOnly: true projects: type: array items: $ref: '#/components/schemas/NestedProjectPermission' readOnly: true expiration_time: type: string format: date-time nullable: true readOnly: true image: type: string format: uri nullable: true required: [] DataVolume: type: object description: '' properties: size: type: integer volume_type: type: string format: uri nullable: true filesystem: type: string mount_point: type: string required: - mount_point - size DataVolumeRequest: type: object description: '' properties: size: type: integer volume_type: type: string format: uri nullable: true filesystem: type: string minLength: 1 mount_point: type: string minLength: 1 required: - mount_point - size DecidingEntityEnum: enum: - by_call_manager - automatic type: string description: '' DeleteAttachmentsRequest: type: object properties: attachment_ids: type: array items: type: string format: uuid required: - attachment_ids description: '' DependencyLogicOperatorEnum: enum: - and - or type: string description: '' DetailState: type: object properties: detail: type: string readOnly: true state: type: string readOnly: true required: - detail - state description: '' DigitalOceanDroplet: type: object description: '' properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true name: type: string maxLength: 150 description: type: string maxLength: 2000 service_name: type: string readOnly: true service_settings: type: string format: uri service_settings_uuid: type: string format: uuid readOnly: true service_settings_state: type: string readOnly: true service_settings_error_message: type: string readOnly: true project: type: string format: uri project_name: type: string readOnly: true project_uuid: type: string format: uuid readOnly: true customer: type: string format: uri readOnly: true customer_name: type: string readOnly: true customer_native_name: type: string readOnly: true customer_abbreviation: type: string readOnly: true error_message: type: string readOnly: true error_traceback: type: string readOnly: true resource_type: type: string readOnly: true state: allOf: - $ref: '#/components/schemas/CoreStates' readOnly: true created: type: string format: date-time readOnly: true modified: type: string format: date-time readOnly: true backend_id: type: string readOnly: true access_url: type: string nullable: true readOnly: true start_time: type: string format: date-time readOnly: true nullable: true cores: type: integer readOnly: true description: Number of cores in a VM ram: type: integer readOnly: true description: Memory size in MiB disk: type: integer readOnly: true description: Disk size in MiB min_ram: type: integer readOnly: true description: Minimum memory size in MiB min_disk: type: integer readOnly: true description: Minimum disk size in MiB user_data: type: string description: Additional data that will be added to instance on provisioning external_ips: type: array items: type: string format: ipv4 readOnly: true internal_ips: type: array items: type: string format: ipv4 readOnly: true latitude: type: number format: double readOnly: true nullable: true longitude: type: number format: double readOnly: true nullable: true key_name: type: string readOnly: true key_fingerprint: type: string readOnly: true image_name: type: string readOnly: true runtime_state: type: string readOnly: true region_name: type: string readOnly: true marketplace_offering_uuid: type: string nullable: true readOnly: true marketplace_offering_name: type: string nullable: true readOnly: true marketplace_offering_plugin_options: type: object additionalProperties: {} nullable: true readOnly: true marketplace_category_uuid: type: string nullable: true readOnly: true marketplace_category_name: type: string nullable: true readOnly: true marketplace_resource_uuid: type: string nullable: true readOnly: true marketplace_plan_uuid: type: string nullable: true readOnly: true marketplace_resource_state: type: string nullable: true readOnly: true is_usage_based: type: boolean nullable: true readOnly: true is_limit_based: type: boolean nullable: true readOnly: true required: [] DigitalOceanDropletRequest: type: object description: '' properties: name: type: string minLength: 1 maxLength: 150 description: type: string maxLength: 2000 service_settings: type: string format: uri project: type: string format: uri ssh_public_key: type: string format: uri writeOnly: true user_data: type: string description: Additional data that will be added to instance on provisioning region: type: string format: uri writeOnly: true image: type: string format: uri writeOnly: true size: type: string format: uri writeOnly: true required: - image - name - project - region - service_settings - size DigitalOceanDropletResize: type: object properties: disk: type: boolean required: - disk description: '' DigitalOceanDropletResizeRequest: type: object properties: size: type: string format: uri writeOnly: true disk: type: boolean required: - disk - size description: '' DigitalOceanImage: type: object description: '' properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true name: type: string maxLength: 150 distribution: type: string maxLength: 100 type: type: string maxLength: 100 regions: type: array items: $ref: '#/components/schemas/DigitalOceanRegion' readOnly: true is_official: type: boolean description: Is image provided by DigitalOcean created_at: type: string format: date-time nullable: true min_disk_size: type: integer maximum: 2147483647 minimum: 0 nullable: true description: Minimum disk required for a size to use this image required: - distribution - name - regions - type - url - uuid DigitalOceanRegion: type: object description: '' properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true name: type: string maxLength: 150 required: - name - url - uuid DigitalOceanSize: type: object description: '' properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true name: type: string maxLength: 150 cores: type: integer maximum: 32767 minimum: 0 description: Number of cores in a VM ram: type: integer maximum: 2147483647 minimum: 0 description: Memory size in MiB disk: type: integer maximum: 2147483647 minimum: 0 description: Disk size in MiB transfer: type: integer maximum: 2147483647 minimum: 0 description: Amount of transfer bandwidth in MiB regions: type: array items: $ref: '#/components/schemas/DigitalOceanRegion' readOnly: true required: - cores - disk - name - ram - regions - transfer - url - uuid DirectionEnum: enum: - ingress - egress type: string description: '' DiscountTypeEnum: enum: - discount - special_price type: string description: '' DiskFormatEnum: enum: - qcow2 - raw - vhd - vmdk - vdi - iso - aki - ami - ari type: string description: '' DryRun: type: object properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true order_attributes: readOnly: true order_type: type: string readOnly: true order_offering: type: string format: uri nullable: true state: allOf: - $ref: '#/components/schemas/DryRunStateEnum' readOnly: true get_state_display: type: string readOnly: true output: type: string readOnly: true created: type: string format: date-time readOnly: true required: - created - get_state_display - order_attributes - order_type - output - state - url - uuid description: '' DryRunRequest: type: object properties: plan: type: string format: uri writeOnly: true nullable: true type: allOf: - $ref: '#/components/schemas/DryRunTypeEnum' writeOnly: true default: Create attributes: writeOnly: true order_offering: type: string format: uri nullable: true description: '' DryRunStateEnum: enum: - 1 - 2 - 3 - 4 type: integer description: '' DryRunTypeEnum: enum: - Create - Update - Terminate - Pull type: string description: '' EmailHook: type: object properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true is_active: type: boolean author_uuid: type: string format: uuid readOnly: true event_types: type: array items: $ref: '#/components/schemas/EventTypesEnum' event_groups: type: array items: $ref: '#/components/schemas/EventGroupsEnum' created: type: string format: date-time readOnly: true modified: type: string format: date-time readOnly: true hook_type: type: string readOnly: true author_fullname: type: string readOnly: true author_username: type: string readOnly: true author_email: type: string readOnly: true email: type: string format: email maxLength: 320 required: - author_email - author_fullname - author_username - author_uuid - created - email - hook_type - modified - url - uuid description: '' EmailHookRequest: type: object properties: is_active: type: boolean event_types: type: array items: $ref: '#/components/schemas/EventTypesEnum' event_groups: type: array items: $ref: '#/components/schemas/EventGroupsEnum' email: type: string format: email minLength: 1 maxLength: 320 required: - email description: '' EmailLog: type: object properties: uuid: type: string format: uuid readOnly: true url: type: string format: uri readOnly: true sent_at: type: string format: date-time readOnly: true subject: type: string maxLength: 255 body: type: string emails: type: array items: type: string format: email maxLength: 254 required: - body - emails - sent_at - subject - url - uuid description: '' EndpointUUID: type: object properties: uuid: type: string format: uuid required: - uuid description: '' EndpointUUIDRequest: type: object properties: uuid: type: string format: uuid required: - uuid description: '' EthertypeEnum: enum: - IPv4 - IPv6 type: string description: '' Event: type: object description: '' properties: uuid: type: string format: uuid readOnly: true created: type: string format: date-time readOnly: true event_type: type: string maxLength: 100 message: type: string context: readOnly: true required: [] EventGroupsEnum: enum: - access_subnets - auth - call - credits - customers - invoices - offering_accounting - permissions - projects - proposal - providers - resources - review - ssh - support - users type: string description: '' EventStats: type: object properties: year: type: integer readOnly: true month: type: integer readOnly: true count: type: integer readOnly: true required: - count - month - year description: '' EventSubscription: type: object properties: uuid: type: string format: uuid readOnly: true url: type: string format: uri readOnly: true description: type: string maxLength: 2000 user: type: string format: uri readOnly: true user_uuid: type: string format: uuid readOnly: true user_username: type: string description: Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters readOnly: true user_full_name: type: string readOnly: true observable_objects: {} created: type: string format: date-time readOnly: true modified: type: string format: date-time readOnly: true source_ip: description: An IPv4 or IPv6 address. oneOf: - type: string format: ipv4 - type: string format: ipv6 readOnly: true nullable: true required: - created - modified - source_ip - url - user - user_full_name - user_username - user_uuid - uuid description: '' EventSubscriptionRequest: type: object properties: description: type: string maxLength: 2000 observable_objects: {} description: '' EventTypesEnum: enum: - access_subnet_creation_succeeded - access_subnet_deletion_succeeded - access_subnet_update_succeeded - allowed_offerings_have_been_updated - attachment_created - attachment_deleted - attachment_updated - auth_logged_in_with_saml2 - auth_logged_in_with_username - auth_logged_in_with_oauth - auth_logged_out - auth_logged_out_with_saml2 - auth_login_failed_with_username - block_creation_of_new_resources - block_modification_of_existing_resources - call_document_added - call_document_removed - create_of_credit_by_staff - custom_notification - customer_creation_succeeded - customer_deletion_succeeded - customer_update_succeeded - customer_permission_review_created - customer_permission_review_closed - droplet_resize_scheduled - droplet_resize_succeeded - freeipa_profile_created - freeipa_profile_deleted - freeipa_profile_disabled - freeipa_profile_enabled - invoice_canceled - invoice_created - invoice_item_created - invoice_item_deleted - invoice_item_updated - invoice_paid - issue_creation_succeeded - issue_deletion_succeeded - issue_update_succeeded - marketplace_offering_component_created - marketplace_offering_component_deleted - marketplace_offering_component_updated - marketplace_offering_created - marketplace_offering_role_created - marketplace_offering_role_deleted - marketplace_offering_role_updated - marketplace_offering_updated - marketplace_offering_user_created - marketplace_offering_user_updated - marketplace_offering_user_deleted - marketplace_offering_user_restriction_updated - marketplace_order_approved - marketplace_order_completed - marketplace_order_created - marketplace_order_failed - marketplace_order_rejected - marketplace_order_terminated - marketplace_order_unlinked - marketplace_plan_archived - marketplace_plan_component_current_price_updated - marketplace_plan_component_future_price_updated - marketplace_plan_component_quota_updated - marketplace_plan_created - marketplace_plan_updated - marketplace_plan_deleted - marketplace_resource_create_canceled - marketplace_resource_create_failed - marketplace_resource_create_requested - marketplace_resource_create_succeeded - marketplace_resource_downscaled - marketplace_resource_erred_on_backend - marketplace_resource_paused - marketplace_resource_terminate_canceled - marketplace_resource_terminate_failed - marketplace_resource_terminate_requested - marketplace_resource_terminate_succeeded - marketplace_resource_unlinked - marketplace_resource_update_canceled - marketplace_resource_update_end_date_succeeded - marketplace_resource_update_failed - marketplace_resource_update_limits_failed - marketplace_resource_update_limits_succeeded - marketplace_resource_update_requested - marketplace_resource_update_succeeded - marketplace_resource_user_created - marketplace_resource_user_deleted - notify_external_user - notify_organization_owners - notify_project_team - openstack_floating_ip_attached - openstack_floating_ip_connected - openstack_floating_ip_description_updated - openstack_floating_ip_detached - openstack_floating_ip_disconnected - openstack_network_cleaned - openstack_network_created - openstack_network_deleted - openstack_network_imported - openstack_network_pulled - openstack_network_updated - openstack_port_cleaned - openstack_port_created - openstack_port_deleted - openstack_port_imported - openstack_port_pulled - openstack_port_updated - openstack_router_updated - openstack_security_group_cleaned - openstack_security_group_created - openstack_security_group_deleted - openstack_security_group_imported - openstack_security_group_pulled - openstack_security_group_rule_cleaned - openstack_security_group_rule_created - openstack_security_group_rule_deleted - openstack_security_group_rule_imported - openstack_security_group_rule_updated - openstack_security_group_updated - openstack_security_group_added_remotely - openstack_security_group_removed_remotely - openstack_security_group_added_locally - openstack_security_group_removed_locally - openstack_server_group_cleaned - openstack_server_group_created - openstack_server_group_deleted - openstack_server_group_imported - openstack_server_group_pulled - openstack_subnet_cleaned - openstack_subnet_created - openstack_subnet_deleted - openstack_subnet_imported - openstack_subnet_pulled - openstack_subnet_updated - openstack_tenant_quota_limit_updated - payment_added - payment_created - payment_removed - policy_notification - project_creation_succeeded - project_deletion_succeeded - project_deletion_triggered - project_update_request_approved - project_update_request_created - project_update_request_rejected - project_update_succeeded - project_permission_review_created - project_permission_review_closed - proposal_canceled - proposal_document_added - proposal_document_removed - query_executed - reduction_of_customer_credit - reduction_of_customer_credit_due_to_minimal_consumption - reduction_of_customer_expected_consumption - reduction_of_project_credit - reduction_of_project_credit_due_to_minimal_consumption - reduction_of_project_expected_consumption - request_downscaling - request_pausing - resource_assign_floating_ip_failed - resource_assign_floating_ip_scheduled - resource_assign_floating_ip_succeeded - resource_attach_failed - resource_attach_scheduled - resource_attach_succeeded - resource_backup_creation_failed - resource_backup_creation_scheduled - resource_backup_creation_succeeded - resource_backup_deletion_failed - resource_backup_deletion_scheduled - resource_backup_deletion_succeeded - resource_backup_restoration_failed - resource_backup_restoration_scheduled - resource_backup_restoration_succeeded - resource_change_flavor_failed - resource_change_flavor_scheduled - resource_change_flavor_succeeded - resource_creation_failed - resource_creation_scheduled - resource_creation_succeeded - resource_deletion_failed - resource_deletion_scheduled - resource_deletion_succeeded - resource_detach_failed - resource_detach_scheduled - resource_detach_succeeded - resource_extend_failed - resource_extend_scheduled - resource_extend_succeeded - resource_extend_volume_failed - resource_extend_volume_scheduled - resource_extend_volume_succeeded - resource_import_succeeded - resource_pull_failed - resource_pull_scheduled - resource_pull_succeeded - resource_restart_failed - resource_restart_scheduled - resource_restart_succeeded - resource_retype_failed - resource_retype_scheduled - resource_retype_succeeded - resource_robot_account_created - resource_robot_account_deleted - resource_robot_account_state_changed - resource_robot_account_updated - resource_start_failed - resource_start_scheduled - resource_start_succeeded - resource_stop_failed - resource_stop_scheduled - resource_stop_succeeded - resource_unassign_floating_ip_failed - resource_unassign_floating_ip_scheduled - resource_unassign_floating_ip_succeeded - resource_update_allowed_address_pairs_failed - resource_update_allowed_address_pairs_scheduled - resource_update_allowed_address_pairs_succeeded - resource_update_floating_ips_failed - resource_update_floating_ips_scheduled - resource_update_floating_ips_succeeded - resource_update_ports_failed - resource_update_ports_scheduled - resource_update_ports_succeeded - resource_update_security_groups_failed - resource_update_security_groups_scheduled - resource_update_security_groups_succeeded - resource_update_succeeded - restrict_members - review_canceled - role_granted - role_revoked - role_updated - roll_back_customer_credit - roll_back_project_credit - service_account_created - service_account_deleted - service_account_updated - set_to_zero_overdue_credit - ssh_key_creation_succeeded - ssh_key_deletion_succeeded - terminate_resources - token_created - token_lifetime_updated - update_of_credit_by_staff - user_activated - user_creation_succeeded - user_deactivated - user_deactivated_no_roles - user_deletion_succeeded - user_details_update_succeeded - user_has_been_created_by_staff - user_password_updated - user_password_updated_by_staff - user_update_succeeded type: string description: '' ExecutionStateEnum: enum: - Scheduled - Processing - OK - Erred type: string description: '' ExternalLink: type: object properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true name: type: string maxLength: 150 description: type: string maxLength: 2000 link: type: string format: uri maxLength: 500 image: type: string format: uri nullable: true created: type: string format: date-time readOnly: true modified: type: string format: date-time readOnly: true required: - created - link - modified - name - url - uuid description: '' ExternalLinkRequest: type: object properties: name: type: string minLength: 1 maxLength: 150 description: type: string maxLength: 2000 link: type: string format: uri minLength: 1 maxLength: 500 image: type: string format: binary nullable: true required: - link - name description: '' Feedback: type: object properties: uuid: type: string format: uuid readOnly: true created: type: string format: date-time readOnly: true modified: type: string format: date-time readOnly: true state: allOf: - $ref: '#/components/schemas/CoreStates' readOnly: true evaluation: type: integer maximum: 10 minimum: 1 comment: type: string issue_uuid: type: string format: uuid readOnly: true user_full_name: type: string readOnly: true issue_key: type: string readOnly: true issue_summary: type: string readOnly: true required: - created - evaluation - issue_key - issue_summary - issue_uuid - modified - state - user_full_name - uuid description: '' FinancialReport: type: object properties: name: type: string maxLength: 150 uuid: type: string format: uuid readOnly: true abbreviation: type: string maxLength: 12 created: type: string format: date-time readOnly: true accounting_start_date: type: string format: date-time title: Start date of accounting registration_code: type: string maxLength: 160 agreement_number: type: string maxLength: 160 payment_profiles: type: array items: $ref: '#/components/schemas/PaymentProfile' readOnly: true billing_price_estimate: allOf: - $ref: '#/components/schemas/NestedPriceEstimate' readOnly: true required: - billing_price_estimate - created - name - payment_profiles - uuid description: '' FinancialReportEmailRequest: type: object properties: emails: type: array items: type: string format: email minLength: 1 year: type: integer month: type: integer required: - emails - month - year description: '' Fingerprint: type: object properties: md5: type: string readOnly: true sha256: type: string readOnly: true sha512: type: string readOnly: true required: [] description: '' FirecrestJob: type: object description: '' properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true name: type: string maxLength: 150 description: type: string maxLength: 2000 service_name: type: string readOnly: true service_settings: type: string format: uri service_settings_uuid: type: string format: uuid readOnly: true service_settings_state: type: string readOnly: true service_settings_error_message: type: string readOnly: true project: type: string format: uri project_name: type: string readOnly: true project_uuid: type: string format: uuid readOnly: true customer: type: string format: uri readOnly: true customer_name: type: string readOnly: true customer_native_name: type: string readOnly: true customer_abbreviation: type: string readOnly: true error_message: type: string readOnly: true error_traceback: type: string readOnly: true resource_type: type: string readOnly: true state: allOf: - $ref: '#/components/schemas/CoreStates' readOnly: true created: type: string format: date-time readOnly: true modified: type: string format: date-time readOnly: true backend_id: type: string readOnly: true access_url: type: string nullable: true readOnly: true runtime_state: type: string maxLength: 100 file: type: string format: uri title: Batch script file user: type: string format: uri readOnly: true nullable: true description: Reference to user which submitted job user_uuid: type: string format: uuid readOnly: true nullable: true user_username: type: string description: Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters readOnly: true nullable: true report: readOnly: true nullable: true title: Job output required: [] FirecrestJobRequest: type: object description: '' properties: name: type: string minLength: 1 maxLength: 150 description: type: string maxLength: 2000 service_settings: type: string format: uri project: type: string format: uri runtime_state: type: string maxLength: 100 file: type: string format: binary title: Batch script file required: - file - name - project - service_settings FreeipaProfile: type: object description: '' properties: uuid: type: string format: uuid readOnly: true username: type: string description: Letters, numbers and ./+/-/_ characters pattern: ^[a-zA-Z0-9_.][a-zA-Z0-9_.-]*[a-zA-Z0-9_.$-]?$ maxLength: 32 agreement_date: type: string format: date-time description: Indicates when the user has agreed with the policy. is_active: type: boolean readOnly: true title: Active user: type: string format: uri readOnly: true user_uuid: type: string format: uuid readOnly: true user_username: type: string description: Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters readOnly: true user_full_name: type: string readOnly: true required: - is_active - user - user_full_name - user_username - user_uuid - username - uuid FreeipaProfileRequest: type: object description: '' properties: username: type: string minLength: 1 description: Letters, numbers and ./+/-/_ characters pattern: ^[a-zA-Z0-9_.][a-zA-Z0-9_.-]*[a-zA-Z0-9_.$-]?$ maxLength: 32 agreement_date: type: string format: date-time description: Indicates when the user has agreed with the policy. required: - username GoogleCalendar: type: object properties: backend_id: type: string nullable: true maxLength: 255 public: type: boolean http_link: type: string readOnly: true required: [] description: '' GoogleCredentials: type: object description: '' properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true created: type: string format: date-time readOnly: true description: type: string maxLength: 2000 enable_notifications: type: boolean customer: type: string format: uri customer_name: type: string readOnly: true customer_uuid: type: string format: uuid readOnly: true customer_image: type: string format: uri readOnly: true customer_abbreviation: type: string readOnly: true customer_slug: type: string readOnly: true customer_native_name: type: string readOnly: true customer_country: type: string readOnly: true image: type: string format: uri nullable: true organization_groups: type: array items: $ref: '#/components/schemas/OrganizationGroup' readOnly: true offering_count: type: integer readOnly: true calendar_token: type: string readOnly: true calendar_refresh_token: type: string readOnly: true google_auth_url: type: string readOnly: true required: [] GroupInvitation: type: object properties: scope_uuid: type: string format: uuid readOnly: true scope_name: type: string readOnly: true scope_description: type: string description: |- Get the description field from the scope if it exists. Returns empty string if scope doesn't have a description field. readOnly: true scope_type: type: string nullable: true readOnly: true customer_uuid: type: string format: uuid readOnly: true customer_name: type: string readOnly: true role_name: type: string readOnly: true role_description: type: string readOnly: true created_by_full_name: type: string readOnly: true created_by_username: type: string readOnly: true url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true role: type: string format: uuid created: type: string format: date-time readOnly: true expires: type: string format: date-time readOnly: true is_active: type: boolean readOnly: true is_public: type: boolean description: Allow non-authenticated users to see and accept this invitation. Only staff can create public invitations. auto_create_project: type: boolean description: Create project and grant project permissions instead of customer permissions project_name_template: type: string nullable: true description: Template for project name. Supports {username}, {email}, {full_name} variables maxLength: 255 project_role: type: string format: uuid nullable: true user_affiliations: {} user_email_patterns: {} scope_image: type: string format: uri nullable: true readOnly: true required: - created - created_by_full_name - created_by_username - customer_name - customer_uuid - expires - is_active - role - role_description - role_name - scope_description - scope_image - scope_name - scope_type - scope_uuid - url - uuid description: '' GroupInvitationRequest: type: object properties: role: type: string format: uuid scope: type: string writeOnly: true is_public: type: boolean description: Allow non-authenticated users to see and accept this invitation. Only staff can create public invitations. auto_create_project: type: boolean description: Create project and grant project permissions instead of customer permissions project_name_template: type: string nullable: true description: Template for project name. Supports {username}, {email}, {full_name} variables maxLength: 255 project_role: type: string format: uuid nullable: true user_affiliations: {} user_email_patterns: {} required: - role - scope description: '' GuestOsEnum: enum: - DOS - WIN_31 - WIN_95 - WIN_98 - WIN_ME - WIN_NT - WIN_2000_PRO - WIN_2000_SERV - WIN_2000_ADV_SERV - WIN_XP_HOME - WIN_XP_PRO - WIN_XP_PRO_64 - WIN_NET_WEB - WIN_NET_STANDARD - WIN_NET_ENTERPRISE - WIN_NET_DATACENTER - WIN_NET_BUSINESS - WIN_NET_STANDARD_64 - WIN_NET_ENTERPRISE_64 - WIN_LONGHORN - WIN_LONGHORN_64 - WIN_NET_DATACENTER_64 - WIN_VISTA - WIN_VISTA_64 - WINDOWS_7 - WINDOWS_7_64 - WINDOWS_7_SERVER_64 - WINDOWS_8 - WINDOWS_8_64 - WINDOWS_8_SERVER_64 - WINDOWS_9 - WINDOWS_9_64 - WINDOWS_9_SERVER_64 - WINDOWS_HYPERV - FREEBSD - FREEBSD_64 - REDHAT - RHEL_2 - RHEL_3 - RHEL_3_64 - RHEL_4 - RHEL_4_64 - RHEL_5 - RHEL_5_64 - RHEL_6 - RHEL_6_64 - RHEL_7 - RHEL_7_64 - CENTOS - CENTOS_64 - CENTOS_6 - CENTOS_6_64 - CENTOS_7 - CENTOS_7_64 - ORACLE_LINUX - ORACLE_LINUX_64 - ORACLE_LINUX_6 - ORACLE_LINUX_6_64 - ORACLE_LINUX_7 - ORACLE_LINUX_7_64 - SUSE - SUSE_64 - SLES - SLES_64 - SLES_10 - SLES_10_64 - SLES_11 - SLES_11_64 - SLES_12 - SLES_12_64 - NLD_9 - OES - SJDS - MANDRAKE - MANDRIVA - MANDRIVA_64 - TURBO_LINUX - TURBO_LINUX_64 - UBUNTU - UBUNTU_64 - DEBIAN_4 - DEBIAN_4_64 - DEBIAN_5 - DEBIAN_5_64 - DEBIAN_6 - DEBIAN_6_64 - DEBIAN_7 - DEBIAN_7_64 - DEBIAN_8 - DEBIAN_8_64 - DEBIAN_9 - DEBIAN_9_64 - DEBIAN_10 - DEBIAN_10_64 - ASIANUX_3 - ASIANUX_3_64 - ASIANUX_4 - ASIANUX_4_64 - ASIANUX_5_64 - ASIANUX_7_64 - OPENSUSE - OPENSUSE_64 - FEDORA - FEDORA_64 - COREOS_64 - VMWARE_PHOTON_64 - OTHER_24X_LINUX - OTHER_24X_LINUX_64 - OTHER_26X_LINUX - OTHER_26X_LINUX_64 - OTHER_3X_LINUX - OTHER_3X_LINUX_64 - OTHER_LINUX - GENERIC_LINUX - OTHER_LINUX_64 - SOLARIS_6 - SOLARIS_7 - SOLARIS_8 - SOLARIS_9 - SOLARIS_10 - SOLARIS_10_64 - SOLARIS_11_64 - OS2 - ECOMSTATION - ECOMSTATION_2 - NETWARE_4 - NETWARE_5 - NETWARE_6 - OPENSERVER_5 - OPENSERVER_6 - UNIXWARE_7 - DARWIN - DARWIN_64 - DARWIN_10 - DARWIN_10_64 - DARWIN_11 - DARWIN_11_64 - DARWIN_12_64 - DARWIN_13_64 - DARWIN_14_64 - DARWIN_15_64 - DARWIN_16_64 - VMKERNEL - VMKERNEL_5 - VMKERNEL_6 - VMKERNEL_65 - OTHER - OTHER_64 type: string description: '' GuestPowerStateEnum: enum: - RUNNING - SHUTTING_DOWN - RESETTING - STANDBY - NOT_RUNNING - UNAVAILABLE type: string description: '' IPMapping: type: object properties: floating_ip: type: string description: Floating IP external_ip: type: string description: External IP required: [] description: '' IPMappingRequest: type: object properties: floating_ip: type: string minLength: 1 description: Floating IP external_ip: type: string minLength: 1 description: External IP required: - external_ip - floating_ip description: '' IdentityProvider: type: object properties: provider: type: string maxLength: 32 is_active: type: boolean client_id: type: string description: ID of application used for OAuth authentication. maxLength: 200 verify_ssl: type: boolean enable_post_logout_redirect: type: boolean enable_pkce: type: boolean discovery_url: type: string description: The endpoint for endpoint discovery. maxLength: 200 userinfo_url: type: string readOnly: true description: The endpoint for fetching user info. token_url: type: string readOnly: true description: The endpoint for obtaining auth token. auth_url: type: string readOnly: true description: The endpoint for authorization request flow. logout_url: type: string readOnly: true description: The endpoint used to redirect after sign-out. label: type: string description: Human-readable identity provider is label. maxLength: 200 management_url: type: string description: The endpoint for user details management. maxLength: 200 protected_fields: {} extra_scope: type: string nullable: true description: Space-separated list of scopes to request during authentication. maxLength: 200 required: - auth_url - client_id - discovery_url - label - logout_url - provider - token_url - userinfo_url description: '' IdentityProviderRequest: type: object properties: provider: type: string minLength: 1 maxLength: 32 is_active: type: boolean client_id: type: string minLength: 1 description: ID of application used for OAuth authentication. maxLength: 200 verify_ssl: type: boolean enable_post_logout_redirect: type: boolean enable_pkce: type: boolean discovery_url: type: string minLength: 1 description: The endpoint for endpoint discovery. maxLength: 200 label: type: string minLength: 1 description: Human-readable identity provider is label. maxLength: 200 management_url: type: string description: The endpoint for user details management. maxLength: 200 protected_fields: {} extra_scope: type: string nullable: true description: Space-separated list of scopes to request during authentication. maxLength: 200 required: - client_id - discovery_url - label - provider description: '' ImageCreateRequest: type: object properties: name: type: string minLength: 1 min_ram: type: integer default: 0 min_disk: type: integer default: 0 disk_format: allOf: - $ref: '#/components/schemas/DiskFormatEnum' default: qcow2 container_format: allOf: - $ref: '#/components/schemas/ContainerFormatEnum' default: bare visibility: allOf: - $ref: '#/components/schemas/VisibilityEnum' default: private required: - name description: '' ImageCreateResponse: type: object properties: image_id: type: string format: uuid name: type: string status: type: string upload_url: type: string required: - image_id - name - status - upload_url description: '' ImageUploadResponse: type: object properties: status: type: string message: type: string required: - message - status description: '' ImpactLevelDisplayEnum: enum: - No impact - Degraded performance - Partial outage - Full outage type: string description: '' ImpactLevelEnum: enum: - 1 - 2 - 3 - 4 type: integer description: '' ImportResourceRequest: type: object properties: backend_id: type: string minLength: 1 project: type: string format: uuid plan: type: string format: uuid additional_details: writeOnly: true nullable: true default: {} required: - backend_id - project description: '' ImportableResource: type: object properties: backend_id: type: string name: type: string type: type: string description: type: string required: - backend_id - description - name - type description: '' InstanceFlavorChangeRequest: type: object properties: flavor: type: string format: uri description: The new flavor to use for the instance. Flavor change can only be done when instance is stopped. required: - flavor description: '' IntegrationStatus: type: object properties: agent_type: type: string readOnly: true status: type: string readOnly: true last_request_timestamp: type: string format: date-time readOnly: true nullable: true title: Time of latest backend request required: [] description: '' IntegrationStatusDetails: type: object properties: status: type: string readOnly: true last_request_timestamp: type: string format: date-time readOnly: true nullable: true title: Time of latest backend request offering: type: string format: uri url: type: string format: uri readOnly: true required: - last_request_timestamp - offering - status - url description: '' Invitation: type: object properties: scope_uuid: type: string format: uuid readOnly: true scope_name: type: string readOnly: true scope_description: type: string description: |- Get the description field from the scope if it exists. Returns empty string if scope doesn't have a description field. readOnly: true scope_type: type: string nullable: true readOnly: true customer_uuid: type: string format: uuid readOnly: true customer_name: type: string readOnly: true role_name: type: string readOnly: true role_description: type: string readOnly: true created_by_full_name: type: string readOnly: true created_by_username: type: string readOnly: true url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true role: type: string format: uuid created: type: string format: date-time readOnly: true expires: type: string format: date-time readOnly: true full_name: type: string maxLength: 100 native_name: type: string maxLength: 100 phone_number: type: string maxLength: 255 organization: type: string maxLength: 255 job_title: type: string maxLength: 120 email: type: string format: email description: Invitation link will be sent to this email. Note that user can accept invitation with different email. maxLength: 254 civil_number: type: string description: Civil number of invited user. If civil number is not defined any user can accept invitation. maxLength: 50 state: allOf: - $ref: '#/components/schemas/InvitationStateEnum' readOnly: true error_message: type: string readOnly: true extra_invitation_text: type: string maxLength: 250 execution_state: allOf: - $ref: '#/components/schemas/ExecutionStateEnum' readOnly: true required: - created - created_by_full_name - created_by_username - customer_name - customer_uuid - email - error_message - execution_state - expires - role - role_description - role_name - scope_description - scope_name - scope_type - scope_uuid - state - url - uuid description: '' InvitationCheck: type: object properties: email: type: string format: email civil_number_required: type: boolean required: - email description: '' InvitationRequest: type: object properties: role: type: string format: uuid scope: type: string writeOnly: true full_name: type: string maxLength: 100 native_name: type: string maxLength: 100 phone_number: type: string maxLength: 255 organization: type: string maxLength: 255 job_title: type: string maxLength: 120 email: type: string format: email minLength: 1 description: Invitation link will be sent to this email. Note that user can accept invitation with different email. maxLength: 254 civil_number: type: string description: Civil number of invited user. If civil number is not defined any user can accept invitation. maxLength: 50 extra_invitation_text: type: string maxLength: 250 required: - email - role - scope description: '' InvitationState: enum: - project - requested - rejected - pending - accepted - canceled - expired type: string description: '' InvitationStateEnum: enum: - project - requested - rejected - pending - accepted - canceled - expired type: string description: '' Invoice: type: object description: '' properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true number: type: integer readOnly: true customer: type: string format: uri title: Organization price: type: string format: decimal pattern: ^-?\d{0,12}(?:\.\d{0,10})?$ tax: type: string format: decimal pattern: ^-?\d{0,12}(?:\.\d{0,10})?$ total: type: string format: decimal pattern: ^-?\d{0,12}(?:\.\d{0,10})?$ state: $ref: '#/components/schemas/InvoiceStateEnum' year: type: integer maximum: 32767 minimum: 0 month: type: integer maximum: 12 minimum: 1 issuer_details: allOf: - $ref: '#/components/schemas/CustomerDetails' readOnly: true invoice_date: type: string format: date nullable: true description: Date then invoice moved from state pending to created. due_date: type: string format: date customer_details: $ref: '#/components/schemas/CustomerDetails' items: type: array items: $ref: '#/components/schemas/InvoiceItem' readOnly: true backend_id: type: string maxLength: 255 payment_url: type: string format: uri description: URL for initiating payment via payment gateway. maxLength: 200 reference_number: type: string description: Reference number associated with the invoice. maxLength: 300 compensations: type: number format: double readOnly: true incurred_costs: type: number format: double readOnly: true required: [] InvoiceCost: type: object properties: price: type: number format: double readOnly: true year: type: integer readOnly: true month: type: integer readOnly: true required: - month - price - year description: '' InvoiceGrowth: type: object properties: periods: type: array items: type: string readOnly: true total_periods: type: array items: type: number format: double readOnly: true other_periods: type: array items: type: number format: double readOnly: true customer_periods: type: array items: $ref: '#/components/schemas/InvoiceGrowthCustomerPeriod' required: - customer_periods - other_periods - periods - total_periods description: '' InvoiceGrowthCustomerPeriod: type: object properties: name: type: string readOnly: true periods: type: array items: type: number format: double readOnly: true required: - name - periods description: '' InvoiceItem: type: object properties: uuid: type: string format: uuid readOnly: true url: type: string format: uri readOnly: true name: type: string price: type: number format: double readOnly: true tax: type: string format: decimal pattern: ^-?\d{0,8}(?:\.\d{0,2})?$ total: type: string format: decimal pattern: ^-?\d{0,20}(?:\.\d{0,2})?$ unit_price: type: string format: decimal pattern: ^-?\d{0,12}(?:\.\d{0,10})?$ unit: $ref: '#/components/schemas/BillingUnit' factor: type: integer readOnly: true measured_unit: type: string readOnly: true start: type: string format: date-time description: Date and time when item usage has started. end: type: string format: date-time description: Date and time when item usage has ended. article_code: type: string maxLength: 30 project_name: type: string readOnly: true project_uuid: type: string format: uuid readOnly: true quantity: type: string format: decimal pattern: ^-?\d{0,12}(?:\.\d{0,10})?$ details: $ref: '#/components/schemas/InvoiceItemDetails' resource: type: string format: uri nullable: true resource_uuid: type: string format: uuid readOnly: true resource_name: type: string readOnly: true billing_type: type: string readOnly: true backend_uuid: type: string format: uuid readOnly: true nullable: true credit: type: boolean readOnly: true required: [] description: '' InvoiceItemCompensation: type: object properties: offering_component_name: type: string required: - offering_component_name description: '' InvoiceItemCompensationRequest: type: object properties: offering_component_name: type: string minLength: 1 required: - offering_component_name description: '' InvoiceItemDetail: type: object properties: invoice: type: string format: uri resource: type: string format: uri nullable: true uuid: type: string format: uuid readOnly: true article_code: type: string maxLength: 30 unit_price: type: string format: decimal pattern: ^-?\d{0,12}(?:\.\d{0,10})?$ unit: $ref: '#/components/schemas/BillingUnit' quantity: type: string format: decimal pattern: ^-?\d{0,12}(?:\.\d{0,10})?$ measured_unit: type: string description: Unit of measurement, for example, GB. maxLength: 30 name: type: string start: type: string format: date-time description: Date and time when item usage has started. end: type: string format: date-time description: Date and time when item usage has ended. details: description: Stores data about scope required: - invoice - uuid description: '' InvoiceItemDetails: type: object properties: resource_name: type: string resource_uuid: type: string format: uuid plan_name: type: string plan_uuid: type: string format: uuid offering_type: type: string offering_name: type: string offering_uuid: type: string format: uuid service_provider_name: type: string service_provider_uuid: type: string format: uuid plan_component_id: type: integer offering_component_type: type: string offering_component_name: type: string resource_limit_periods: type: array items: $ref: '#/components/schemas/ResourceLimitPeriod' required: [] description: '' InvoiceItemMigrateTo: type: object properties: invoice: type: string format: uri required: - invoice description: '' InvoiceItemMigrateToRequest: type: object properties: invoice: type: string format: uri required: - invoice description: '' InvoiceItemTotalPrice: type: object properties: total_price: type: string format: decimal pattern: ^-?\d{0,12}(?:\.\d{0,10})?$ required: - total_price description: '' InvoiceItemUpdate: type: object properties: article_code: type: string maxLength: 30 quantity: type: string format: decimal pattern: ^-?\d{0,12}(?:\.\d{0,10})?$ unit_price: type: string format: decimal pattern: ^-?\d{0,12}(?:\.\d{0,10})?$ start: type: string format: date-time description: Date and time when item usage has started. end: type: string format: date-time description: Date and time when item usage has ended. description: '' InvoiceItemUpdateRequest: type: object properties: article_code: type: string maxLength: 30 quantity: type: string format: decimal pattern: ^-?\d{0,12}(?:\.\d{0,10})?$ unit_price: type: string format: decimal pattern: ^-?\d{0,12}(?:\.\d{0,10})?$ start: type: string format: date-time description: Date and time when item usage has started. end: type: string format: date-time description: Date and time when item usage has ended. description: '' InvoiceStateEnum: enum: - pending - created - paid - canceled type: string description: '' InvoiceStatsOffering: type: object properties: offering_name: type: string readOnly: true aggregated_price: type: number format: double readOnly: true aggregated_tax: type: number format: double readOnly: true aggregated_total: type: number format: double readOnly: true service_category_title: type: string readOnly: true service_provider_name: type: string readOnly: true service_provider_uuid: type: string format: uuid readOnly: true required: - aggregated_price - aggregated_tax - aggregated_total - offering_name - service_category_title - service_provider_name - service_provider_uuid description: '' Issue: type: object description: '' properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true type: allOf: - $ref: '#/components/schemas/IssueTypeEnum' default: Informational key: type: string readOnly: true backend_id: type: string readOnly: true nullable: true backend_name: type: string readOnly: true nullable: true remote_id: type: string nullable: true maxLength: 255 link: type: string format: uri readOnly: true description: Link to issue in support system. summary: type: string maxLength: 255 description: type: string status: type: string readOnly: true resolution: type: string readOnly: true priority: type: string maxLength: 255 caller: type: string format: uri nullable: true caller_uuid: type: string format: uuid readOnly: true nullable: true caller_full_name: type: string readOnly: true nullable: true reporter: type: string format: uri readOnly: true reporter_uuid: type: string format: uuid readOnly: true nullable: true reporter_name: type: string readOnly: true nullable: true assignee: type: string format: uri nullable: true assignee_uuid: type: string format: uuid readOnly: true nullable: true assignee_name: type: string readOnly: true nullable: true customer: type: string format: uri nullable: true title: Organization customer_uuid: type: string format: uuid readOnly: true nullable: true customer_name: type: string readOnly: true nullable: true project: type: string format: uri nullable: true project_uuid: type: string format: uuid readOnly: true nullable: true project_name: type: string readOnly: true nullable: true resource: type: string resource_type: type: string readOnly: true resource_name: type: string readOnly: true created: type: string format: date-time readOnly: true modified: type: string format: date-time readOnly: true first_response_sla: type: string format: date-time readOnly: true nullable: true template: type: string format: uri nullable: true feedback: allOf: - $ref: '#/components/schemas/NestedFeedback' readOnly: true nullable: true resolved: type: boolean nullable: true readOnly: true update_is_available: type: boolean readOnly: true destroy_is_available: type: boolean readOnly: true add_comment_is_available: type: boolean readOnly: true add_attachment_is_available: type: boolean readOnly: true required: - add_attachment_is_available - add_comment_is_available - assignee_name - assignee_uuid - backend_id - backend_name - caller_full_name - caller_uuid - created - customer_name - customer_uuid - destroy_is_available - feedback - first_response_sla - key - link - modified - project_name - project_uuid - reporter - reporter_name - reporter_uuid - resolution - resolved - resource_name - resource_type - status - summary - update_is_available - url - uuid IssueReference: type: object properties: key: type: string readOnly: true uuid: type: string readOnly: true required: [] description: '' IssueRequest: type: object description: '' properties: type: allOf: - $ref: '#/components/schemas/IssueTypeEnum' default: Informational remote_id: type: string nullable: true maxLength: 255 summary: type: string minLength: 1 maxLength: 255 description: type: string priority: type: string maxLength: 255 caller: type: string format: uri nullable: true assignee: type: string format: uri nullable: true customer: type: string format: uri nullable: true title: Organization project: type: string format: uri nullable: true resource: type: string is_reported_manually: type: boolean writeOnly: true default: false description: Set true if issue is created by regular user via portal. template: type: string format: uri nullable: true required: - summary IssueStatus: type: object properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true name: type: string description: Status name in Jira. maxLength: 255 type: allOf: - $ref: '#/components/schemas/IssueStatusTypeEnum' minimum: -2147483648 maximum: 2147483647 type_display: type: string readOnly: true required: - name - type_display - url - uuid description: '' IssueStatusRequest: type: object properties: name: type: string minLength: 1 description: Status name in Jira. maxLength: 255 type: allOf: - $ref: '#/components/schemas/IssueStatusTypeEnum' minimum: -2147483648 maximum: 2147483647 required: - name description: '' IssueStatusTypeEnum: enum: - 0 - 1 type: integer description: '' IssueTypeEnum: enum: - Informational - Service Request - Change Request - Incident type: string description: '' JiraChangelog: type: object properties: items: type: array items: {} required: - items description: '' JiraChangelogRequest: type: object properties: items: type: array items: {} required: - items description: '' JiraComment: type: object properties: id: type: string required: - id description: '' JiraCommentRequest: type: object properties: id: type: string minLength: 1 required: - id description: '' JiraIssue: type: object properties: key: type: string fields: $ref: '#/components/schemas/JiraIssueFields' required: - fields - key description: '' JiraIssueFields: type: object properties: project: $ref: '#/components/schemas/JiraIssueProject' comment: type: object additionalProperties: {} required: - project description: '' JiraIssueFieldsRequest: type: object properties: project: $ref: '#/components/schemas/JiraIssueProjectRequest' comment: type: object additionalProperties: {} required: - project description: '' JiraIssueProject: type: object properties: id: type: string name: type: string key: type: string required: - id - key - name description: '' JiraIssueProjectRequest: type: object properties: id: type: string minLength: 1 name: type: string minLength: 1 key: type: string minLength: 1 required: - id - key - name description: '' JiraIssueRequest: type: object properties: key: type: string minLength: 1 fields: $ref: '#/components/schemas/JiraIssueFieldsRequest' required: - fields - key description: '' KeycloakGroup: type: object properties: uuid: type: string format: uuid readOnly: true url: type: string format: uri readOnly: true name: type: string readOnly: true title: Group name backend_id: type: string readOnly: true scope_type: type: string readOnly: true scope_uuid: type: string format: uuid description: UUID of the cluster or project scope_name: type: string nullable: true description: Get the name of the cluster or project readOnly: true role: type: string format: uri created: type: string format: date-time readOnly: true modified: type: string format: date-time readOnly: true required: - backend_id - created - modified - name - role - scope_name - scope_type - scope_uuid - url - uuid description: '' KeycloakUserGroupMembership: type: object properties: uuid: type: string format: uuid readOnly: true url: type: string format: uri readOnly: true username: type: string description: Keycloak user username maxLength: 255 email: type: string format: email description: User's email for notifications maxLength: 254 first_name: type: string readOnly: true last_name: type: string readOnly: true group: type: string format: uri readOnly: true group_name: type: string readOnly: true group_role: type: string readOnly: true group_scope_type: type: string readOnly: true group_scope_name: type: string nullable: true description: Get the name of the cluster or project readOnly: true state: allOf: - $ref: '#/components/schemas/KeycloakUserGroupMembershipState' readOnly: true created: type: string format: date-time readOnly: true modified: type: string format: date-time readOnly: true last_checked: type: string format: date-time readOnly: true error_message: type: string readOnly: true error_traceback: type: string readOnly: true required: - created - email - error_message - error_traceback - first_name - group - group_name - group_role - group_scope_name - group_scope_type - last_checked - last_name - modified - state - url - username - uuid description: '' KeycloakUserGroupMembershipRequest: type: object properties: username: type: string minLength: 1 description: Keycloak user username maxLength: 255 email: type: string format: email minLength: 1 description: User's email for notifications maxLength: 254 scope_uuid: type: string format: uuid writeOnly: true description: UUID of a cluster or a project in Rancher role: type: string format: uri writeOnly: true required: - email - role - scope_uuid - username description: '' KeycloakUserGroupMembershipState: enum: - pending - active type: string description: '' KindEnum: enum: - default - course - public type: string description: '' LexisLink: type: object properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true created: type: string format: date-time readOnly: true modified: type: string format: date-time readOnly: true robot_account: type: string format: uri readOnly: true robot_account_username: type: string readOnly: true robot_account_type: type: string readOnly: true state: type: string readOnly: true resource_uuid: type: string format: uuid readOnly: true resource_name: type: string readOnly: true resource_type: type: string readOnly: true resource_backend_id: type: string readOnly: true resource_end_date: type: string format: date-time readOnly: true project_uuid: type: string format: uuid readOnly: true project_name: type: string readOnly: true customer_uuid: type: string format: uuid readOnly: true customer_name: type: string readOnly: true heappe_project_id: type: integer maximum: 2147483647 minimum: 0 nullable: true required: - created - customer_name - customer_uuid - modified - project_name - project_uuid - resource_backend_id - resource_end_date - resource_name - resource_type - resource_uuid - robot_account - robot_account_type - robot_account_username - state - url - uuid description: '' LexisLinkCreateRequest: type: object properties: resource: type: string format: uri writeOnly: true required: - resource description: '' LexisLinkRequest: type: object properties: heappe_project_id: type: integer maximum: 2147483647 minimum: 0 nullable: true description: '' LimitPeriodEnum: enum: - month - quarterly - annual - total type: string description: '' LinkOpenstackRequest: type: object properties: instance: type: string format: uri writeOnly: true required: - instance description: '' LinkToInvoice: type: object properties: invoice: type: string format: uri required: - invoice description: '' LinkToInvoiceRequest: type: object properties: invoice: type: string format: uri required: - invoice description: '' Logout: type: object properties: logout_url: type: string format: uri readOnly: true required: - logout_url description: '' MaintenanceActionResponse: type: object description: '' properties: detail: type: string description: Response message describing the action result required: - detail MaintenanceAnnouncement: type: object properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true name: type: string maxLength: 150 message: type: string maxLength: 2000 maintenance_type: allOf: - $ref: '#/components/schemas/MaintenanceTypeEnum' description: Type of maintenance being performed minimum: 0 maximum: 32767 external_reference_url: type: string format: uri description: Optional reference to an external maintenance tracker maxLength: 200 state: allOf: - $ref: '#/components/schemas/MaintenanceAnnouncementStateEnum' readOnly: true scheduled_start: type: string format: date-time description: When the maintenance is scheduled to begin scheduled_end: type: string format: date-time description: When the maintenance is scheduled to complete actual_start: type: string format: date-time readOnly: true nullable: true description: When the maintenance actually began actual_end: type: string format: date-time readOnly: true nullable: true description: When the maintenance actually completed service_provider: type: string format: uri description: Service provider announcing the maintenance created_by: type: string format: uri readOnly: true nullable: true affected_offerings: type: array items: $ref: '#/components/schemas/MaintenanceAnnouncementOffering' readOnly: true service_provider_name: type: string readOnly: true backend_id: type: string readOnly: true required: - actual_end - actual_start - affected_offerings - backend_id - created_by - name - scheduled_end - scheduled_start - service_provider - service_provider_name - state - url - uuid description: '' MaintenanceAnnouncementOffering: type: object properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true maintenance: type: string format: uri offering: type: string format: uri impact_level: allOf: - $ref: '#/components/schemas/ImpactLevelEnum' description: Expected impact on this offering minimum: 0 maximum: 32767 impact_level_display: allOf: - $ref: '#/components/schemas/ImpactLevelDisplayEnum' readOnly: true impact_description: type: string description: Specific description of how this offering will be affected offering_name: type: string readOnly: true required: - impact_level_display - maintenance - offering - offering_name - url - uuid description: '' MaintenanceAnnouncementOfferingRequest: type: object properties: maintenance: type: string format: uri offering: type: string format: uri impact_level: allOf: - $ref: '#/components/schemas/ImpactLevelEnum' description: Expected impact on this offering minimum: 0 maximum: 32767 impact_description: type: string description: Specific description of how this offering will be affected required: - maintenance - offering description: '' MaintenanceAnnouncementOfferingTemplate: type: object properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true maintenance_template: type: string format: uri offering: type: string format: uri offering_name: type: string readOnly: true offering_uuid: type: string format: uuid readOnly: true impact_level: allOf: - $ref: '#/components/schemas/ImpactLevelEnum' description: Expected impact on this offering minimum: 0 maximum: 32767 impact_description: type: string description: Specific description of how this offering will be affected required: - maintenance_template - offering - offering_name - offering_uuid - url - uuid description: '' MaintenanceAnnouncementOfferingTemplateRequest: type: object properties: maintenance_template: type: string format: uri offering: type: string format: uri impact_level: allOf: - $ref: '#/components/schemas/ImpactLevelEnum' description: Expected impact on this offering minimum: 0 maximum: 32767 impact_description: type: string description: Specific description of how this offering will be affected required: - maintenance_template - offering description: '' MaintenanceAnnouncementRequest: type: object properties: name: type: string minLength: 1 maxLength: 150 message: type: string maxLength: 2000 maintenance_type: allOf: - $ref: '#/components/schemas/MaintenanceTypeEnum' description: Type of maintenance being performed minimum: 0 maximum: 32767 external_reference_url: type: string format: uri description: Optional reference to an external maintenance tracker maxLength: 200 scheduled_start: type: string format: date-time description: When the maintenance is scheduled to begin scheduled_end: type: string format: date-time description: When the maintenance is scheduled to complete service_provider: type: string format: uri description: Service provider announcing the maintenance required: - name - scheduled_end - scheduled_start - service_provider description: '' MaintenanceAnnouncementStateEnum: enum: - Draft - Scheduled - In progress - Completed - Cancelled type: string description: '' MaintenanceAnnouncementTemplate: type: object properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true name: type: string maxLength: 150 message: type: string maxLength: 2000 maintenance_type: allOf: - $ref: '#/components/schemas/MaintenanceTypeEnum' description: Type of maintenance being performed minimum: 0 maximum: 32767 service_provider: type: string format: uri description: Service provider announcing the maintenance affected_offerings: type: array items: $ref: '#/components/schemas/MaintenanceAnnouncementOffering' readOnly: true required: - affected_offerings - name - service_provider - url - uuid description: '' MaintenanceAnnouncementTemplateRequest: type: object properties: name: type: string minLength: 1 maxLength: 150 message: type: string maxLength: 2000 maintenance_type: allOf: - $ref: '#/components/schemas/MaintenanceTypeEnum' description: Type of maintenance being performed minimum: 0 maximum: 32767 service_provider: type: string format: uri description: Service provider announcing the maintenance required: - name - service_provider description: '' MaintenanceTypeEnum: enum: - 1 - 2 - 3 - 4 - 5 type: integer description: '' ManagedRancherCreateNodeRequest: type: object description: '' properties: role: $ref: '#/components/schemas/RoleEnum' system_volume_size: type: integer writeOnly: true minimum: 64 system_volume_type: type: string format: uri writeOnly: true nullable: true memory: type: integer writeOnly: true cpu: type: integer writeOnly: true subnet: type: string format: uri writeOnly: true nullable: true flavor: type: string format: uri writeOnly: true nullable: true data_volumes: type: array items: $ref: '#/components/schemas/DataVolumeRequest' writeOnly: true ssh_public_key: type: string format: uri writeOnly: true tenant: type: string format: uri writeOnly: true required: - role - subnet Mapping: type: object properties: volume_types: type: array items: $ref: '#/components/schemas/VolumeTypeMapping' subnets: type: array items: $ref: '#/components/schemas/SubNetMapping' skip_connection_extnet: type: boolean default: false sync_instance_ports: type: boolean default: false networks: type: array items: type: string format: uuid description: '' MappingRequest: type: object properties: volume_types: type: array items: $ref: '#/components/schemas/VolumeTypeMappingRequest' subnets: type: array items: $ref: '#/components/schemas/SubNetMappingRequest' skip_connection_extnet: type: boolean default: false sync_instance_ports: type: boolean default: false networks: type: array items: type: string format: uuid description: '' MarketplaceCategory: type: object description: '' properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true title: type: string maxLength: 255 description: type: string icon: type: string format: uri nullable: true default_vm_category: type: boolean description: Set to "true" if this category is for OpenStack VM. Only one category can have "true" value. default_volume_category: type: boolean description: Set to true if this category is for OpenStack Volume. Only one category can have "true" value. default_tenant_category: type: boolean description: Set to true if this category is for OpenStack Tenant. Only one category can have "true" value. offering_count: type: integer readOnly: true available_offerings_count: type: integer readOnly: true sections: type: array items: $ref: '#/components/schemas/NestedSection' readOnly: true columns: type: array items: $ref: '#/components/schemas/NestedColumn' readOnly: true components: type: array items: $ref: '#/components/schemas/CategoryComponent' readOnly: true articles: type: array items: $ref: '#/components/schemas/CategoryHelpArticle' readOnly: true group: type: string format: uri nullable: true required: [] MarketplaceCategoryRequest: type: object description: '' properties: title: type: string minLength: 1 maxLength: 255 description: type: string icon: type: string format: binary nullable: true default_vm_category: type: boolean description: Set to "true" if this category is for OpenStack VM. Only one category can have "true" value. default_volume_category: type: boolean description: Set to true if this category is for OpenStack Volume. Only one category can have "true" value. default_tenant_category: type: boolean description: Set to true if this category is for OpenStack Tenant. Only one category can have "true" value. group: type: string format: uri nullable: true required: - title MarketplaceCustomerStats: type: object properties: name: type: string readOnly: true uuid: type: string readOnly: true count: type: integer readOnly: true abbreviation: type: string readOnly: true required: - abbreviation - count - name - uuid description: '' MarketplaceProviderCustomer: type: object description: '' properties: uuid: type: string format: uuid readOnly: true name: type: string maxLength: 150 slug: type: string maxLength: 50 pattern: ^[-a-zA-Z0-9_]+$ abbreviation: type: string maxLength: 12 phone_number: type: string maxLength: 255 email: type: string format: email title: Email address maxLength: 75 payment_profiles: type: array items: $ref: '#/components/schemas/PaymentProfile' readOnly: true billing_price_estimate: allOf: - $ref: '#/components/schemas/NestedPriceEstimate' readOnly: true projects_count: type: integer readOnly: true users_count: type: integer readOnly: true projects: type: array items: $ref: '#/components/schemas/ProviderProject' readOnly: true users: type: array items: $ref: '#/components/schemas/ProviderUser' readOnly: true required: [] MarketplaceProviderCustomerProject: type: object description: '' properties: uuid: type: string format: uuid readOnly: true name: type: string maxLength: 500 description: type: string maxLength: 2000 end_date: type: string format: date nullable: true description: The date is inclusive. Once reached, all project resource will be scheduled for termination. resources_count: type: integer readOnly: true users_count: type: integer readOnly: true billing_price_estimate: allOf: - $ref: '#/components/schemas/NestedPriceEstimate' readOnly: true required: [] MarketplaceServiceProviderUser: type: object description: '' properties: uuid: type: string format: uuid readOnly: true username: type: string description: Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters pattern: ^[0-9a-z_.@+-]+$ maxLength: 128 full_name: type: string readOnly: true first_name: type: string maxLength: 100 last_name: type: string maxLength: 100 organization: type: string maxLength: 255 email: type: string format: email title: Email address maxLength: 320 phone_number: type: string maxLength: 255 projects_count: type: integer readOnly: true registration_method: type: string description: Indicates what registration method was used. maxLength: 50 affiliations: description: Person's affiliation within organization such as student, faculty, staff. is_active: type: boolean title: Active description: Designates whether this user should be treated as active. Unselect this instead of deleting accounts. required: [] MergedPluginOptions: type: object properties: auto_approve_remote_orders: type: boolean description: If set to True, an order can be processed without approval service_provider_can_create_offering_user: type: boolean description: Service provider can create offering user max_resource_termination_offset_in_days: type: integer minimum: 0 description: Maximum resource termination offset in days default_resource_termination_offset_in_days: type: integer minimum: 0 description: If set, it will be used as a default resource termination offset in days is_resource_termination_date_required: type: boolean description: If set to True, resource termination date is required latest_date_for_resource_termination: type: string format: date description: If set, it will be used as a latest date for resource termination auto_approve_in_service_provider_projects: type: boolean description: Skip approval of public offering belonging to the same organization under which the request is done supports_downscaling: type: boolean description: If set to True, it will be possible to downscale resources supports_pausing: type: boolean description: If set to True, it will be possible to pause resources minimal_team_count_for_provisioning: type: integer minimum: 1 description: Minimal team count required for provisioning of resources required_team_role_for_provisioning: type: string description: Required user role in a project for provisioning of resources default_internal_network_mtu: type: integer maximum: 9000 minimum: 68 description: If set, it will be used as a default MTU for the first network in a tenant max_instances: type: integer minimum: 1 description: Default limit for number of instances in OpenStack tenant max_volumes: type: integer minimum: 1 description: Default limit for number of volumes in OpenStack tenant storage_mode: allOf: - $ref: '#/components/schemas/StorageModeEnum' description: Storage mode for OpenStack offering snapshot_size_limit_gb: type: integer minimum: 1 description: Default limit for snapshot size in GB heappe_cluster_id: type: string description: HEAppE cluster id heappe_local_base_path: type: string description: HEAppE local base path heappe_url: type: string description: HEAppE url heappe_username: type: string description: HEAppE username homedir_prefix: type: string default: /home/ description: GLAuth homedir prefix initial_primarygroup_number: type: integer minimum: 0 default: 5000 description: GLAuth initial primary group number initial_uidnumber: type: integer minimum: 0 default: 5000 description: GLAuth initial uidnumber initial_usergroup_number: type: integer minimum: 0 default: 6000 description: GLAuth initial usergroup number username_anonymized_prefix: type: string default: waldur_ description: GLAuth prefix for anonymized usernames username_generation_policy: allOf: - $ref: '#/components/schemas/UsernameGenerationPolicyEnum' default: service_provider description: GLAuth username generation policy enable_issues_for_membership_changes: type: boolean description: Enable issues for membership changes flavors_regex: type: string description: Regular expression to limit flavors list openstack_offering_uuid_list: type: array items: type: string description: List of UUID of OpenStack offerings where tenant can be created managed_rancher_server_flavor_name: type: string managed_rancher_server_system_volume_size_gb: type: integer managed_rancher_server_system_volume_type_name: type: string managed_rancher_server_data_volume_size_gb: type: integer managed_rancher_server_data_volume_type_name: type: string managed_rancher_worker_system_volume_size_gb: type: integer managed_rancher_worker_system_volume_type_name: type: string managed_rancher_load_balancer_flavor_name: type: string managed_rancher_load_balancer_system_volume_size_gb: type: integer managed_rancher_load_balancer_system_volume_type_name: type: string managed_rancher_load_balancer_data_volume_size_gb: type: integer managed_rancher_load_balancer_data_volume_type_name: type: string managed_rancher_tenant_max_cpu: type: integer description: Max number of vCPUs for tenants managed_rancher_tenant_max_ram: type: integer description: Max number of RAM for tenants (GB) managed_rancher_tenant_max_disk: type: integer description: Max size of disk space for tenants (GB) account_name_generation_policy: nullable: true description: Slurm account name generation policy oneOf: - $ref: '#/components/schemas/AccountNameGenerationPolicyEnum' - $ref: '#/components/schemas/NullEnum' description: '' MergedPluginOptionsRequest: type: object properties: auto_approve_remote_orders: type: boolean description: If set to True, an order can be processed without approval service_provider_can_create_offering_user: type: boolean description: Service provider can create offering user max_resource_termination_offset_in_days: type: integer minimum: 0 description: Maximum resource termination offset in days default_resource_termination_offset_in_days: type: integer minimum: 0 description: If set, it will be used as a default resource termination offset in days is_resource_termination_date_required: type: boolean description: If set to True, resource termination date is required latest_date_for_resource_termination: type: string format: date description: If set, it will be used as a latest date for resource termination auto_approve_in_service_provider_projects: type: boolean description: Skip approval of public offering belonging to the same organization under which the request is done supports_downscaling: type: boolean description: If set to True, it will be possible to downscale resources supports_pausing: type: boolean description: If set to True, it will be possible to pause resources minimal_team_count_for_provisioning: type: integer minimum: 1 description: Minimal team count required for provisioning of resources required_team_role_for_provisioning: type: string minLength: 1 description: Required user role in a project for provisioning of resources default_internal_network_mtu: type: integer maximum: 9000 minimum: 68 description: If set, it will be used as a default MTU for the first network in a tenant max_instances: type: integer minimum: 1 description: Default limit for number of instances in OpenStack tenant max_volumes: type: integer minimum: 1 description: Default limit for number of volumes in OpenStack tenant storage_mode: allOf: - $ref: '#/components/schemas/StorageModeEnum' description: Storage mode for OpenStack offering snapshot_size_limit_gb: type: integer minimum: 1 description: Default limit for snapshot size in GB heappe_cluster_id: type: string minLength: 1 description: HEAppE cluster id heappe_local_base_path: type: string minLength: 1 description: HEAppE local base path heappe_url: type: string minLength: 1 description: HEAppE url heappe_username: type: string minLength: 1 description: HEAppE username homedir_prefix: type: string minLength: 1 default: /home/ description: GLAuth homedir prefix initial_primarygroup_number: type: integer minimum: 0 default: 5000 description: GLAuth initial primary group number initial_uidnumber: type: integer minimum: 0 default: 5000 description: GLAuth initial uidnumber initial_usergroup_number: type: integer minimum: 0 default: 6000 description: GLAuth initial usergroup number username_anonymized_prefix: type: string minLength: 1 default: waldur_ description: GLAuth prefix for anonymized usernames username_generation_policy: allOf: - $ref: '#/components/schemas/UsernameGenerationPolicyEnum' default: service_provider description: GLAuth username generation policy enable_issues_for_membership_changes: type: boolean description: Enable issues for membership changes flavors_regex: type: string minLength: 1 description: Regular expression to limit flavors list openstack_offering_uuid_list: type: array items: type: string minLength: 1 description: List of UUID of OpenStack offerings where tenant can be created managed_rancher_server_flavor_name: type: string minLength: 1 managed_rancher_server_system_volume_size_gb: type: integer managed_rancher_server_system_volume_type_name: type: string minLength: 1 managed_rancher_server_data_volume_size_gb: type: integer managed_rancher_server_data_volume_type_name: type: string minLength: 1 managed_rancher_worker_system_volume_size_gb: type: integer managed_rancher_worker_system_volume_type_name: type: string minLength: 1 managed_rancher_load_balancer_flavor_name: type: string minLength: 1 managed_rancher_load_balancer_system_volume_size_gb: type: integer managed_rancher_load_balancer_system_volume_type_name: type: string minLength: 1 managed_rancher_load_balancer_data_volume_size_gb: type: integer managed_rancher_load_balancer_data_volume_type_name: type: string minLength: 1 managed_rancher_tenant_max_cpu: type: integer description: Max number of vCPUs for tenants managed_rancher_tenant_max_ram: type: integer description: Max number of RAM for tenants (GB) managed_rancher_tenant_max_disk: type: integer description: Max size of disk space for tenants (GB) account_name_generation_policy: nullable: true description: Slurm account name generation policy oneOf: - $ref: '#/components/schemas/AccountNameGenerationPolicyEnum' - $ref: '#/components/schemas/NullEnum' description: '' MergedSecretOptions: type: object properties: heappe_cluster_password: type: string description: HEAppE cluster password heappe_password: type: string description: HEAppE password ipv4_external_ip_mapping: type: array items: $ref: '#/components/schemas/IPMapping' description: OpenStack IPv4 external IP mapping openstack_api_tls_certificate: type: string dns_nameservers: type: array items: type: string description: Default value for new subnets DNS name servers. Should be defined as list. shared_user_password: type: string description: GLAuth shared user password template_confirmation_comment: type: string description: Template confirmation comment language: type: string description: 'Script language: Python or Bash' environ: description: Script environment variables create: type: string description: Script for resource creation terminate: type: string description: Script for resource termination update: type: string description: Script for resource update pull: type: string description: Script for regular resource pull api_url: type: string description: API URL token: type: string description: Waldur access token customer_uuid: type: string description: Organization UUID backend_url: type: string title: Rancher server URL maxLength: 200 username: type: string title: Rancher access key maxLength: 100 password: type: string title: Rancher secret key maxLength: 100 cloud_init_template: type: string managed_rancher_load_balancer_cloud_init_template: type: string vault_host: type: string description: Host of the Vault server vault_port: type: integer description: Port of the Vault server vault_token: type: string description: Token for the Vault server vault_tls_verify: type: boolean description: Whether to verify the Vault server certificate keycloak_url: type: string description: URL of the Keycloak server keycloak_realm: type: string description: Keycloak realm for Rancher keycloak_user_realm: type: string description: Keycloak user realm for auth keycloak_username: type: string description: Username of the Keycloak integration user keycloak_password: type: string description: Password of the Keycloak integration user keycloak_sync_frequency: type: integer description: Frequency in minutes for syncing Keycloak users keycloak_ssl_verify: type: boolean description: Indicates whether verify SSL certificates argocd_k8s_namespace: type: string description: Namespace where ArgoCD is deployed argocd_k8s_kubeconfig: type: string description: Kubeconfig with access to namespace where ArgoCD is deployed base_image_name: type: string description: Base image name private_registry_url: type: string description: URL of a private registry for a cluster private_registry_user: type: string description: Username for accessing a private registry private_registry_password: type: string description: Password for accessing a private registry k8s_version: type: string description: Kubernetes version node_disk_driver: allOf: - $ref: '#/components/schemas/NodeDiskDriverEnum' description: OpenStack disk driver for Rancher nodes description: '' MergedSecretOptionsRequest: type: object properties: heappe_cluster_password: type: string minLength: 1 description: HEAppE cluster password heappe_password: type: string minLength: 1 description: HEAppE password ipv4_external_ip_mapping: type: array items: $ref: '#/components/schemas/IPMappingRequest' description: OpenStack IPv4 external IP mapping openstack_api_tls_certificate: type: string dns_nameservers: type: array items: type: string minLength: 1 description: Default value for new subnets DNS name servers. Should be defined as list. shared_user_password: type: string minLength: 1 description: GLAuth shared user password template_confirmation_comment: type: string minLength: 1 description: Template confirmation comment language: type: string minLength: 1 description: 'Script language: Python or Bash' environ: description: Script environment variables create: type: string minLength: 1 description: Script for resource creation terminate: type: string minLength: 1 description: Script for resource termination update: type: string minLength: 1 description: Script for resource update pull: type: string minLength: 1 description: Script for regular resource pull api_url: type: string minLength: 1 description: API URL token: type: string minLength: 1 description: Waldur access token customer_uuid: type: string minLength: 1 description: Organization UUID backend_url: type: string minLength: 1 title: Rancher server URL maxLength: 200 username: type: string minLength: 1 title: Rancher access key maxLength: 100 password: type: string minLength: 1 title: Rancher secret key maxLength: 100 cloud_init_template: type: string minLength: 1 managed_rancher_load_balancer_cloud_init_template: type: string vault_host: type: string minLength: 1 description: Host of the Vault server vault_port: type: integer description: Port of the Vault server vault_token: type: string minLength: 1 description: Token for the Vault server vault_tls_verify: type: boolean description: Whether to verify the Vault server certificate keycloak_url: type: string minLength: 1 description: URL of the Keycloak server keycloak_realm: type: string minLength: 1 description: Keycloak realm for Rancher keycloak_user_realm: type: string minLength: 1 description: Keycloak user realm for auth keycloak_username: type: string minLength: 1 description: Username of the Keycloak integration user keycloak_password: type: string minLength: 1 description: Password of the Keycloak integration user keycloak_sync_frequency: type: integer description: Frequency in minutes for syncing Keycloak users keycloak_ssl_verify: type: boolean description: Indicates whether verify SSL certificates argocd_k8s_namespace: type: string minLength: 1 description: Namespace where ArgoCD is deployed argocd_k8s_kubeconfig: type: string minLength: 1 description: Kubeconfig with access to namespace where ArgoCD is deployed base_image_name: type: string minLength: 1 description: Base image name private_registry_url: type: string minLength: 1 description: URL of a private registry for a cluster private_registry_user: type: string minLength: 1 description: Username for accessing a private registry private_registry_password: type: string minLength: 1 description: Password for accessing a private registry k8s_version: type: string minLength: 1 description: Kubernetes version node_disk_driver: allOf: - $ref: '#/components/schemas/NodeDiskDriverEnum' description: OpenStack disk driver for Rancher nodes description: '' MessageTemplate: type: object properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true name: type: string maxLength: 150 subject: type: string body: type: string required: - body - name - subject - url - uuid description: '' MessageTemplateRequest: type: object properties: name: type: string minLength: 1 maxLength: 150 subject: type: string minLength: 1 body: type: string minLength: 1 required: - body - name - subject description: '' MigrationCreate: type: object properties: mappings: $ref: '#/components/schemas/Mapping' src_resource: type: string format: uuid required: - src_resource description: '' MigrationCreateRequest: type: object properties: name: type: string writeOnly: true minLength: 1 description: type: string writeOnly: true minLength: 1 mappings: $ref: '#/components/schemas/MappingRequest' src_resource: type: string format: uuid dst_offering: type: string format: uuid writeOnly: true dst_plan: type: string format: uuid writeOnly: true required: - dst_offering - dst_plan - src_resource description: '' MigrationDetails: type: object properties: uuid: type: string format: uuid readOnly: true created: type: string format: date-time readOnly: true modified: type: string format: date-time readOnly: true mappings: $ref: '#/components/schemas/Mapping' created_by_uuid: type: string format: uuid readOnly: true created_by_full_name: type: string readOnly: true src_offering_uuid: type: string format: uuid readOnly: true src_offering_name: type: string readOnly: true dst_offering_uuid: type: string format: uuid readOnly: true dst_offering_name: type: string readOnly: true src_resource_uuid: type: string format: uuid readOnly: true src_resource_name: type: string readOnly: true dst_resource_uuid: type: string format: uuid readOnly: true dst_resource_name: type: string readOnly: true dst_resource_state: type: string readOnly: true state: type: string readOnly: true error_message: type: string error_traceback: type: string required: - created - created_by_full_name - created_by_uuid - dst_offering_name - dst_offering_uuid - dst_resource_name - dst_resource_state - dst_resource_uuid - mappings - modified - src_offering_name - src_offering_uuid - src_resource_name - src_resource_uuid - state - uuid description: '' MigrationDetailsRequest: type: object properties: mappings: $ref: '#/components/schemas/MappingRequest' error_message: type: string error_traceback: type: string required: - mappings description: '' MinimalConsumptionLogicEnum: enum: - fixed - linear type: string description: '' MoveOfferingRequest: type: object properties: customer: type: string format: uri preserve_permissions: type: boolean required: - customer - preserve_permissions description: '' MoveProjectRequest: type: object properties: customer: type: string format: uri preserve_permissions: type: boolean required: - customer - preserve_permissions description: '' NameUUID: type: object properties: name: type: string readOnly: true uuid: type: string format: uuid readOnly: true required: - name - uuid description: '' NestedAttribute: type: object properties: key: type: string pattern: ^[a-zA-Z0-9_\-\/:]+$ maxLength: 255 title: type: string maxLength: 255 type: $ref: '#/components/schemas/NestedAttributeTypeEnum' options: type: array items: $ref: '#/components/schemas/NestedAttributeOption' required: type: boolean description: A value must be provided for the attribute. default: nullable: true required: [] description: '' NestedAttributeOption: type: object properties: key: type: string pattern: ^[a-zA-Z0-9_\-\/:]+$ maxLength: 255 title: type: string maxLength: 255 required: [] description: '' NestedAttributeOptionRequest: type: object properties: key: type: string minLength: 1 pattern: ^[a-zA-Z0-9_\-\/:]+$ maxLength: 255 title: type: string minLength: 1 maxLength: 255 required: - key - title description: '' NestedAttributeRequest: type: object properties: key: type: string minLength: 1 pattern: ^[a-zA-Z0-9_\-\/:]+$ maxLength: 255 title: type: string minLength: 1 maxLength: 255 type: $ref: '#/components/schemas/NestedAttributeTypeEnum' options: type: array items: $ref: '#/components/schemas/NestedAttributeOptionRequest' required: type: boolean description: A value must be provided for the attribute. default: nullable: true required: - key - options - title - type description: '' NestedAttributeTypeEnum: enum: - boolean - string - text - integer - choice - list type: string description: '' NestedCampaign: type: object description: '' properties: uuid: type: string format: uuid readOnly: true name: type: string maxLength: 150 start_date: type: string format: date description: Starting from this date, the campaign is active. end_date: type: string format: date description: The last day the campaign is active. discount_type: $ref: '#/components/schemas/DiscountTypeEnum' discount: type: integer maximum: 2147483647 minimum: -2147483648 stock: type: integer maximum: 2147483647 minimum: 0 nullable: true description: type: string maxLength: 2000 months: type: integer maximum: 2147483647 minimum: 0 description: How many months in a row should the related service (when activated) get special deal (0 for indefinitely until active) service_provider: type: string format: uri required: [] NestedColumn: type: object properties: uuid: type: string format: uuid readOnly: true index: type: integer maximum: 32767 minimum: 0 description: Index allows to reorder columns. title: type: string description: Title is rendered as column header. maxLength: 255 attribute: type: string description: Resource attribute is rendered as table cell. maxLength: 255 widget: nullable: true description: Widget field allows to customise table cell rendering. oneOf: - $ref: '#/components/schemas/WidgetEnum' - $ref: '#/components/schemas/BlankEnum' - $ref: '#/components/schemas/NullEnum' required: [] description: '' NestedColumnRequest: type: object properties: index: type: integer maximum: 32767 minimum: 0 description: Index allows to reorder columns. title: type: string minLength: 1 description: Title is rendered as column header. maxLength: 255 attribute: type: string description: Resource attribute is rendered as table cell. maxLength: 255 widget: nullable: true description: Widget field allows to customise table cell rendering. oneOf: - $ref: '#/components/schemas/WidgetEnum' - $ref: '#/components/schemas/BlankEnum' - $ref: '#/components/schemas/NullEnum' required: - index - title description: '' NestedEndpoint: type: object properties: uuid: type: string format: uuid readOnly: true name: type: string maxLength: 150 url: type: string required: [] description: '' NestedEndpointRequest: type: object properties: name: type: string minLength: 1 maxLength: 150 url: type: string minLength: 1 required: - name - url description: '' NestedFeedback: type: object properties: evaluation: type: integer readOnly: true evaluation_number: type: integer readOnly: true comment: type: string state: type: string readOnly: true required: - evaluation - evaluation_number - state description: '' NestedFeedbackRequest: type: object properties: comment: type: string description: '' NestedOfferingComponentLimit: type: object properties: type: type: string limit: type: integer maximum: 2147483647 minimum: -2147483648 required: - limit - type description: '' NestedOfferingComponentLimitRequest: type: object properties: type: type: string minLength: 1 limit: type: integer maximum: 2147483647 minimum: -2147483648 required: - limit - type description: '' NestedOfferingFile: type: object properties: name: type: string maxLength: 150 created: type: string format: date-time readOnly: true file: type: string format: uri required: [] description: '' NestedOfferingFileRequest: type: object properties: name: type: string minLength: 1 maxLength: 150 file: type: string format: binary required: - file - name description: '' NestedPriceEstimate: type: object properties: total: type: string format: decimal pattern: ^-?\d{0,12}(?:\.\d{0,10})?$ readOnly: true current: type: string format: decimal pattern: ^-?\d{0,12}(?:\.\d{0,10})?$ readOnly: true tax: type: string format: decimal pattern: ^-?\d{0,12}(?:\.\d{0,10})?$ readOnly: true tax_current: type: string format: decimal pattern: ^-?\d{0,12}(?:\.\d{0,10})?$ readOnly: true required: [] description: '' NestedProject: type: object description: '' properties: uuid: type: string format: uuid readOnly: true url: type: string format: uri readOnly: true required: - url - uuid NestedProjectPermission: type: object properties: url: type: string format: uri readOnly: true uuid: type: string readOnly: true name: type: string readOnly: true role_name: type: string readOnly: true expiration_time: type: string format: date-time nullable: true required: [] description: '' NestedProviderOffering: type: object properties: uuid: type: string format: uuid readOnly: true url: type: string format: uri readOnly: true type: type: string maxLength: 100 name: type: string maxLength: 150 required: - name - type - url - uuid description: '' NestedProviderOfferingRequest: type: object properties: type: type: string minLength: 1 maxLength: 100 name: type: string minLength: 1 maxLength: 150 required: - name - type description: '' NestedPublicOffering: type: object properties: uuid: type: string format: uuid readOnly: true url: type: string format: uri readOnly: true type: type: string maxLength: 100 name: type: string maxLength: 150 required: - name - type - url - uuid description: '' NestedPublicOfferingRequest: type: object properties: type: type: string minLength: 1 maxLength: 100 name: type: string minLength: 1 maxLength: 150 required: - name - type description: '' NestedRemoteLocalCategory: type: object properties: local_category: type: string format: uri remote_category: type: string format: uuid local_category_name: type: string readOnly: true local_category_uuid: type: string format: uuid readOnly: true remote_category_name: type: string maxLength: 255 required: - local_category - local_category_name - local_category_uuid - remote_category description: '' NestedRemoteLocalCategoryRequest: type: object properties: local_category: type: string format: uri remote_category: type: string format: uuid remote_category_name: type: string minLength: 1 maxLength: 255 required: - local_category - remote_category description: '' NestedRequestedOffering: type: object properties: uuid: type: string format: uuid readOnly: true state: allOf: - $ref: '#/components/schemas/RequestedOfferingStates' readOnly: true offering: type: string format: uri offering_name: type: string readOnly: true offering_uuid: type: string format: uuid readOnly: true provider_name: type: string readOnly: true category_uuid: type: string format: uuid readOnly: true category_name: type: string readOnly: true call_managing_organisation: type: string readOnly: true attributes: {} plan: type: string format: uri nullable: true plan_details: allOf: - $ref: '#/components/schemas/BasePublicPlan' readOnly: true options: allOf: - $ref: '#/components/schemas/OfferingOptions' readOnly: true components: type: array items: $ref: '#/components/schemas/OfferingComponent' readOnly: true created: type: string format: date-time readOnly: true required: [] description: '' NestedRequestedOfferingRequest: type: object properties: offering: type: string format: uri attributes: {} plan: type: string format: uri nullable: true required: - offering description: '' NestedRole: type: object properties: uuid: type: string format: uuid readOnly: true name: type: string maxLength: 150 url: type: string format: uri readOnly: true required: [] description: '' NestedRoleRequest: type: object properties: name: type: string minLength: 1 maxLength: 150 required: - name description: '' NestedRound: type: object properties: uuid: type: string format: uuid readOnly: true name: type: string readOnly: true start_time: type: string format: date-time cutoff_time: type: string format: date-time status: allOf: - $ref: '#/components/schemas/StatusEnum' readOnly: true review_strategy: $ref: '#/components/schemas/ReviewStrategyEnum' deciding_entity: $ref: '#/components/schemas/DecidingEntityEnum' allocation_time: $ref: '#/components/schemas/AllocationTimeEnum' allocation_date: type: string format: date-time nullable: true minimal_average_scoring: type: string format: decimal pattern: ^-?\d{0,4}(?:\.\d{0,1})?$ nullable: true review_duration_in_days: type: integer maximum: 2147483647 minimum: 0 nullable: true minimum_number_of_reviewers: type: integer maximum: 2147483647 minimum: 0 nullable: true required: [] description: '' NestedRoundRequest: type: object properties: start_time: type: string format: date-time cutoff_time: type: string format: date-time review_strategy: $ref: '#/components/schemas/ReviewStrategyEnum' deciding_entity: $ref: '#/components/schemas/DecidingEntityEnum' allocation_time: $ref: '#/components/schemas/AllocationTimeEnum' allocation_date: type: string format: date-time nullable: true minimal_average_scoring: type: string format: decimal pattern: ^-?\d{0,4}(?:\.\d{0,1})?$ nullable: true review_duration_in_days: type: integer maximum: 2147483647 minimum: 0 nullable: true minimum_number_of_reviewers: type: integer maximum: 2147483647 minimum: 0 nullable: true required: - cutoff_time - start_time description: '' NestedScreenshot: type: object properties: name: type: string maxLength: 150 uuid: type: string format: uuid readOnly: true description: type: string maxLength: 2000 image: type: string format: uri thumbnail: type: string format: uri readOnly: true nullable: true created: type: string format: date-time readOnly: true required: [] description: '' NestedScreenshotRequest: type: object properties: name: type: string minLength: 1 maxLength: 150 description: type: string maxLength: 2000 image: type: string format: binary required: - image - name description: '' NestedSection: type: object properties: key: type: string maxLength: 255 title: type: string maxLength: 255 attributes: type: array items: $ref: '#/components/schemas/NestedAttribute' readOnly: true is_standalone: type: boolean description: Whether section is rendered as a separate tab. required: [] description: '' NestedSectionRequest: type: object properties: key: type: string minLength: 1 maxLength: 255 title: type: string minLength: 1 maxLength: 255 is_standalone: type: boolean description: Whether section is rendered as a separate tab. required: - key - title description: '' NestedSecurityGroupRule: type: object properties: ethertype: allOf: - $ref: '#/components/schemas/EthertypeEnum' description: IP protocol version - either 'IPv4' or 'IPv6' direction: allOf: - $ref: '#/components/schemas/DirectionEnum' description: Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing) protocol: description: The network protocol (TCP, UDP, ICMP, or empty for any protocol) oneOf: - $ref: '#/components/schemas/ProtocolEnum' - $ref: '#/components/schemas/BlankEnum' from_port: type: integer maximum: 65535 minimum: -2147483648 nullable: true description: Starting port number in the range (1-65535) to_port: type: integer maximum: 65535 minimum: -2147483648 nullable: true description: Ending port number in the range (1-65535) cidr: type: string nullable: true description: CIDR notation for the source/destination network address range maxLength: 255 description: type: string maxLength: 2000 remote_group_name: type: string readOnly: true remote_group_uuid: type: string format: uuid readOnly: true id: type: integer readOnly: true required: [] description: '' NestedSecurityGroupRuleRequest: type: object properties: ethertype: allOf: - $ref: '#/components/schemas/EthertypeEnum' description: IP protocol version - either 'IPv4' or 'IPv6' direction: allOf: - $ref: '#/components/schemas/DirectionEnum' description: Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing) protocol: description: The network protocol (TCP, UDP, ICMP, or empty for any protocol) oneOf: - $ref: '#/components/schemas/ProtocolEnum' - $ref: '#/components/schemas/BlankEnum' from_port: type: integer maximum: 65535 minimum: -2147483648 nullable: true description: Starting port number in the range (1-65535) to_port: type: integer maximum: 65535 minimum: -2147483648 nullable: true description: Ending port number in the range (1-65535) cidr: type: string nullable: true description: CIDR notation for the source/destination network address range maxLength: 255 description: type: string maxLength: 2000 description: '' NetworkRBACPolicy: type: object description: '' properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true network: type: string format: uri readOnly: true network_name: type: string readOnly: true target_tenant: type: string format: uri target_tenant_name: type: string readOnly: true backend_id: type: string readOnly: true policy_type: allOf: - $ref: '#/components/schemas/PolicyTypeEnum' default: access_as_shared description: Type of access granted - either shared access or external network access created: type: string format: date-time readOnly: true required: [] NetworkRBACPolicyRequest: type: object description: '' properties: target_tenant: type: string format: uri policy_type: allOf: - $ref: '#/components/schemas/PolicyTypeEnum' default: access_as_shared description: Type of access granted - either shared access or external network access required: - target_tenant NodeDiskDriverEnum: enum: - sd - vd type: string description: '' Notification: type: object properties: uuid: type: string format: uuid readOnly: true url: type: string format: uri readOnly: true key: type: string maxLength: 255 description: type: string maxLength: 2000 enabled: type: boolean readOnly: true description: Indicates if notification is enabled or disabled created: type: string format: date-time readOnly: true templates: type: array items: $ref: '#/components/schemas/NotificationTemplateDetailSerializers' readOnly: true required: - created - enabled - key - templates - url - uuid description: '' NotificationRequest: type: object properties: key: type: string minLength: 1 maxLength: 255 description: type: string maxLength: 2000 required: - key description: '' NotificationTemplateDetailSerializers: type: object properties: uuid: type: string format: uuid readOnly: true url: type: string format: uri readOnly: true path: type: string description: 'Example: ''flatpages/default.html''' maxLength: 150 name: type: string maxLength: 150 content: type: string readOnly: true original_content: type: string nullable: true readOnly: true is_content_overridden: type: boolean readOnly: true required: - content - is_content_overridden - name - original_content - path - url - uuid description: '' NotificationTemplateDetailSerializersRequest: type: object properties: path: type: string minLength: 1 description: 'Example: ''flatpages/default.html''' maxLength: 150 name: type: string minLength: 1 maxLength: 150 required: - name - path description: '' NotificationTemplateUpdateSerializersRequest: type: object properties: content: type: string minLength: 1 required: - content description: '' NullEnum: enum: - null description: '' ObtainAuthTokenRequest: type: object description: '' properties: username: type: string minLength: 1 maxLength: 128 password: type: string minLength: 1 maxLength: 128 required: - password - username OecdFos2007CodeEnum: enum: - '1.1' - '1.2' - '1.3' - '1.4' - '1.5' - '1.6' - '1.7' - '2.1' - '2.2' - '2.3' - '2.4' - '2.5' - '2.6' - '2.7' - '2.8' - '2.9' - '2.10' - '2.11' - '2.12' - '3.1' - '3.2' - '3.3' - '3.4' - '3.5' - '4.1' - '4.2' - '4.3' - '4.4' - '4.5' - '5.1' - '5.2' - '5.3' - '5.4' - '5.5' - '5.6' - '5.7' - '5.8' - '5.9' - '6.1' - '6.2' - '6.3' - '6.4' - '6.5' type: string description: '' Offering: type: object description: '' properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true created: type: string format: date-time readOnly: true name: type: string maxLength: 150 slug: type: string maxLength: 50 pattern: ^[-a-zA-Z0-9_]+$ description: type: string maxLength: 2000 full_description: type: string privacy_policy_link: type: string format: uri maxLength: 200 access_url: type: string format: uri description: Publicly accessible offering access URL maxLength: 200 endpoints: type: array items: $ref: '#/components/schemas/NestedEndpoint' readOnly: true roles: type: array items: $ref: '#/components/schemas/NestedRole' readOnly: true customer: type: string format: uri nullable: true customer_uuid: type: string format: uuid readOnly: true nullable: true customer_name: type: string readOnly: true nullable: true project: type: string format: uri readOnly: true nullable: true project_uuid: type: string format: uuid readOnly: true nullable: true project_name: type: string readOnly: true nullable: true category: type: string format: uri category_uuid: type: string format: uuid readOnly: true category_title: type: string readOnly: true attributes: type: object additionalProperties: {} readOnly: true options: allOf: - $ref: '#/components/schemas/OfferingOptions' readOnly: true resource_options: allOf: - $ref: '#/components/schemas/OfferingOptions' readOnly: true components: type: array items: $ref: '#/components/schemas/OfferingComponent' readOnly: true plugin_options: allOf: - $ref: '#/components/schemas/MergedPluginOptions' readOnly: true state: allOf: - $ref: '#/components/schemas/OfferingState' readOnly: true vendor_details: type: string getting_started: type: string integration_guide: type: string thumbnail: type: string format: uri nullable: true order_count: type: integer readOnly: true plans: type: array items: $ref: '#/components/schemas/BasePublicPlan' readOnly: true screenshots: type: array items: $ref: '#/components/schemas/NestedScreenshot' readOnly: true type: type: string maxLength: 100 shared: type: boolean description: Accessible to all customers. billable: type: boolean description: Purchase and usage is invoiced. scope: type: string readOnly: true scope_uuid: type: string format: uuid readOnly: true nullable: true scope_name: type: string format: uuid readOnly: true nullable: true scope_state: allOf: - $ref: '#/components/schemas/CoreStates' nullable: true readOnly: true scope_error_message: type: string nullable: true readOnly: true files: type: array items: $ref: '#/components/schemas/NestedOfferingFile' readOnly: true quotas: type: array items: $ref: '#/components/schemas/Quota' readOnly: true paused_reason: type: string readOnly: true datacite_doi: type: string maxLength: 255 citation_count: type: integer readOnly: true description: Number of citations of a DOI latitude: type: number format: double nullable: true longitude: type: number format: double nullable: true country: oneOf: - $ref: '#/components/schemas/CountryEnum' - $ref: '#/components/schemas/BlankEnum' backend_id: type: string maxLength: 255 organization_groups: type: array items: $ref: '#/components/schemas/OrganizationGroup' readOnly: true image: type: string format: uri nullable: true total_customers: type: integer nullable: true readOnly: true total_cost: type: integer nullable: true readOnly: true total_cost_estimated: type: integer nullable: true readOnly: true parent_description: type: string readOnly: true nullable: true parent_uuid: type: string format: uuid readOnly: true nullable: true parent_name: type: string readOnly: true nullable: true backend_metadata: {} has_compliance_requirements: type: boolean readOnly: true googlecalendar: $ref: '#/components/schemas/GoogleCalendar' required: [] OfferingBackendMetadataRequest: type: object properties: backend_metadata: {} description: '' OfferingComponent: type: object properties: uuid: type: string format: uuid readOnly: true billing_type: $ref: '#/components/schemas/BillingTypeEnum' type: type: string description: Unique internal name of the measured unit, for example floating_ip. pattern: ^[a-zA-Z0-9_\-\/:]+$ maxLength: 50 name: type: string description: Display name for the measured unit, for example, Floating IP. maxLength: 150 description: type: string maxLength: 2000 measured_unit: type: string description: Unit of measurement, for example, GB. maxLength: 30 unit_factor: type: integer maximum: 2147483647 minimum: -2147483648 description: The conversion factor from backend units to measured_unit limit_period: nullable: true oneOf: - $ref: '#/components/schemas/LimitPeriodEnum' - $ref: '#/components/schemas/BlankEnum' - $ref: '#/components/schemas/NullEnum' limit_amount: type: integer maximum: 2147483647 minimum: -2147483648 nullable: true article_code: type: string maxLength: 30 max_value: type: integer maximum: 2147483647 minimum: -2147483648 nullable: true min_value: type: integer maximum: 2147483647 minimum: -2147483648 nullable: true max_available_limit: type: integer maximum: 2147483647 minimum: -2147483648 nullable: true is_boolean: type: boolean default_limit: type: integer maximum: 2147483647 minimum: -2147483648 nullable: true factor: type: integer nullable: true readOnly: true is_builtin: type: boolean readOnly: true required: [] description: '' OfferingComponentLimit: type: object properties: min: type: integer minimum: 0 max: type: integer minimum: 0 max_available_limit: type: integer minimum: 0 required: - max - max_available_limit - min description: '' OfferingComponentLimitRequest: type: object properties: min: type: integer minimum: 0 max: type: integer minimum: 0 max_available_limit: type: integer minimum: 0 required: - max - max_available_limit - min description: '' OfferingComponentRequest: type: object properties: billing_type: $ref: '#/components/schemas/BillingTypeEnum' type: type: string minLength: 1 description: Unique internal name of the measured unit, for example floating_ip. pattern: ^[a-zA-Z0-9_\-\/:]+$ maxLength: 50 name: type: string minLength: 1 description: Display name for the measured unit, for example, Floating IP. maxLength: 150 description: type: string maxLength: 2000 measured_unit: type: string description: Unit of measurement, for example, GB. maxLength: 30 unit_factor: type: integer maximum: 2147483647 minimum: -2147483648 description: The conversion factor from backend units to measured_unit limit_period: nullable: true oneOf: - $ref: '#/components/schemas/LimitPeriodEnum' - $ref: '#/components/schemas/BlankEnum' - $ref: '#/components/schemas/NullEnum' limit_amount: type: integer maximum: 2147483647 minimum: -2147483648 nullable: true article_code: type: string maxLength: 30 max_value: type: integer maximum: 2147483647 minimum: -2147483648 nullable: true min_value: type: integer maximum: 2147483647 minimum: -2147483648 nullable: true max_available_limit: type: integer maximum: 2147483647 minimum: -2147483648 nullable: true is_boolean: type: boolean default_limit: type: integer maximum: 2147483647 minimum: -2147483648 nullable: true required: - billing_type - name - type description: '' OfferingComponentStat: type: object properties: period: type: string readOnly: true billing_period: type: string readOnly: true date: type: string readOnly: true usage: type: integer readOnly: true description: type: string readOnly: true measured_unit: type: string readOnly: true type: type: string readOnly: true name: type: string readOnly: true required: - billing_period - date - description - measured_unit - name - period - type - usage description: '' OfferingCost: type: object properties: offering_uuid: type: string format: uuid cost: type: number format: double required: - cost - offering_uuid description: '' OfferingCountryStats: type: object properties: country: type: string count: type: integer required: - count - country description: '' OfferingCreate: type: object description: '' properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true created: type: string format: date-time readOnly: true name: type: string maxLength: 150 slug: type: string readOnly: true maxLength: 50 pattern: ^[-a-zA-Z0-9_]+$ description: type: string full_description: type: string privacy_policy_link: type: string format: uri maxLength: 200 access_url: type: string format: uri description: Publicly accessible offering access URL maxLength: 200 endpoints: type: array items: $ref: '#/components/schemas/NestedEndpoint' readOnly: true roles: type: array items: $ref: '#/components/schemas/NestedRole' readOnly: true customer: type: string format: uri nullable: true customer_uuid: type: string format: uuid readOnly: true nullable: true customer_name: type: string readOnly: true nullable: true project: type: string format: uri readOnly: true nullable: true project_uuid: type: string format: uuid readOnly: true nullable: true project_name: type: string readOnly: true nullable: true category: type: string format: uri category_uuid: type: string format: uuid readOnly: true category_title: type: string readOnly: true attributes: {} options: $ref: '#/components/schemas/OfferingOptions' resource_options: $ref: '#/components/schemas/OfferingOptions' components: type: array items: $ref: '#/components/schemas/OfferingComponent' plugin_options: allOf: - $ref: '#/components/schemas/MergedPluginOptions' readOnly: true secret_options: allOf: - $ref: '#/components/schemas/MergedSecretOptions' readOnly: true service_attributes: type: object additionalProperties: {} readOnly: true state: allOf: - $ref: '#/components/schemas/OfferingState' readOnly: true vendor_details: type: string getting_started: type: string integration_guide: type: string thumbnail: type: string format: uri nullable: true order_count: type: integer readOnly: true plans: type: array items: $ref: '#/components/schemas/BaseProviderPlan' screenshots: type: array items: $ref: '#/components/schemas/NestedScreenshot' readOnly: true type: type: string maxLength: 100 shared: type: boolean description: Accessible to all customers. billable: type: boolean description: Purchase and usage is invoiced. scope: type: string readOnly: true scope_uuid: type: string format: uuid readOnly: true nullable: true scope_name: type: string format: uuid readOnly: true nullable: true scope_state: allOf: - $ref: '#/components/schemas/CoreStates' nullable: true readOnly: true scope_error_message: type: string nullable: true readOnly: true files: type: array items: $ref: '#/components/schemas/NestedOfferingFile' readOnly: true quotas: type: array items: $ref: '#/components/schemas/Quota' readOnly: true paused_reason: type: string readOnly: true datacite_doi: type: string maxLength: 255 citation_count: type: integer readOnly: true description: Number of citations of a DOI latitude: type: number format: double nullable: true longitude: type: number format: double nullable: true country: oneOf: - $ref: '#/components/schemas/CountryEnum' - $ref: '#/components/schemas/BlankEnum' backend_id: type: string maxLength: 255 organization_groups: type: array items: $ref: '#/components/schemas/OrganizationGroup' readOnly: true image: type: string format: uri nullable: true total_customers: type: integer nullable: true readOnly: true total_cost: type: integer nullable: true readOnly: true total_cost_estimated: type: integer nullable: true readOnly: true parent_description: type: string readOnly: true nullable: true parent_uuid: type: string format: uuid readOnly: true nullable: true parent_name: type: string readOnly: true nullable: true backend_metadata: {} has_compliance_requirements: type: boolean readOnly: true required: - category - category_title - category_uuid - citation_count - created - customer_name - customer_uuid - endpoints - files - has_compliance_requirements - name - order_count - organization_groups - parent_description - parent_name - parent_uuid - paused_reason - plugin_options - project - project_name - project_uuid - quotas - roles - scope - scope_error_message - scope_name - scope_state - scope_uuid - screenshots - secret_options - service_attributes - slug - state - total_cost - total_cost_estimated - total_customers - type - url - uuid OfferingCreateRequest: type: object description: '' properties: name: type: string minLength: 1 maxLength: 150 description: type: string full_description: type: string privacy_policy_link: type: string format: uri maxLength: 200 access_url: type: string format: uri description: Publicly accessible offering access URL maxLength: 200 customer: type: string format: uri nullable: true category: type: string format: uri attributes: {} options: $ref: '#/components/schemas/OfferingOptionsRequest' resource_options: $ref: '#/components/schemas/OfferingOptionsRequest' components: type: array items: $ref: '#/components/schemas/OfferingComponentRequest' vendor_details: type: string getting_started: type: string integration_guide: type: string thumbnail: type: string format: binary nullable: true plans: type: array items: $ref: '#/components/schemas/BaseProviderPlanRequest' type: type: string minLength: 1 maxLength: 100 shared: type: boolean description: Accessible to all customers. billable: type: boolean description: Purchase and usage is invoiced. datacite_doi: type: string maxLength: 255 latitude: type: number format: double nullable: true longitude: type: number format: double nullable: true country: oneOf: - $ref: '#/components/schemas/CountryEnum' - $ref: '#/components/schemas/BlankEnum' backend_id: type: string maxLength: 255 image: type: string format: binary nullable: true backend_metadata: {} limits: type: object additionalProperties: $ref: '#/components/schemas/OfferingComponentLimitRequest' writeOnly: true required: - category - name - type OfferingDescriptionUpdateRequest: type: object description: '' properties: category: type: string format: uri required: - category OfferingEstimatedCostPolicy: type: object description: '' properties: uuid: type: string format: uuid readOnly: true url: type: string format: uri readOnly: true scope: type: string format: uri scope_name: type: string readOnly: true scope_uuid: type: string format: uuid readOnly: true actions: type: string maxLength: 255 created: type: string format: date-time readOnly: true created_by_full_name: type: string readOnly: true created_by_username: type: string readOnly: true has_fired: type: boolean readOnly: true fired_datetime: type: string format: date-time readOnly: true options: description: Fields for saving actions extra data. Keys are name of actions. limit_cost: type: integer maximum: 2147483647 minimum: -2147483648 period: allOf: - $ref: '#/components/schemas/PeriodEnum' minimum: -2147483648 maximum: 2147483647 period_name: type: string readOnly: true organization_groups: type: array items: type: string format: uri required: - actions - created - created_by_full_name - created_by_username - fired_datetime - has_fired - limit_cost - organization_groups - period_name - scope - scope_name - scope_uuid - url - uuid OfferingEstimatedCostPolicyRequest: type: object description: '' properties: scope: type: string format: uri actions: type: string minLength: 1 maxLength: 255 options: description: Fields for saving actions extra data. Keys are name of actions. limit_cost: type: integer maximum: 2147483647 minimum: -2147483648 period: allOf: - $ref: '#/components/schemas/PeriodEnum' minimum: -2147483648 maximum: 2147483647 organization_groups: type: array items: type: string format: uri required: - actions - limit_cost - organization_groups - scope OfferingFile: type: object description: '' properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true name: type: string maxLength: 150 offering: type: string format: uri created: type: string format: date-time readOnly: true file: type: string format: uri required: [] OfferingFileRequest: type: object description: '' properties: name: type: string minLength: 1 maxLength: 150 offering: type: string format: uri file: type: string format: binary required: - file - name - offering OfferingGroups: type: object properties: customer_name: type: string readOnly: true customer_uuid: type: string readOnly: true offerings: type: array items: $ref: '#/components/schemas/OfferingReference' readOnly: true required: - customer_name - customer_uuid - offerings description: '' OfferingImageRequest: type: object properties: image: type: string format: binary required: - image description: '' OfferingIntegrationUpdateRequest: type: object properties: secret_options: $ref: '#/components/schemas/MergedSecretOptionsRequest' plugin_options: $ref: '#/components/schemas/MergedPluginOptionsRequest' service_attributes: {} backend_id: type: string maxLength: 255 description: '' OfferingLocationUpdateRequest: type: object properties: latitude: type: number format: double longitude: type: number format: double required: - latitude - longitude description: '' OfferingOptions: type: object properties: order: type: array items: type: string options: type: object additionalProperties: $ref: '#/components/schemas/OptionField' required: [] description: '' OfferingOptionsRequest: type: object properties: order: type: array items: type: string minLength: 1 options: type: object additionalProperties: $ref: '#/components/schemas/OptionFieldRequest' required: - options - order description: '' OfferingOptionsUpdateRequest: type: object properties: options: $ref: '#/components/schemas/OfferingOptionsRequest' required: - options description: '' OfferingOverviewUpdateRequest: type: object description: '' properties: name: type: string minLength: 1 maxLength: 150 description: type: string full_description: type: string privacy_policy_link: type: string format: uri maxLength: 200 access_url: type: string format: uri description: Publicly accessible offering access URL maxLength: 200 getting_started: type: string integration_guide: type: string required: - name OfferingPauseRequest: type: object properties: paused_reason: type: string description: '' OfferingPermission: type: object description: '' properties: url: type: string format: uri readOnly: true pk: type: integer readOnly: true title: ID created: type: string format: date-time readOnly: true expiration_time: type: string format: date-time nullable: true created_by: type: string format: uri readOnly: true nullable: true offering: type: string format: uri readOnly: true offering_uuid: type: string format: uuid readOnly: true offering_slug: type: string readOnly: true offering_name: type: string readOnly: true role: type: string format: uri readOnly: true role_name: type: string readOnly: true user: type: string format: uri readOnly: true user_full_name: type: string readOnly: true user_native_name: type: string readOnly: true user_username: type: string description: Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters readOnly: true user_uuid: type: string format: uuid readOnly: true user_email: type: string format: email title: Email address readOnly: true required: - created - created_by - offering - offering_name - offering_slug - offering_uuid - pk - role - role_name - url - user - user_email - user_full_name - user_native_name - user_username - user_uuid OfferingReference: type: object properties: offering_name: type: string readOnly: true offering_uuid: type: string format: uuid readOnly: true required: - offering_name - offering_uuid description: '' OfferingReferral: type: object properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true scope: type: string readOnly: true scope_uuid: type: string format: uuid readOnly: true pid: type: string maxLength: 255 relation_type: type: string maxLength: 255 resource_type: type: string maxLength: 255 creator: type: string maxLength: 255 publisher: type: string maxLength: 255 published: type: string maxLength: 255 title: type: string maxLength: 255 referral_url: type: string maxLength: 255 required: - scope - scope_uuid - url - uuid description: '' OfferingResourceOptionsUpdateRequest: type: object properties: resource_options: $ref: '#/components/schemas/OfferingOptionsRequest' required: - resource_options description: '' OfferingState: enum: - Draft - Active - Paused - Archived type: string description: '' OfferingStats: type: object properties: count: type: integer name: type: string uuid: type: string country: type: string required: - count - country - name - uuid description: '' OfferingStatsCounter: type: object properties: category_uuid: type: string format: uuid category_title: type: string service_provider_name: type: string service_provider_uuid: type: string format: uuid count: type: integer required: - category_title - category_uuid - count - service_provider_name - service_provider_uuid description: '' OfferingTermsOfService: type: object description: '' properties: uuid: type: string format: uuid readOnly: true offering_uuid: type: string format: uuid readOnly: true offering_name: type: string readOnly: true terms_of_service: type: string terms_of_service_link: type: string format: uri maxLength: 200 version: type: string maxLength: 50 is_active: type: boolean requires_reconsent: type: boolean description: If True, user will be asked to re-consent to the terms of service when the terms of service are updated. created: type: string format: date-time readOnly: true modified: type: string format: date-time readOnly: true required: - created - modified - offering_name - offering_uuid - uuid OfferingTermsOfServiceCreate: type: object description: '' properties: offering: type: string format: uri terms_of_service: type: string terms_of_service_link: type: string format: uri maxLength: 200 version: type: string maxLength: 50 is_active: type: boolean requires_reconsent: type: boolean description: If True, user will be asked to re-consent to the terms of service when the terms of service are updated. required: - offering OfferingTermsOfServiceCreateRequest: type: object description: '' properties: offering: type: string format: uri terms_of_service: type: string terms_of_service_link: type: string format: uri maxLength: 200 version: type: string maxLength: 50 is_active: type: boolean requires_reconsent: type: boolean description: If True, user will be asked to re-consent to the terms of service when the terms of service are updated. required: - offering OfferingTermsOfServiceRequest: type: object description: '' properties: terms_of_service: type: string terms_of_service_link: type: string format: uri maxLength: 200 version: type: string maxLength: 50 is_active: type: boolean requires_reconsent: type: boolean description: If True, user will be asked to re-consent to the terms of service when the terms of service are updated. OfferingThumbnailRequest: type: object properties: thumbnail: type: string format: binary required: - thumbnail description: '' OfferingUsagePolicy: type: object description: '' properties: uuid: type: string format: uuid readOnly: true url: type: string format: uri readOnly: true scope: type: string format: uri scope_name: type: string readOnly: true scope_uuid: type: string format: uuid readOnly: true actions: type: string maxLength: 255 created: type: string format: date-time readOnly: true created_by_full_name: type: string readOnly: true created_by_username: type: string readOnly: true has_fired: type: boolean readOnly: true fired_datetime: type: string format: date-time readOnly: true options: description: Fields for saving actions extra data. Keys are name of actions. organization_groups: type: array items: type: string format: uri component_limits_set: type: array items: $ref: '#/components/schemas/NestedOfferingComponentLimit' period: allOf: - $ref: '#/components/schemas/PeriodEnum' minimum: -2147483648 maximum: 2147483647 period_name: type: string readOnly: true required: - actions - component_limits_set - created - created_by_full_name - created_by_username - fired_datetime - has_fired - organization_groups - period_name - scope - scope_name - scope_uuid - url - uuid OfferingUsagePolicyRequest: type: object description: '' properties: scope: type: string format: uri actions: type: string minLength: 1 maxLength: 255 options: description: Fields for saving actions extra data. Keys are name of actions. organization_groups: type: array items: type: string format: uri component_limits_set: type: array items: $ref: '#/components/schemas/NestedOfferingComponentLimitRequest' period: allOf: - $ref: '#/components/schemas/PeriodEnum' minimum: -2147483648 maximum: 2147483647 required: - actions - component_limits_set - organization_groups - scope OfferingUser: type: object description: '' properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true user: type: string format: uri offering: type: string format: uri username: type: string nullable: true maxLength: 100 offering_uuid: type: string format: uuid offering_name: type: string readOnly: true user_uuid: type: string format: uuid user_username: type: string description: Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters readOnly: true user_full_name: type: string readOnly: true user_email: type: string format: email title: Email address readOnly: true created: type: string format: date-time readOnly: true modified: type: string format: date-time readOnly: true customer_uuid: type: string format: uuid readOnly: true customer_name: type: string readOnly: true is_restricted: type: boolean description: Signal to service if the user account is restricted or not readOnly: true state: allOf: - $ref: '#/components/schemas/OfferingUserStateEnum' readOnly: true service_provider_comment: type: string description: Additional comment for pending states like validation or account linking readOnly: true service_provider_comment_url: type: string format: uri description: URL link for additional information or actions related to service provider comment readOnly: true required: [] OfferingUserRequest: type: object description: '' properties: user: type: string format: uri offering: type: string format: uri username: type: string nullable: true maxLength: 100 offering_uuid: type: string format: uuid user_uuid: type: string format: uuid OfferingUserRole: type: object properties: name: type: string maxLength: 150 uuid: type: string format: uuid readOnly: true offering: type: string format: uri offering_uuid: type: string format: uuid readOnly: true offering_name: type: string readOnly: true required: - name - offering - offering_name - offering_uuid - uuid description: '' OfferingUserRoleRequest: type: object properties: name: type: string minLength: 1 maxLength: 150 offering: type: string format: uri required: - name - offering description: '' OfferingUserServiceProviderComment: type: object description: '' properties: service_provider_comment: type: string service_provider_comment_url: type: string format: uri description: URL link for additional information or actions related to service provider comment maxLength: 200 OfferingUserStateEnum: enum: - Requested - Creating - Pending account linking - Pending additional validation - OK - Requested deletion - Deleting - Deleted - Error creating - Error deleting type: string description: '' OfferingUserStateTransitionRequest: type: object properties: comment: type: string comment_url: type: string format: uri description: '' OfferingUserUpdateRestrictionRequest: type: object properties: is_restricted: type: boolean required: - is_restricted description: '' OpenStackAllowedAddressPair: type: object properties: mac_address: type: string description: '' OpenStackAllowedAddressPairRequest: type: object properties: ip_address: type: string writeOnly: true minLength: 1 default: 192.168.42.0/24 mac_address: type: string minLength: 1 description: '' OpenStackBackendInstance: type: object properties: name: type: string maxLength: 150 key_name: type: string maxLength: 50 start_time: type: string format: date-time nullable: true state: type: string readOnly: true runtime_state: type: string maxLength: 150 created: type: string format: date-time readOnly: true backend_id: type: string nullable: true description: Instance ID in the OpenStack backend maxLength: 255 availability_zone: type: string readOnly: true hypervisor_hostname: type: string description: Name of the hypervisor hosting this instance maxLength: 255 required: - availability_zone - created - name - state description: '' OpenStackBackendVolumes: type: object properties: name: type: string maxLength: 150 description: type: string maxLength: 2000 size: type: integer maximum: 2147483647 minimum: 0 description: Size in MiB metadata: type: string description: Arbitrary key-value pairs associated with the volume backend_id: type: string nullable: true description: Volume ID in the OpenStack backend maxLength: 255 type: type: string readOnly: true bootable: type: boolean description: Indicates if this volume can be used to boot an instance runtime_state: type: string maxLength: 150 state: type: string readOnly: true availability_zone: type: string readOnly: true required: - availability_zone - name - size - state - type description: '' OpenStackBackup: type: object description: '' properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true name: type: string maxLength: 150 description: type: string maxLength: 2000 service_name: type: string readOnly: true service_settings: type: string format: uri readOnly: true service_settings_uuid: type: string format: uuid readOnly: true service_settings_state: type: string readOnly: true service_settings_error_message: type: string readOnly: true project: type: string format: uri readOnly: true project_name: type: string readOnly: true project_uuid: type: string format: uuid readOnly: true customer: type: string format: uri readOnly: true customer_name: type: string readOnly: true customer_native_name: type: string readOnly: true customer_abbreviation: type: string readOnly: true error_message: type: string readOnly: true error_traceback: type: string readOnly: true resource_type: type: string readOnly: true state: allOf: - $ref: '#/components/schemas/CoreStates' readOnly: true created: type: string format: date-time readOnly: true modified: type: string format: date-time readOnly: true backend_id: type: string readOnly: true access_url: type: string nullable: true readOnly: true kept_until: type: string format: date-time nullable: true description: Guaranteed time of backup retention. If null - keep forever. metadata: readOnly: true instance: type: string format: uri readOnly: true description: Instance that this backup is created from instance_name: type: string readOnly: true instance_marketplace_uuid: type: string format: uuid readOnly: true restorations: type: array items: $ref: '#/components/schemas/OpenStackBackupRestoration' readOnly: true instance_security_groups: type: array items: $ref: '#/components/schemas/OpenStackNestedSecurityGroup' readOnly: true instance_ports: type: array items: $ref: '#/components/schemas/OpenStackNestedPort' readOnly: true instance_floating_ips: type: array items: $ref: '#/components/schemas/OpenStackNestedFloatingIP' readOnly: true tenant_uuid: type: string format: uuid readOnly: true marketplace_offering_uuid: type: string nullable: true readOnly: true marketplace_offering_name: type: string nullable: true readOnly: true marketplace_offering_plugin_options: type: object additionalProperties: {} nullable: true readOnly: true marketplace_category_uuid: type: string nullable: true readOnly: true marketplace_category_name: type: string nullable: true readOnly: true marketplace_resource_uuid: type: string nullable: true readOnly: true marketplace_plan_uuid: type: string nullable: true readOnly: true marketplace_resource_state: type: string nullable: true readOnly: true is_usage_based: type: boolean nullable: true readOnly: true is_limit_based: type: boolean nullable: true readOnly: true required: [] OpenStackBackupRequest: type: object description: '' properties: name: type: string minLength: 1 maxLength: 150 description: type: string maxLength: 2000 kept_until: type: string format: date-time nullable: true description: Guaranteed time of backup retention. If null - keep forever. required: - name OpenStackBackupRestoration: type: object properties: uuid: type: string format: uuid readOnly: true instance: type: string format: uri readOnly: true description: Instance that is being restored from the backup created: type: string format: date-time readOnly: true flavor: type: string format: uri description: Flavor to be used for the restored instance. If not specified, original instance flavor will be used name: type: string description: New instance name. Leave blank to use source instance name. floating_ips: type: array items: $ref: '#/components/schemas/OpenStackNestedFloatingIP' description: Floating IPs that will be assigned to the restored instance security_groups: type: array items: $ref: '#/components/schemas/OpenStackNestedSecurityGroup' description: Security groups that will be assigned to the restored instance ports: type: array items: $ref: '#/components/schemas/OpenStackNestedPort' description: Network ports that will be attached to the restored instance required: [] description: '' OpenStackBackupRestorationRequest: type: object properties: flavor: type: string format: uri description: Flavor to be used for the restored instance. If not specified, original instance flavor will be used name: type: string minLength: 1 description: New instance name. Leave blank to use source instance name. floating_ips: type: array items: $ref: '#/components/schemas/OpenStackNestedFloatingIPRequest' description: Floating IPs that will be assigned to the restored instance ports: type: array items: $ref: '#/components/schemas/OpenStackNestedPortRequest' description: Network ports that will be attached to the restored instance required: - flavor description: '' OpenStackDataVolume: type: object properties: size: type: integer volume_type: type: string format: uri nullable: true required: - size description: '' OpenStackDataVolumeRequest: type: object properties: size: type: integer volume_type: type: string format: uri nullable: true required: - size description: '' OpenStackFixedIp: type: object properties: ip_address: description: IP address to assign to the port oneOf: - type: string format: ipv4 - type: string format: ipv6 subnet_id: type: string description: ID of the subnet in which to assign the IP address required: [] description: '' OpenStackFixedIpRequest: type: object properties: ip_address: description: IP address to assign to the port oneOf: - type: string format: ipv4 - type: string format: ipv6 minLength: 1 subnet_id: type: string minLength: 1 description: ID of the subnet in which to assign the IP address required: - ip_address - subnet_id description: '' OpenStackFlavor: type: object description: '' properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true name: type: string maxLength: 150 settings: type: string format: uri cores: type: integer maximum: 32767 minimum: 0 description: Number of cores in a VM ram: type: integer maximum: 2147483647 minimum: 0 description: Memory size in MiB disk: type: integer maximum: 2147483647 minimum: 0 description: Root disk size in MiB backend_id: type: string maxLength: 255 display_name: type: string readOnly: true required: [] OpenStackFloatingIP: type: object description: '' properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true name: type: string readOnly: true description: type: string readOnly: true service_name: type: string readOnly: true service_settings: type: string format: uri readOnly: true service_settings_uuid: type: string format: uuid readOnly: true service_settings_state: type: string readOnly: true service_settings_error_message: type: string readOnly: true project: type: string format: uri readOnly: true project_name: type: string readOnly: true project_uuid: type: string format: uuid readOnly: true customer: type: string format: uri readOnly: true customer_name: type: string readOnly: true customer_native_name: type: string readOnly: true customer_abbreviation: type: string readOnly: true error_message: type: string readOnly: true error_traceback: type: string readOnly: true resource_type: type: string readOnly: true state: allOf: - $ref: '#/components/schemas/CoreStates' readOnly: true created: type: string format: date-time readOnly: true modified: type: string format: date-time readOnly: true backend_id: type: string readOnly: true access_url: type: string nullable: true readOnly: true runtime_state: type: string readOnly: true address: description: The public IPv4 address of the floating IP oneOf: - type: string format: ipv4 - type: string format: ipv6 readOnly: true nullable: true backend_network_id: type: string readOnly: true description: ID of network in OpenStack where this floating IP is allocated tenant: type: string format: uri readOnly: true description: OpenStack tenant this floating IP belongs to tenant_name: type: string readOnly: true tenant_uuid: type: string format: uuid readOnly: true port: type: string format: uri readOnly: true external_address: description: Optional address that maps to floating IP's address in external networks oneOf: - type: string format: ipv4 - type: string format: ipv6 readOnly: true nullable: true port_fixed_ips: type: array items: $ref: '#/components/schemas/OpenStackFixedIp' readOnly: true instance_uuid: type: string nullable: true readOnly: true instance_name: type: string nullable: true readOnly: true instance_url: type: string nullable: true readOnly: true marketplace_offering_uuid: type: string nullable: true readOnly: true marketplace_offering_name: type: string nullable: true readOnly: true marketplace_offering_plugin_options: type: object additionalProperties: {} nullable: true readOnly: true marketplace_category_uuid: type: string nullable: true readOnly: true marketplace_category_name: type: string nullable: true readOnly: true marketplace_resource_uuid: type: string nullable: true readOnly: true marketplace_plan_uuid: type: string nullable: true readOnly: true marketplace_resource_state: type: string nullable: true readOnly: true is_usage_based: type: boolean nullable: true readOnly: true is_limit_based: type: boolean nullable: true readOnly: true required: [] OpenStackFloatingIPAttachRequest: type: object properties: port: type: string format: uri required: - port description: '' OpenStackFloatingIPDescriptionUpdateRequest: type: object properties: description: type: string minLength: 1 description: New floating IP description. description: '' OpenStackImage: type: object description: '' properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true name: type: string maxLength: 150 min_disk: type: integer maximum: 2147483647 minimum: 0 description: Minimum disk size in MiB min_ram: type: integer maximum: 2147483647 minimum: 0 description: Minimum memory size in MiB settings: type: string format: uri backend_id: type: string maxLength: 255 required: - backend_id - name - settings - url - uuid OpenStackInstance: type: object description: '' properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true name: type: string maxLength: 150 description: type: string maxLength: 2000 service_name: type: string readOnly: true service_settings: type: string format: uri readOnly: true description: OpenStack provider settings service_settings_uuid: type: string format: uuid readOnly: true service_settings_state: type: string readOnly: true service_settings_error_message: type: string readOnly: true project: type: string format: uri project_name: type: string readOnly: true project_uuid: type: string format: uuid readOnly: true customer: type: string format: uri readOnly: true customer_name: type: string readOnly: true customer_native_name: type: string readOnly: true customer_abbreviation: type: string readOnly: true error_message: type: string readOnly: true error_traceback: type: string readOnly: true resource_type: type: string readOnly: true state: allOf: - $ref: '#/components/schemas/CoreStates' readOnly: true created: type: string format: date-time readOnly: true modified: type: string format: date-time readOnly: true backend_id: type: string readOnly: true nullable: true description: Instance ID in the OpenStack backend access_url: type: string nullable: true readOnly: true start_time: type: string format: date-time readOnly: true nullable: true cores: type: integer readOnly: true description: Number of cores in a VM ram: type: integer readOnly: true description: Memory size in MiB disk: type: integer readOnly: true description: Disk size in MiB min_ram: type: integer readOnly: true description: Minimum memory size in MiB min_disk: type: integer readOnly: true description: Minimum disk size in MiB user_data: type: string description: Additional data that will be added to instance on provisioning external_ips: type: array items: type: string format: ipv4 readOnly: true internal_ips: type: array items: type: string format: ipv4 readOnly: true latitude: type: number format: double readOnly: true nullable: true longitude: type: number format: double readOnly: true nullable: true key_name: type: string readOnly: true key_fingerprint: type: string readOnly: true image_name: type: string readOnly: true flavor_disk: type: integer readOnly: true description: Flavor disk size in MiB flavor_name: type: string readOnly: true description: Name of the flavor used by this instance volumes: type: array items: $ref: '#/components/schemas/OpenStackNestedVolume' readOnly: true description: List of volumes attached to the instance security_groups: type: array items: $ref: '#/components/schemas/OpenStackNestedSecurityGroup' description: List of security groups to apply to the instance server_group: allOf: - $ref: '#/components/schemas/OpenStackNestedServerGroup' nullable: true description: Server group for instance scheduling policy floating_ips: type: array items: $ref: '#/components/schemas/OpenStackNestedFloatingIP' description: Floating IPs to assign to the instance ports: type: array items: $ref: '#/components/schemas/OpenStackNestedPort' description: Network ports to attach to the instance availability_zone: type: string format: uri nullable: true description: Availability zone where this instance is located availability_zone_name: type: string readOnly: true description: Name of the availability zone where instance is located connect_directly_to_external_network: type: boolean description: If True, instance will be connected directly to external network runtime_state: type: string readOnly: true action: type: string readOnly: true action_details: readOnly: true description: Details about ongoing or completed actions tenant_uuid: type: string format: uuid readOnly: true description: UUID of the OpenStack tenant hypervisor_hostname: type: string readOnly: true description: Name of the hypervisor hosting this instance tenant: type: string format: uri description: The OpenStack tenant to create the instance in external_address: type: array items: type: string readOnly: true rancher_cluster: allOf: - $ref: '#/components/schemas/RancherClusterReference' nullable: true readOnly: true marketplace_offering_uuid: type: string nullable: true readOnly: true marketplace_offering_name: type: string nullable: true readOnly: true marketplace_offering_plugin_options: type: object additionalProperties: {} nullable: true readOnly: true marketplace_category_uuid: type: string nullable: true readOnly: true marketplace_category_name: type: string nullable: true readOnly: true marketplace_resource_uuid: type: string nullable: true readOnly: true marketplace_plan_uuid: type: string nullable: true readOnly: true marketplace_resource_state: type: string nullable: true readOnly: true is_usage_based: type: boolean nullable: true readOnly: true is_limit_based: type: boolean nullable: true readOnly: true required: [] OpenStackInstanceAllowedAddressPairsUpdateRequest: type: object properties: subnet: type: string format: uri writeOnly: true description: The subnet to update allowed address pairs for. allowed_address_pairs: type: array items: $ref: '#/components/schemas/OpenStackAllowedAddressPairRequest' description: List of allowed address pairs to set on the port. Each pair should contain 'ip_address' and optional 'mac_address'. required: - allowed_address_pairs - subnet description: '' OpenStackInstanceAvailabilityZone: type: object description: '' properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true name: type: string maxLength: 150 settings: type: string format: uri nullable: true available: type: boolean description: Indicates whether this availability zone is available for instance provisioning required: - name - url - uuid OpenStackInstanceFloatingIPsUpdateRequest: type: object properties: floating_ips: type: array items: $ref: '#/components/schemas/OpenStackNestedFloatingIPRequest' description: '' OpenStackInstancePortsUpdateRequest: type: object properties: ports: type: array items: $ref: '#/components/schemas/OpenStackNestedPortRequest' required: - ports description: '' OpenStackInstanceRequest: type: object description: '' properties: name: type: string minLength: 1 maxLength: 150 description: type: string maxLength: 2000 system_volume_type: type: string format: uri writeOnly: true nullable: true description: Volume type for the system volume data_volume_type: type: string format: uri writeOnly: true nullable: true description: Volume type for the data volume data_volumes: type: array items: $ref: '#/components/schemas/OpenStackDataVolumeRequest' writeOnly: true description: Additional data volumes to attach to the instance required: - name OpenStackInstanceSecurityGroupsUpdateRequest: type: object properties: security_groups: type: array items: type: string format: uri description: List of security groups to be assigned to the instance. required: - security_groups description: '' OpenStackNestedFloatingIP: type: object description: '' properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true address: description: The public IPv4 address of the floating IP oneOf: - type: string format: ipv4 - type: string format: ipv6 readOnly: true nullable: true port_fixed_ips: type: array items: $ref: '#/components/schemas/OpenStackFixedIp' readOnly: true port_mac_address: type: string description: MAC address of the port readOnly: true nullable: true subnet: type: string format: uri subnet_uuid: type: string format: uuid readOnly: true subnet_name: type: string readOnly: true subnet_description: type: string readOnly: true subnet_cidr: type: string description: IPv4 network address in CIDR format (e.g. 192.168.0.0/24) readOnly: true required: [] OpenStackNestedFloatingIPRequest: type: object description: '' properties: subnet: type: string format: uri required: - subnet OpenStackNestedInstance: type: object properties: backend_id: type: string nullable: true description: Instance ID in the OpenStack backend maxLength: 255 name: type: string maxLength: 150 uuid: type: string format: uuid readOnly: true required: [] description: '' OpenStackNestedPort: type: object description: '' properties: url: type: string format: uri readOnly: true fixed_ips: type: array items: $ref: '#/components/schemas/OpenStackFixedIp' mac_address: type: string readOnly: true description: MAC address of the port subnet: type: string format: uri nullable: true description: Subnet to which this port belongs subnet_uuid: type: string format: uuid readOnly: true nullable: true subnet_name: type: string readOnly: true nullable: true subnet_description: type: string readOnly: true nullable: true subnet_cidr: type: string description: IPv4 network address in CIDR format (e.g. 192.168.0.0/24) readOnly: true nullable: true allowed_address_pairs: type: array items: $ref: '#/components/schemas/OpenStackAllowedAddressPair' readOnly: true device_id: type: string readOnly: true nullable: true description: ID of device (instance, router etc) to which this port is connected device_owner: type: string readOnly: true nullable: true description: Entity that uses this port (e.g. network:router_interface) security_groups: type: array items: $ref: '#/components/schemas/OpenStackSecurityGroup' readOnly: true required: [] OpenStackNestedPortRequest: type: object description: '' properties: fixed_ips: type: array items: $ref: '#/components/schemas/OpenStackFixedIpRequest' subnet: type: string format: uri nullable: true description: Subnet to which this port belongs port: type: string format: uri writeOnly: true OpenStackNestedSecurityGroup: type: object description: '' properties: url: type: string format: uri readOnly: true name: type: string readOnly: true rules: type: array items: $ref: '#/components/schemas/NestedSecurityGroupRule' readOnly: true description: type: string readOnly: true state: type: string readOnly: true required: [] OpenStackNestedServerGroup: type: object description: '' properties: url: type: string format: uri readOnly: true name: type: string readOnly: true policy: allOf: - $ref: '#/components/schemas/PolicyEnum' readOnly: true description: Server group policy determining the rules for scheduling servers in this group state: type: string readOnly: true required: [] OpenStackNestedSubNet: type: object properties: uuid: type: string format: uuid readOnly: true name: type: string maxLength: 150 description: type: string maxLength: 2000 cidr: type: string description: IPv4 network address in CIDR format (e.g. 192.168.0.0/24) maxLength: 32 gateway_ip: description: IP address of the gateway for this subnet oneOf: - type: string format: ipv4 - type: string format: ipv6 nullable: true allocation_pools: type: array items: $ref: '#/components/schemas/OpenStackSubNetAllocationPool' readOnly: true ip_version: type: integer maximum: 32767 minimum: -32768 description: IP protocol version (4 or 6) enable_dhcp: type: boolean description: If True, DHCP service will be enabled on this subnet required: [] description: '' OpenStackNestedSubNetRequest: type: object properties: name: type: string minLength: 1 maxLength: 150 description: type: string maxLength: 2000 cidr: type: string description: IPv4 network address in CIDR format (e.g. 192.168.0.0/24) maxLength: 32 gateway_ip: description: IP address of the gateway for this subnet oneOf: - type: string format: ipv4 - type: string format: ipv6 nullable: true minLength: 1 ip_version: type: integer maximum: 32767 minimum: -32768 description: IP protocol version (4 or 6) enable_dhcp: type: boolean description: If True, DHCP service will be enabled on this subnet required: - name description: '' OpenStackNestedVolume: type: object description: '' properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true name: type: string readOnly: true image_name: type: string description: Name of the image this volume was created from maxLength: 150 state: type: string readOnly: true bootable: type: boolean description: Indicates if this volume can be used to boot an instance size: type: integer maximum: 2147483647 minimum: 0 description: Size in MiB device: type: string description: Name of volume as instance device e.g. /dev/vdb. pattern: ^/dev/[a-zA-Z0-9]+$ maxLength: 50 resource_type: type: string readOnly: true type: type: string format: uri nullable: true description: Type of the volume (e.g. SSD, HDD) type_name: type: string readOnly: true marketplace_resource_uuid: type: string nullable: true readOnly: true required: [] OpenStackNestedVolumeRequest: type: object description: '' properties: image_name: type: string description: Name of the image this volume was created from maxLength: 150 bootable: type: boolean description: Indicates if this volume can be used to boot an instance size: type: integer maximum: 2147483647 minimum: 0 description: Size in MiB device: type: string description: Name of volume as instance device e.g. /dev/vdb. pattern: ^/dev/[a-zA-Z0-9]+$ maxLength: 50 type: type: string format: uri nullable: true description: Type of the volume (e.g. SSD, HDD) required: - size OpenStackNetwork: type: object description: '' properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true name: type: string maxLength: 150 description: type: string maxLength: 2000 service_name: type: string readOnly: true service_settings: type: string format: uri readOnly: true service_settings_uuid: type: string format: uuid readOnly: true service_settings_state: type: string readOnly: true service_settings_error_message: type: string readOnly: true project: type: string format: uri readOnly: true project_name: type: string readOnly: true project_uuid: type: string format: uuid readOnly: true customer: type: string format: uri readOnly: true customer_name: type: string readOnly: true customer_native_name: type: string readOnly: true customer_abbreviation: type: string readOnly: true error_message: type: string readOnly: true error_traceback: type: string readOnly: true resource_type: type: string readOnly: true state: allOf: - $ref: '#/components/schemas/CoreStates' readOnly: true created: type: string format: date-time readOnly: true modified: type: string format: date-time readOnly: true backend_id: type: string readOnly: true access_url: type: string nullable: true readOnly: true tenant: type: string format: uri readOnly: true description: OpenStack tenant this network belongs to tenant_name: type: string readOnly: true tenant_uuid: type: string format: uuid readOnly: true is_external: type: boolean readOnly: true description: Defines whether this network is external (public) or internal (private) type: type: string readOnly: true description: Network type, such as local, flat, vlan, vxlan, or gre segmentation_id: type: integer readOnly: true nullable: true description: VLAN ID for VLAN networks or tunnel ID for VXLAN/GRE networks subnets: type: array items: $ref: '#/components/schemas/OpenStackNestedSubNet' readOnly: true mtu: type: integer readOnly: true nullable: true description: The maximum transmission unit (MTU) value to address fragmentation. rbac_policies: type: array items: $ref: '#/components/schemas/NetworkRBACPolicy' readOnly: true marketplace_offering_uuid: type: string nullable: true readOnly: true marketplace_offering_name: type: string nullable: true readOnly: true marketplace_offering_plugin_options: type: object additionalProperties: {} nullable: true readOnly: true marketplace_category_uuid: type: string nullable: true readOnly: true marketplace_category_name: type: string nullable: true readOnly: true marketplace_resource_uuid: type: string nullable: true readOnly: true marketplace_plan_uuid: type: string nullable: true readOnly: true marketplace_resource_state: type: string nullable: true readOnly: true is_usage_based: type: boolean nullable: true readOnly: true is_limit_based: type: boolean nullable: true readOnly: true required: [] OpenStackNetworkRequest: type: object description: '' properties: name: type: string minLength: 1 maxLength: 150 description: type: string maxLength: 2000 required: - name OpenStackPort: type: object description: '' properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true name: type: string maxLength: 150 description: type: string maxLength: 2000 service_name: type: string readOnly: true service_settings: type: string format: uri readOnly: true service_settings_uuid: type: string format: uuid readOnly: true service_settings_state: type: string readOnly: true service_settings_error_message: type: string readOnly: true project: type: string format: uri readOnly: true project_name: type: string readOnly: true project_uuid: type: string format: uuid readOnly: true customer: type: string format: uri readOnly: true customer_name: type: string readOnly: true customer_native_name: type: string readOnly: true customer_abbreviation: type: string readOnly: true error_message: type: string readOnly: true error_traceback: type: string readOnly: true resource_type: type: string readOnly: true state: allOf: - $ref: '#/components/schemas/CoreStates' readOnly: true created: type: string format: date-time readOnly: true modified: type: string format: date-time readOnly: true backend_id: type: string readOnly: true nullable: true description: Port ID in OpenStack access_url: type: string nullable: true readOnly: true fixed_ips: type: array items: $ref: '#/components/schemas/OpenStackFixedIp' mac_address: type: string description: MAC address of the port maxLength: 32 allowed_address_pairs: type: array items: $ref: '#/components/schemas/OpenStackAllowedAddressPair' tenant: type: string format: uri readOnly: true description: OpenStack tenant this port belongs to tenant_name: type: string readOnly: true tenant_uuid: type: string format: uuid readOnly: true network: type: string format: uri nullable: true description: Network to which this port belongs network_name: type: string readOnly: true network_uuid: type: string format: uuid readOnly: true floating_ips: type: array items: type: string format: uri readOnly: true device_id: type: string readOnly: true nullable: true description: ID of device (instance, router etc) to which this port is connected device_owner: type: string readOnly: true nullable: true description: Entity that uses this port (e.g. network:router_interface) port_security_enabled: type: boolean description: If True, security groups and rules will be applied to this port security_groups: type: array items: $ref: '#/components/schemas/OpenStackPortNestedSecurityGroup' admin_state_up: type: boolean readOnly: true nullable: true description: Administrative state of the port. If down, port does not forward packets status: type: string readOnly: true nullable: true description: Port status in OpenStack (e.g. ACTIVE, DOWN) marketplace_offering_uuid: type: string nullable: true readOnly: true marketplace_offering_name: type: string nullable: true readOnly: true marketplace_offering_plugin_options: type: object additionalProperties: {} nullable: true readOnly: true marketplace_category_uuid: type: string nullable: true readOnly: true marketplace_category_name: type: string nullable: true readOnly: true marketplace_resource_uuid: type: string nullable: true readOnly: true marketplace_plan_uuid: type: string nullable: true readOnly: true marketplace_resource_state: type: string nullable: true readOnly: true is_usage_based: type: boolean nullable: true readOnly: true is_limit_based: type: boolean nullable: true readOnly: true required: [] OpenStackPortIPUpdateRequest: type: object properties: subnet: type: string format: uri writeOnly: true description: The subnet where the new IP address will be allocated ip_address: description: The IP address to assign within the subnet oneOf: - type: string format: ipv4 - type: string format: ipv6 minLength: 1 required: - ip_address - subnet description: '' OpenStackPortNestedSecurityGroup: type: object description: '' properties: uuid: type: string format: uuid readOnly: true name: type: string maxLength: 150 url: type: string format: uri readOnly: true required: [] OpenStackPortNestedSecurityGroupRequest: type: object description: '' properties: name: type: string minLength: 1 maxLength: 150 required: - name OpenStackPortRequest: type: object description: '' properties: name: type: string minLength: 1 maxLength: 150 description: type: string maxLength: 2000 fixed_ips: type: array items: $ref: '#/components/schemas/OpenStackFixedIpRequest' mac_address: type: string description: MAC address of the port maxLength: 32 allowed_address_pairs: type: array items: $ref: '#/components/schemas/OpenStackAllowedAddressPairRequest' network: type: string format: uri nullable: true description: Network to which this port belongs port_security_enabled: type: boolean description: If True, security groups and rules will be applied to this port security_groups: type: array items: $ref: '#/components/schemas/OpenStackPortNestedSecurityGroupRequest' required: - name OpenStackRouter: type: object description: '' properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true name: type: string maxLength: 150 description: type: string maxLength: 2000 service_name: type: string readOnly: true service_settings: type: string format: uri service_settings_uuid: type: string format: uuid readOnly: true service_settings_state: type: string readOnly: true service_settings_error_message: type: string readOnly: true project: type: string format: uri project_name: type: string readOnly: true project_uuid: type: string format: uuid readOnly: true customer: type: string format: uri readOnly: true customer_name: type: string readOnly: true customer_native_name: type: string readOnly: true customer_abbreviation: type: string readOnly: true error_message: type: string error_traceback: type: string resource_type: type: string readOnly: true state: allOf: - $ref: '#/components/schemas/CoreStates' readOnly: true created: type: string format: date-time readOnly: true modified: type: string format: date-time readOnly: true backend_id: type: string nullable: true description: Router ID in OpenStack maxLength: 255 access_url: type: string nullable: true readOnly: true tenant: type: string format: uri description: OpenStack tenant this router belongs to tenant_name: type: string readOnly: true tenant_uuid: type: string format: uuid readOnly: true routes: type: array items: $ref: '#/components/schemas/OpenStackStaticRoute' fixed_ips: type: array items: $ref: '#/components/schemas/OpenStackFixedIp' readOnly: true ports: type: array items: $ref: '#/components/schemas/OpenStackNestedPort' readOnly: true marketplace_offering_uuid: type: string nullable: true readOnly: true marketplace_offering_name: type: string nullable: true readOnly: true marketplace_offering_plugin_options: type: object additionalProperties: {} nullable: true readOnly: true marketplace_category_uuid: type: string nullable: true readOnly: true marketplace_category_name: type: string nullable: true readOnly: true marketplace_resource_uuid: type: string nullable: true readOnly: true marketplace_plan_uuid: type: string nullable: true readOnly: true marketplace_resource_state: type: string nullable: true readOnly: true is_usage_based: type: boolean nullable: true readOnly: true is_limit_based: type: boolean nullable: true readOnly: true offering_external_ips: type: array items: type: string nullable: true readOnly: true required: [] OpenStackRouterInterfaceRequest: type: object properties: subnet: type: string format: uri description: The subnet to connect to the router. Either subnet or port must be specified, but not both. port: type: string format: uri description: The port to connect to the router. Either subnet or port must be specified, but not both. description: '' OpenStackRouterSetRoutes: type: object properties: routes: type: array items: $ref: '#/components/schemas/OpenStackStaticRoute' required: - routes description: '' OpenStackRouterSetRoutesRequest: type: object properties: routes: type: array items: $ref: '#/components/schemas/OpenStackStaticRouteRequest' required: - routes description: '' OpenStackSecurityGroup: type: object description: '' properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true name: type: string maxLength: 150 description: type: string maxLength: 2000 service_name: type: string readOnly: true service_settings: type: string format: uri readOnly: true service_settings_uuid: type: string format: uuid readOnly: true service_settings_state: type: string readOnly: true service_settings_error_message: type: string readOnly: true project: type: string format: uri readOnly: true project_name: type: string readOnly: true project_uuid: type: string format: uuid readOnly: true customer: type: string format: uri readOnly: true customer_name: type: string readOnly: true customer_native_name: type: string readOnly: true customer_abbreviation: type: string readOnly: true error_message: type: string readOnly: true error_traceback: type: string readOnly: true resource_type: type: string readOnly: true state: allOf: - $ref: '#/components/schemas/CoreStates' readOnly: true created: type: string format: date-time readOnly: true modified: type: string format: date-time readOnly: true backend_id: type: string readOnly: true access_url: type: string nullable: true readOnly: true tenant: type: string format: uri readOnly: true tenant_name: type: string readOnly: true tenant_uuid: type: string format: uuid readOnly: true rules: type: array items: $ref: '#/components/schemas/OpenStackSecurityGroupRuleCreate' marketplace_offering_uuid: type: string nullable: true readOnly: true marketplace_offering_name: type: string nullable: true readOnly: true marketplace_offering_plugin_options: type: object additionalProperties: {} nullable: true readOnly: true marketplace_category_uuid: type: string nullable: true readOnly: true marketplace_category_name: type: string nullable: true readOnly: true marketplace_resource_uuid: type: string nullable: true readOnly: true marketplace_plan_uuid: type: string nullable: true readOnly: true marketplace_resource_state: type: string nullable: true readOnly: true is_usage_based: type: boolean nullable: true readOnly: true is_limit_based: type: boolean nullable: true readOnly: true required: [] OpenStackSecurityGroupRequest: type: object description: '' properties: name: type: string minLength: 1 maxLength: 150 description: type: string maxLength: 2000 rules: type: array items: $ref: '#/components/schemas/OpenStackSecurityGroupRuleCreateRequest' required: - name - rules OpenStackSecurityGroupRuleCreate: type: object description: '' properties: ethertype: allOf: - $ref: '#/components/schemas/EthertypeEnum' description: IP protocol version - either 'IPv4' or 'IPv6' direction: allOf: - $ref: '#/components/schemas/DirectionEnum' description: Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing) protocol: description: The network protocol (TCP, UDP, ICMP, or empty for any protocol) oneOf: - $ref: '#/components/schemas/ProtocolEnum' - $ref: '#/components/schemas/BlankEnum' from_port: type: integer maximum: 65535 minimum: -2147483648 nullable: true description: Starting port number in the range (1-65535) to_port: type: integer maximum: 65535 minimum: -2147483648 nullable: true description: Ending port number in the range (1-65535) cidr: type: string nullable: true description: CIDR notation for the source/destination network address range maxLength: 255 description: type: string maxLength: 2000 remote_group_name: type: string readOnly: true remote_group_uuid: type: string format: uuid readOnly: true id: type: integer readOnly: true remote_group: type: string format: uri nullable: true description: Remote security group that this rule references, if any required: [] OpenStackSecurityGroupRuleCreateRequest: type: object description: '' properties: ethertype: allOf: - $ref: '#/components/schemas/EthertypeEnum' description: IP protocol version - either 'IPv4' or 'IPv6' direction: allOf: - $ref: '#/components/schemas/DirectionEnum' description: Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing) protocol: description: The network protocol (TCP, UDP, ICMP, or empty for any protocol) oneOf: - $ref: '#/components/schemas/ProtocolEnum' - $ref: '#/components/schemas/BlankEnum' from_port: type: integer maximum: 65535 minimum: -2147483648 nullable: true description: Starting port number in the range (1-65535) to_port: type: integer maximum: 65535 minimum: -2147483648 nullable: true description: Ending port number in the range (1-65535) cidr: type: string nullable: true description: CIDR notation for the source/destination network address range maxLength: 255 description: type: string maxLength: 2000 remote_group: type: string format: uri nullable: true description: Remote security group that this rule references, if any OpenStackSecurityGroupRuleUpdateRequest: type: object properties: ethertype: allOf: - $ref: '#/components/schemas/EthertypeEnum' default: IPv4 description: IP protocol version - either 'IPv4' or 'IPv6' direction: allOf: - $ref: '#/components/schemas/DirectionEnum' default: ingress description: Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing) protocol: description: The network protocol (TCP, UDP, ICMP, or empty for any protocol) oneOf: - $ref: '#/components/schemas/ProtocolEnum' - $ref: '#/components/schemas/BlankEnum' from_port: type: integer maximum: 65535 minimum: -2147483648 nullable: true description: Starting port number in the range (1-65535) to_port: type: integer maximum: 65535 minimum: -2147483648 nullable: true description: Ending port number in the range (1-65535) cidr: type: string nullable: true description: CIDR notation for the source/destination network address range maxLength: 255 description: type: string maxLength: 2000 remote_group: type: string format: uri nullable: true description: Remote security group that this rule references, if any description: '' OpenStackSecurityGroupUpdate: type: object properties: name: type: string maxLength: 150 description: type: string maxLength: 2000 required: - name description: '' OpenStackSecurityGroupUpdateRequest: type: object properties: name: type: string minLength: 1 maxLength: 150 description: type: string maxLength: 2000 required: - name description: '' OpenStackServerGroup: type: object description: '' properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true name: type: string maxLength: 150 description: type: string maxLength: 2000 service_name: type: string readOnly: true service_settings: type: string format: uri readOnly: true service_settings_uuid: type: string format: uuid readOnly: true service_settings_state: type: string readOnly: true service_settings_error_message: type: string readOnly: true project: type: string format: uri readOnly: true project_name: type: string readOnly: true project_uuid: type: string format: uuid readOnly: true customer: type: string format: uri readOnly: true customer_name: type: string readOnly: true customer_native_name: type: string readOnly: true customer_abbreviation: type: string readOnly: true error_message: type: string readOnly: true error_traceback: type: string readOnly: true resource_type: type: string readOnly: true state: allOf: - $ref: '#/components/schemas/CoreStates' readOnly: true created: type: string format: date-time readOnly: true modified: type: string format: date-time readOnly: true backend_id: type: string readOnly: true access_url: type: string nullable: true readOnly: true tenant: type: string format: uri readOnly: true tenant_name: type: string readOnly: true tenant_uuid: type: string format: uuid readOnly: true policy: description: Server group policy determining the rules for scheduling servers in this group oneOf: - $ref: '#/components/schemas/PolicyEnum' - $ref: '#/components/schemas/BlankEnum' display_name: type: string readOnly: true instances: type: array items: $ref: '#/components/schemas/OpenStackNestedInstance' readOnly: true marketplace_offering_uuid: type: string nullable: true readOnly: true marketplace_offering_name: type: string nullable: true readOnly: true marketplace_offering_plugin_options: type: object additionalProperties: {} nullable: true readOnly: true marketplace_category_uuid: type: string nullable: true readOnly: true marketplace_category_name: type: string nullable: true readOnly: true marketplace_resource_uuid: type: string nullable: true readOnly: true marketplace_plan_uuid: type: string nullable: true readOnly: true marketplace_resource_state: type: string nullable: true readOnly: true is_usage_based: type: boolean nullable: true readOnly: true is_limit_based: type: boolean nullable: true readOnly: true required: [] OpenStackServerGroupRequest: type: object description: '' properties: name: type: string minLength: 1 maxLength: 150 description: type: string maxLength: 2000 policy: description: Server group policy determining the rules for scheduling servers in this group oneOf: - $ref: '#/components/schemas/PolicyEnum' - $ref: '#/components/schemas/BlankEnum' required: - name OpenStackSnapshot: type: object description: '' properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true name: type: string maxLength: 150 description: type: string maxLength: 2000 service_name: type: string readOnly: true service_settings: type: string format: uri readOnly: true service_settings_uuid: type: string format: uuid readOnly: true service_settings_state: type: string readOnly: true service_settings_error_message: type: string readOnly: true project: type: string format: uri readOnly: true project_name: type: string readOnly: true project_uuid: type: string format: uuid readOnly: true customer: type: string format: uri readOnly: true customer_name: type: string readOnly: true customer_native_name: type: string readOnly: true customer_abbreviation: type: string readOnly: true error_message: type: string readOnly: true error_traceback: type: string readOnly: true resource_type: type: string readOnly: true state: allOf: - $ref: '#/components/schemas/CoreStates' readOnly: true created: type: string format: date-time readOnly: true modified: type: string format: date-time readOnly: true backend_id: type: string readOnly: true nullable: true description: Snapshot ID in the OpenStack backend access_url: type: string nullable: true readOnly: true source_volume: type: string format: uri readOnly: true nullable: true description: Volume from which this snapshot was created size: type: integer readOnly: true description: Size in MiB metadata: {} runtime_state: type: string readOnly: true source_volume_name: type: string readOnly: true source_volume_marketplace_uuid: type: string format: uuid readOnly: true action: type: string readOnly: true action_details: readOnly: true restorations: type: array items: $ref: '#/components/schemas/OpenStackSnapshotRestoration' readOnly: true kept_until: type: string format: date-time nullable: true description: Guaranteed time of snapshot retention. If null - keep forever. marketplace_offering_uuid: type: string nullable: true readOnly: true marketplace_offering_name: type: string nullable: true readOnly: true marketplace_offering_plugin_options: type: object additionalProperties: {} nullable: true readOnly: true marketplace_category_uuid: type: string nullable: true readOnly: true marketplace_category_name: type: string nullable: true readOnly: true marketplace_resource_uuid: type: string nullable: true readOnly: true marketplace_plan_uuid: type: string nullable: true readOnly: true marketplace_resource_state: type: string nullable: true readOnly: true is_usage_based: type: boolean nullable: true readOnly: true is_limit_based: type: boolean nullable: true readOnly: true required: [] OpenStackSnapshotRequest: type: object description: '' properties: name: type: string minLength: 1 maxLength: 150 description: type: string maxLength: 2000 metadata: {} kept_until: type: string format: date-time nullable: true description: Guaranteed time of snapshot retention. If null - keep forever. required: - name OpenStackSnapshotRestoration: type: object description: '' properties: uuid: type: string format: uuid readOnly: true created: type: string format: date-time readOnly: true description: type: string description: New volume description. volume: type: string format: uri readOnly: true description: Volume that is being restored from the snapshot volume_name: type: string readOnly: true volume_state: type: string readOnly: true volume_runtime_state: type: string readOnly: true volume_size: type: integer maximum: 2147483647 minimum: 0 description: Size in MiB readOnly: true volume_device: type: string description: Name of volume as instance device e.g. /dev/vdb. readOnly: true required: [] OpenStackSnapshotRestorationRequest: type: object description: '' properties: name: type: string writeOnly: true minLength: 1 description: New volume name. description: type: string minLength: 1 description: New volume description. required: - name OpenStackStaticRoute: type: object properties: destination: type: string nexthop: description: An IPv4 or IPv6 address. oneOf: - type: string format: ipv4 - type: string format: ipv6 required: [] description: '' OpenStackStaticRouteRequest: type: object properties: destination: type: string minLength: 1 nexthop: description: An IPv4 or IPv6 address. oneOf: - type: string format: ipv4 - type: string format: ipv6 minLength: 1 required: - destination - nexthop description: '' OpenStackSubNet: type: object description: '' properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true name: type: string maxLength: 150 description: type: string maxLength: 2000 service_name: type: string readOnly: true service_settings: type: string format: uri readOnly: true service_settings_uuid: type: string format: uuid readOnly: true service_settings_state: type: string readOnly: true service_settings_error_message: type: string readOnly: true project: type: string format: uri readOnly: true project_name: type: string readOnly: true project_uuid: type: string format: uuid readOnly: true customer: type: string format: uri readOnly: true customer_name: type: string readOnly: true customer_native_name: type: string readOnly: true customer_abbreviation: type: string readOnly: true error_message: type: string readOnly: true error_traceback: type: string readOnly: true resource_type: type: string readOnly: true state: allOf: - $ref: '#/components/schemas/CoreStates' readOnly: true created: type: string format: date-time readOnly: true modified: type: string format: date-time readOnly: true backend_id: type: string readOnly: true access_url: type: string nullable: true readOnly: true tenant: type: string format: uri readOnly: true tenant_name: type: string readOnly: true network: type: string format: uri readOnly: true description: Network to which this subnet belongs network_name: type: string readOnly: true cidr: type: string gateway_ip: description: IP address of the gateway for this subnet oneOf: - type: string format: ipv4 - type: string format: ipv6 nullable: true disable_gateway: type: boolean description: If True, no gateway IP address will be allocated allocation_pools: type: array items: $ref: '#/components/schemas/OpenStackSubNetAllocationPool' ip_version: type: integer readOnly: true description: IP protocol version (4 or 6) enable_dhcp: type: boolean readOnly: true description: If True, DHCP service will be enabled on this subnet dns_nameservers: type: array items: description: An IPv4 or IPv6 address. oneOf: - type: string format: ipv4 - type: string format: ipv6 host_routes: type: array items: $ref: '#/components/schemas/OpenStackStaticRoute' is_connected: type: boolean readOnly: true description: Is subnet connected to the default tenant router. marketplace_offering_uuid: type: string nullable: true readOnly: true marketplace_offering_name: type: string nullable: true readOnly: true marketplace_offering_plugin_options: type: object additionalProperties: {} nullable: true readOnly: true marketplace_category_uuid: type: string nullable: true readOnly: true marketplace_category_name: type: string nullable: true readOnly: true marketplace_resource_uuid: type: string nullable: true readOnly: true marketplace_plan_uuid: type: string nullable: true readOnly: true marketplace_resource_state: type: string nullable: true readOnly: true is_usage_based: type: boolean nullable: true readOnly: true is_limit_based: type: boolean nullable: true readOnly: true required: [] OpenStackSubNetAllocationPool: type: object properties: start: description: An IPv4 or IPv6 address. oneOf: - type: string format: ipv4 - type: string format: ipv6 end: description: An IPv4 or IPv6 address. oneOf: - type: string format: ipv4 - type: string format: ipv6 required: [] description: '' OpenStackSubNetAllocationPoolRequest: type: object properties: start: description: An IPv4 or IPv6 address. oneOf: - type: string format: ipv4 - type: string format: ipv6 minLength: 1 end: description: An IPv4 or IPv6 address. oneOf: - type: string format: ipv4 - type: string format: ipv6 minLength: 1 required: - end - start description: '' OpenStackSubNetRequest: type: object description: '' properties: name: type: string minLength: 1 maxLength: 150 description: type: string maxLength: 2000 cidr: type: string minLength: 1 gateway_ip: description: IP address of the gateway for this subnet oneOf: - type: string format: ipv4 - type: string format: ipv6 nullable: true minLength: 1 disable_gateway: type: boolean description: If True, no gateway IP address will be allocated allocation_pools: type: array items: $ref: '#/components/schemas/OpenStackSubNetAllocationPoolRequest' dns_nameservers: type: array items: description: An IPv4 or IPv6 address. oneOf: - type: string format: ipv4 - type: string format: ipv6 minLength: 1 host_routes: type: array items: $ref: '#/components/schemas/OpenStackStaticRouteRequest' required: - name OpenStackTenant: type: object description: '' properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true name: type: string maxLength: 64 description: type: string maxLength: 2000 service_name: type: string readOnly: true service_settings: type: string format: uri service_settings_uuid: type: string format: uuid readOnly: true service_settings_state: type: string readOnly: true service_settings_error_message: type: string readOnly: true project: type: string format: uri project_name: type: string readOnly: true project_uuid: type: string format: uuid readOnly: true customer: type: string format: uri readOnly: true customer_name: type: string readOnly: true customer_native_name: type: string readOnly: true customer_abbreviation: type: string readOnly: true error_message: type: string readOnly: true error_traceback: type: string readOnly: true resource_type: type: string readOnly: true state: allOf: - $ref: '#/components/schemas/CoreStates' readOnly: true created: type: string format: date-time readOnly: true modified: type: string format: date-time readOnly: true backend_id: type: string readOnly: true nullable: true description: ID of tenant in the OpenStack backend access_url: type: string nullable: true readOnly: true availability_zone: type: string description: Optional availability group. Will be used for all instances provisioned in this tenant maxLength: 100 internal_network_id: type: string readOnly: true description: ID of internal network in OpenStack tenant external_network_id: type: string readOnly: true description: ID of external network connected to OpenStack tenant user_username: type: string description: Username of the tenant user maxLength: 50 user_password: type: string description: Password of the tenant user maxLength: 50 quotas: type: array items: $ref: '#/components/schemas/Quota' readOnly: true default_volume_type_name: type: string description: Volume type name to use when creating volumes. maxLength: 100 marketplace_offering_uuid: type: string nullable: true readOnly: true marketplace_offering_name: type: string nullable: true readOnly: true marketplace_offering_plugin_options: type: object additionalProperties: {} nullable: true readOnly: true marketplace_category_uuid: type: string nullable: true readOnly: true marketplace_category_name: type: string nullable: true readOnly: true marketplace_resource_uuid: type: string nullable: true readOnly: true marketplace_plan_uuid: type: string nullable: true readOnly: true marketplace_resource_state: type: string nullable: true readOnly: true is_usage_based: type: boolean nullable: true readOnly: true is_limit_based: type: boolean nullable: true readOnly: true required: [] OpenStackTenantChangePasswordRequest: type: object properties: user_password: type: string description: New tenant user password. maxLength: 50 required: - user_password description: '' OpenStackTenantQuota: type: object properties: instances: type: integer minimum: 1 volumes: type: integer minimum: 1 snapshots: type: integer minimum: 1 ram: type: integer minimum: 1 vcpu: type: integer minimum: 1 storage: type: integer minimum: 1 security_group_count: type: integer minimum: 1 security_group_rule_count: type: integer minimum: 1 description: '' OpenStackTenantQuotaRequest: type: object properties: instances: type: integer minimum: 1 volumes: type: integer minimum: 1 snapshots: type: integer minimum: 1 ram: type: integer minimum: 1 vcpu: type: integer minimum: 1 storage: type: integer minimum: 1 security_group_count: type: integer minimum: 1 security_group_rule_count: type: integer minimum: 1 description: '' OpenStackTenantRequest: type: object description: '' properties: name: type: string minLength: 1 maxLength: 64 description: type: string maxLength: 2000 service_settings: type: string format: uri project: type: string format: uri availability_zone: type: string description: Optional availability group. Will be used for all instances provisioned in this tenant maxLength: 100 subnet_cidr: type: string writeOnly: true minLength: 1 default: 192.168.42.0/24 default_volume_type_name: type: string description: Volume type name to use when creating volumes. maxLength: 100 required: - name - project - service_settings OpenStackVolume: type: object description: '' properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true name: type: string maxLength: 150 description: type: string maxLength: 2000 service_name: type: string readOnly: true service_settings: type: string format: uri readOnly: true service_settings_uuid: type: string format: uuid readOnly: true service_settings_state: type: string readOnly: true service_settings_error_message: type: string readOnly: true project: type: string format: uri project_name: type: string readOnly: true project_uuid: type: string format: uuid readOnly: true customer: type: string format: uri readOnly: true customer_name: type: string readOnly: true customer_native_name: type: string readOnly: true customer_abbreviation: type: string readOnly: true error_message: type: string readOnly: true error_traceback: type: string readOnly: true resource_type: type: string readOnly: true state: allOf: - $ref: '#/components/schemas/CoreStates' readOnly: true created: type: string format: date-time readOnly: true modified: type: string format: date-time readOnly: true backend_id: type: string readOnly: true nullable: true description: Volume ID in the OpenStack backend access_url: type: string nullable: true readOnly: true source_snapshot: type: string format: uri readOnly: true nullable: true description: Snapshot that this volume was created from, if any size: type: integer maximum: 2147483647 minimum: 0 nullable: true description: Size in MiB bootable: type: boolean description: Indicates if this volume can be used to boot an instance metadata: readOnly: true image: type: string format: uri nullable: true description: Image that this volume was created from, if any image_metadata: type: string readOnly: true description: Metadata of the image this volume was created from image_name: type: string readOnly: true description: Name of the image this volume was created from type: type: string format: uri nullable: true description: Type of the volume (e.g. SSD, HDD) type_name: type: string readOnly: true runtime_state: type: string readOnly: true availability_zone: type: string format: uri nullable: true description: Availability zone where this volume is located availability_zone_name: type: string readOnly: true device: type: string readOnly: true description: Name of volume as instance device e.g. /dev/vdb. action: type: string readOnly: true action_details: readOnly: true instance: type: string format: uri readOnly: true nullable: true description: Instance that this volume is attached to, if any instance_name: type: string readOnly: true instance_marketplace_uuid: type: string format: uuid readOnly: true tenant: type: string format: uri tenant_uuid: type: string format: uuid readOnly: true extend_enabled: type: boolean readOnly: true marketplace_offering_uuid: type: string nullable: true readOnly: true marketplace_offering_name: type: string nullable: true readOnly: true marketplace_offering_plugin_options: type: object additionalProperties: {} nullable: true readOnly: true marketplace_category_uuid: type: string nullable: true readOnly: true marketplace_category_name: type: string nullable: true readOnly: true marketplace_resource_uuid: type: string nullable: true readOnly: true marketplace_plan_uuid: type: string nullable: true readOnly: true marketplace_resource_state: type: string nullable: true readOnly: true is_usage_based: type: boolean nullable: true readOnly: true is_limit_based: type: boolean nullable: true readOnly: true required: [] OpenStackVolumeAvailabilityZone: type: object description: '' properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true name: type: string maxLength: 150 settings: type: string format: uri nullable: true available: type: boolean required: - name - url - uuid OpenStackVolumeExtendRequest: type: object properties: disk_size: type: integer minimum: 1 required: - disk_size description: '' OpenStackVolumeRequest: type: object description: '' properties: name: type: string minLength: 1 maxLength: 150 description: type: string maxLength: 2000 bootable: type: boolean description: Indicates if this volume can be used to boot an instance required: - name OpenStackVolumeRetypeRequest: type: object properties: type: type: string format: uri required: - type description: '' OpenStackVolumeType: type: object description: '' properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true name: type: string maxLength: 150 description: type: string maxLength: 2000 settings: type: string format: uri required: - name - settings - url - uuid OptionField: type: object properties: type: $ref: '#/components/schemas/OptionFieldTypeEnum' label: type: string help_text: type: string required: type: boolean default: false choices: type: array items: type: string default: type: string min: type: integer max: type: integer required: - label - type description: '' OptionFieldRequest: type: object properties: type: $ref: '#/components/schemas/OptionFieldTypeEnum' label: type: string minLength: 1 help_text: type: string minLength: 1 required: type: boolean default: false choices: type: array items: type: string minLength: 1 default: type: string minLength: 1 min: type: integer max: type: integer required: - label - type description: '' OptionFieldTypeEnum: enum: - boolean - integer - money - string - text - html_text - select_string - select_string_multi - select_openstack_tenant - select_multiple_openstack_tenants - select_openstack_instance - select_multiple_openstack_instances - date - time type: string description: '' OrderCreate: type: object description: '' properties: offering: type: string format: uri offering_name: type: string readOnly: true offering_uuid: type: string format: uuid readOnly: true offering_description: type: string readOnly: true offering_image: type: string format: uri readOnly: true offering_thumbnail: type: string format: uri readOnly: true offering_type: type: string readOnly: true offering_shared: type: boolean description: Accessible to all customers. readOnly: true offering_billable: type: boolean description: Purchase and usage is invoiced. readOnly: true offering_plugin_options: description: Public data used by specific plugin, such as storage mode for OpenStack. readOnly: true provider_name: type: string readOnly: true provider_uuid: type: string format: uuid readOnly: true category_title: type: string readOnly: true category_uuid: type: string format: uuid readOnly: true category_icon: type: string format: uri readOnly: true plan: type: string format: uri plan_unit: allOf: - $ref: '#/components/schemas/BillingUnit' readOnly: true nullable: true plan_name: type: string readOnly: true nullable: true plan_uuid: type: string format: uuid readOnly: true nullable: true plan_description: type: string readOnly: true nullable: true attributes: {} limits: type: object additionalProperties: type: integer uuid: type: string format: uuid readOnly: true created: type: string format: date-time readOnly: true modified: type: string format: date-time readOnly: true type: allOf: - $ref: '#/components/schemas/RequestTypes' default: Create resource_uuid: type: string format: uuid readOnly: true nullable: true resource_type: type: string readOnly: true nullable: true resource_name: type: string readOnly: true cost: type: string format: decimal pattern: ^-?\d{0,12}(?:\.\d{0,10})?$ readOnly: true nullable: true state: allOf: - $ref: '#/components/schemas/OrderState' readOnly: true output: type: string readOnly: true marketplace_resource_uuid: type: string format: uuid readOnly: true error_message: type: string readOnly: true callback_url: type: string format: uri nullable: true maxLength: 200 completed_at: type: string format: date-time readOnly: true nullable: true title: Completion time url: type: string format: uri readOnly: true created_by: type: string format: uri readOnly: true created_by_username: type: string description: Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters readOnly: true created_by_full_name: type: string readOnly: true consumer_reviewed_by: type: string format: uri readOnly: true nullable: true consumer_reviewed_at: type: string format: date-time readOnly: true nullable: true consumer_reviewed_by_username: type: string description: Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters readOnly: true nullable: true consumer_reviewed_by_full_name: type: string readOnly: true nullable: true project: type: string format: uri project_uuid: type: string format: uuid readOnly: true project_name: type: string readOnly: true project_description: type: string readOnly: true customer_name: type: string readOnly: true customer_uuid: type: string format: uuid readOnly: true required: - category_icon - category_title - category_uuid - completed_at - consumer_reviewed_at - consumer_reviewed_by - consumer_reviewed_by_full_name - consumer_reviewed_by_username - cost - created - created_by - created_by_full_name - created_by_username - customer_name - customer_uuid - error_message - marketplace_resource_uuid - modified - offering - offering_billable - offering_description - offering_image - offering_name - offering_plugin_options - offering_shared - offering_thumbnail - offering_type - offering_uuid - output - plan_description - plan_name - plan_unit - plan_uuid - project - project_description - project_name - project_uuid - provider_name - provider_uuid - resource_name - resource_type - resource_uuid - state - url - uuid OrderCreateRequest: type: object description: '' properties: offering: type: string format: uri plan: type: string format: uri attributes: oneOf: - $ref: '#/components/schemas/AzureVirtualMachineCreateOrderAttributes' - $ref: '#/components/schemas/AzureSQLServerCreateOrderAttributes' - $ref: '#/components/schemas/OpenStackTenantCreateOrderAttributes' - $ref: '#/components/schemas/OpenStackInstanceCreateOrderAttributes' - $ref: '#/components/schemas/OpenStackVolumeCreateOrderAttributes' - $ref: '#/components/schemas/MarketplaceRancherCreateOrderAttributes' - $ref: '#/components/schemas/MarketplaceManagedRancherCreateOrderAttributes' - $ref: '#/components/schemas/SlurmInvoicesSlurmPackageCreateOrderAttributes' - $ref: '#/components/schemas/VMwareVirtualMachineCreateOrderAttributes' - $ref: '#/components/schemas/GenericOrderAttributes' description: Attributes structure depends on the offering type specified in the parent object. Can also be a generic object for offerings without a specific attributes schema. limits: type: object additionalProperties: type: integer type: allOf: - $ref: '#/components/schemas/RequestTypes' default: Create accepting_terms_of_service: type: boolean writeOnly: true callback_url: type: string format: uri nullable: true maxLength: 200 project: type: string format: uri required: - offering - project OrderDetails: type: object description: '' properties: offering: type: string format: uri offering_name: type: string readOnly: true offering_uuid: type: string format: uuid readOnly: true offering_description: type: string readOnly: true offering_image: type: string format: uri readOnly: true offering_thumbnail: type: string format: uri readOnly: true offering_type: type: string readOnly: true offering_shared: type: boolean description: Accessible to all customers. readOnly: true offering_billable: type: boolean description: Purchase and usage is invoiced. readOnly: true offering_plugin_options: description: Public data used by specific plugin, such as storage mode for OpenStack. readOnly: true provider_name: type: string readOnly: true provider_uuid: type: string format: uuid readOnly: true category_title: type: string readOnly: true category_uuid: type: string format: uuid readOnly: true category_icon: type: string format: uri readOnly: true plan: type: string format: uri plan_unit: allOf: - $ref: '#/components/schemas/BillingUnit' readOnly: true nullable: true plan_name: type: string readOnly: true nullable: true plan_uuid: type: string format: uuid readOnly: true nullable: true plan_description: type: string readOnly: true nullable: true attributes: {} limits: type: object additionalProperties: type: integer uuid: type: string format: uuid readOnly: true created: type: string format: date-time readOnly: true modified: type: string format: date-time readOnly: true type: allOf: - $ref: '#/components/schemas/RequestTypes' default: Create resource_uuid: type: string format: uuid readOnly: true nullable: true resource_type: type: string readOnly: true nullable: true resource_name: type: string readOnly: true cost: type: string format: decimal pattern: ^-?\d{0,12}(?:\.\d{0,10})?$ readOnly: true nullable: true state: allOf: - $ref: '#/components/schemas/OrderState' readOnly: true output: type: string readOnly: true marketplace_resource_uuid: type: string format: uuid readOnly: true error_message: type: string readOnly: true callback_url: type: string format: uri nullable: true maxLength: 200 completed_at: type: string format: date-time readOnly: true nullable: true title: Completion time consumer_reviewed_by: type: string description: Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters readOnly: true nullable: true consumer_reviewed_by_full_name: type: string readOnly: true nullable: true consumer_reviewed_by_username: type: string description: Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters readOnly: true nullable: true consumer_reviewed_at: type: string format: date-time readOnly: true nullable: true provider_reviewed_by: type: string description: Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters readOnly: true nullable: true provider_reviewed_by_full_name: type: string readOnly: true nullable: true provider_reviewed_by_username: type: string description: Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters readOnly: true nullable: true provider_reviewed_at: type: string format: date-time readOnly: true nullable: true created_by_username: type: string description: Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters readOnly: true created_by_full_name: type: string readOnly: true created_by_civil_number: type: string nullable: true readOnly: true customer_name: type: string readOnly: true customer_uuid: type: string format: uuid readOnly: true customer_slug: type: string readOnly: true project_name: type: string readOnly: true project_uuid: type: string format: uuid readOnly: true project_description: type: string readOnly: true project_slug: type: string readOnly: true old_plan_name: type: string readOnly: true nullable: true new_plan_name: type: string readOnly: true nullable: true old_plan_uuid: type: string format: uuid readOnly: true nullable: true new_plan_uuid: type: string format: uuid readOnly: true nullable: true old_cost_estimate: type: string format: decimal pattern: ^-?\d{0,12}(?:\.\d{0,10})?$ nullable: true readOnly: true new_cost_estimate: type: string format: decimal pattern: ^-?\d{0,12}(?:\.\d{0,10})?$ nullable: true readOnly: true can_terminate: type: boolean readOnly: true fixed_price: type: number format: double readOnly: true activation_price: type: number format: double readOnly: true termination_comment: type: string nullable: true readOnly: true backend_id: type: string maxLength: 255 issue: allOf: - $ref: '#/components/schemas/IssueReference' nullable: true readOnly: true required: [] OrderSetStateErredRequest: type: object properties: error_message: type: string error_traceback: type: string description: '' OrderState: enum: - pending-consumer - pending-provider - pending-project - executing - done - erred - canceled - rejected type: string description: '' OrderUUID: type: object properties: order_uuid: type: string format: uuid readOnly: true required: - order_uuid description: '' OrganizationGroup: type: object properties: uuid: type: string format: uuid readOnly: true url: type: string format: uri readOnly: true name: type: string maxLength: 150 parent_uuid: type: string format: uuid readOnly: true parent_name: type: string readOnly: true parent: type: string format: uri nullable: true customers_count: type: integer readOnly: true required: [] description: '' OrganizationGroupRequest: type: object properties: name: type: string minLength: 1 maxLength: 150 parent: type: string format: uri nullable: true required: - name description: '' OrganizationGroupsRequest: type: object properties: organization_groups: type: array items: type: string format: uri description: '' PaidRequest: type: object properties: date: type: string format: date proof: type: string format: binary required: - date description: '' PasswordChangeRequest: type: object properties: new_password: type: string writeOnly: true minLength: 1 required: - new_password description: '' PatchedAccessSubnetRequest: type: object description: '' properties: inet: type: string minLength: 1 description: type: string maxLength: 2000 PatchedAdminAnnouncementRequest: type: object description: '' properties: description: type: string maxLength: 2000 active_from: type: string format: date-time active_to: type: string format: date-time type: $ref: '#/components/schemas/AdminAnnouncementTypeEnum' PatchedAwsInstanceRequest: type: object description: '' properties: name: type: string minLength: 1 maxLength: 150 description: type: string maxLength: 2000 PatchedAzurePublicIPRequest: type: object description: '' properties: description: type: string maxLength: 2000 location: type: string format: uri resource_group: type: string format: uri PatchedAzureSqlDatabaseRequest: type: object description: '' properties: description: type: string maxLength: 2000 server: type: string format: uri charset: type: string nullable: true maxLength: 255 collation: type: string nullable: true maxLength: 255 PatchedAzureSqlServerRequest: type: object description: '' properties: description: type: string maxLength: 2000 location: type: string format: uri writeOnly: true storage_mb: type: integer maximum: 4194304 minimum: 5120 nullable: true PatchedAzureVirtualMachineRequest: type: object description: '' properties: description: type: string maxLength: 2000 location: type: string format: uri writeOnly: true PatchedBroadcastMessageRequest: type: object description: '' properties: subject: type: string minLength: 1 maxLength: 1000 body: type: string minLength: 1 query: {} send_at: type: string format: date nullable: true PatchedCallManagingOrganisationRequest: type: object description: '' properties: description: type: string maxLength: 2000 image: type: string format: binary nullable: true PatchedCallResourceTemplateRequest: type: object description: '' properties: name: type: string minLength: 1 maxLength: 255 description: type: string maxLength: 2000 attributes: {} limits: {} is_required: type: boolean description: If True, every proposal must include this resource type requested_offering: type: string format: uri PatchedCategoryColumnRequest: type: object properties: index: type: integer maximum: 32767 minimum: 0 description: Index allows to reorder columns. title: type: string minLength: 1 description: Title is rendered as column header. maxLength: 255 attribute: type: string description: Resource attribute is rendered as table cell. maxLength: 255 widget: nullable: true description: Widget field allows to customise table cell rendering. oneOf: - $ref: '#/components/schemas/WidgetEnum' - $ref: '#/components/schemas/BlankEnum' - $ref: '#/components/schemas/NullEnum' category: type: string format: uri description: '' PatchedCategoryComponentsRequest: type: object properties: type: type: string minLength: 1 description: Unique internal name of the measured unit, for example floating_ip. pattern: ^[a-zA-Z0-9_\-\/:]+$ maxLength: 50 name: type: string minLength: 1 description: Display name for the measured unit, for example, Floating IP. maxLength: 150 description: type: string maxLength: 2000 measured_unit: type: string description: Unit of measurement, for example, GB. maxLength: 30 category: $ref: '#/components/schemas/CategorySerializerForForNestedFieldsRequest' description: '' PatchedCategoryGroupRequest: type: object description: '' properties: title: type: string minLength: 1 maxLength: 255 description: type: string icon: type: string format: binary nullable: true PatchedCategoryHelpArticlesRequest: type: object properties: title: type: string nullable: true maxLength: 255 url: type: string format: uri minLength: 1 maxLength: 200 categories: type: array items: $ref: '#/components/schemas/CategorySerializerForForNestedFieldsRequest' description: '' PatchedChecklistCategoryRequest: type: object properties: icon: type: string format: binary nullable: true name: type: string minLength: 1 maxLength: 150 description: type: string maxLength: 2000 description: '' PatchedChecklistRequest: type: object description: '' properties: name: type: string minLength: 1 maxLength: 150 description: type: string maxLength: 2000 checklist_type: allOf: - $ref: '#/components/schemas/ChecklistTypeEnum' description: Type of compliance this checklist addresses category: type: string format: uuid nullable: true description: Category of the checklist PatchedClusterSecurityGroupRequest: type: object properties: rules: type: array items: $ref: '#/components/schemas/RancherClusterSecurityGroupRuleRequest' description: '' PatchedCommentRequest: type: object description: '' properties: description: type: string minLength: 1 is_public: type: boolean PatchedComponentUserUsageLimitRequest: type: object properties: resource: type: string format: uri component: type: string format: uuid user: type: string format: uri limit: type: string format: decimal pattern: ^-?\d{0,18}(?:\.\d{0,2})?$ description: '' PatchedCreateCustomerCreditRequest: type: object properties: value: type: string format: decimal pattern: ^-?\d{0,11}(?:\.\d{0,5})?$ customer: type: string format: uri offerings: type: array items: type: string format: uri nullable: true end_date: type: string format: date nullable: true expected_consumption: type: string format: decimal pattern: ^-?\d{0,11}(?:\.\d{0,5})?$ minimal_consumption_logic: $ref: '#/components/schemas/MinimalConsumptionLogicEnum' grace_coefficient: type: string format: decimal pattern: ^-?\d{0,3}(?:\.\d{0,0})?$ apply_as_minimal_consumption: type: boolean description: '' PatchedCustomerEstimatedCostPolicyRequest: type: object description: '' properties: scope: type: string format: uri actions: type: string minLength: 1 maxLength: 255 options: description: Fields for saving actions extra data. Keys are name of actions. limit_cost: type: integer maximum: 2147483647 minimum: -2147483648 period: allOf: - $ref: '#/components/schemas/PeriodEnum' minimum: -2147483648 maximum: 2147483647 PatchedCustomerRequest: type: object description: '' properties: backend_id: type: string description: Organization identifier in another application. maxLength: 255 image: type: string format: binary nullable: true name: type: string minLength: 1 maxLength: 150 native_name: type: string maxLength: 160 abbreviation: type: string maxLength: 12 description: type: string maxLength: 2000 contact_details: type: string maxLength: 500 email: type: string format: email title: Email address maxLength: 75 phone_number: type: string maxLength: 255 registration_code: type: string maxLength: 160 homepage: type: string format: uri maxLength: 255 vat_code: type: string description: VAT number maxLength: 20 postal: type: string maxLength: 20 address: type: string maxLength: 300 bank_name: type: string maxLength: 150 latitude: type: number format: double nullable: true longitude: type: number format: double nullable: true bank_account: type: string maxLength: 50 country: oneOf: - $ref: '#/components/schemas/CountryEnum' - $ref: '#/components/schemas/BlankEnum' PatchedCustomerServiceAccountRequest: type: object properties: username: type: string maxLength: 32 description: type: string error_traceback: type: string email: type: string format: email minLength: 1 maxLength: 320 preferred_identifier: type: string maxLength: 32 customer: type: string format: uuid description: '' PatchedDigitalOceanDropletRequest: type: object description: '' properties: name: type: string minLength: 1 maxLength: 150 description: type: string maxLength: 2000 PatchedEmailHookRequest: type: object properties: is_active: type: boolean event_types: type: array items: $ref: '#/components/schemas/EventTypesEnum' event_groups: type: array items: $ref: '#/components/schemas/EventGroupsEnum' email: type: string format: email minLength: 1 maxLength: 320 description: '' PatchedExternalLinkRequest: type: object properties: name: type: string minLength: 1 maxLength: 150 description: type: string maxLength: 2000 link: type: string format: uri minLength: 1 maxLength: 500 image: type: string format: binary nullable: true description: '' PatchedFirecrestJobRequest: type: object description: '' properties: name: type: string minLength: 1 maxLength: 150 description: type: string maxLength: 2000 runtime_state: type: string maxLength: 100 PatchedIdentityProviderRequest: type: object properties: provider: type: string minLength: 1 maxLength: 32 is_active: type: boolean client_id: type: string minLength: 1 description: ID of application used for OAuth authentication. maxLength: 200 verify_ssl: type: boolean enable_post_logout_redirect: type: boolean enable_pkce: type: boolean discovery_url: type: string minLength: 1 description: The endpoint for endpoint discovery. maxLength: 200 label: type: string minLength: 1 description: Human-readable identity provider is label. maxLength: 200 management_url: type: string description: The endpoint for user details management. maxLength: 200 protected_fields: {} extra_scope: type: string nullable: true description: Space-separated list of scopes to request during authentication. maxLength: 200 description: '' PatchedInvoiceItemUpdateRequest: type: object properties: article_code: type: string maxLength: 30 quantity: type: string format: decimal pattern: ^-?\d{0,12}(?:\.\d{0,10})?$ unit_price: type: string format: decimal pattern: ^-?\d{0,12}(?:\.\d{0,10})?$ start: type: string format: date-time description: Date and time when item usage has started. end: type: string format: date-time description: Date and time when item usage has ended. description: '' PatchedIssueRequest: type: object description: '' properties: summary: type: string minLength: 1 maxLength: 255 description: type: string assignee: type: string format: uri nullable: true is_reported_manually: type: boolean writeOnly: true default: false description: Set true if issue is created by regular user via portal. PatchedIssueStatusRequest: type: object properties: name: type: string minLength: 1 description: Status name in Jira. maxLength: 255 type: allOf: - $ref: '#/components/schemas/IssueStatusTypeEnum' minimum: -2147483648 maximum: 2147483647 description: '' PatchedKeycloakUserGroupMembershipRequest: type: object properties: username: type: string minLength: 1 description: Keycloak user username maxLength: 255 email: type: string format: email minLength: 1 description: User's email for notifications maxLength: 254 scope_uuid: type: string format: uuid writeOnly: true description: UUID of a cluster or a project in Rancher role: type: string format: uri writeOnly: true description: '' PatchedLexisLinkRequest: type: object properties: heappe_project_id: type: integer maximum: 2147483647 minimum: 0 nullable: true description: '' PatchedMaintenanceAnnouncementOfferingRequest: type: object properties: maintenance: type: string format: uri offering: type: string format: uri impact_level: allOf: - $ref: '#/components/schemas/ImpactLevelEnum' description: Expected impact on this offering minimum: 0 maximum: 32767 impact_description: type: string description: Specific description of how this offering will be affected description: '' PatchedMaintenanceAnnouncementOfferingTemplateRequest: type: object properties: maintenance_template: type: string format: uri offering: type: string format: uri impact_level: allOf: - $ref: '#/components/schemas/ImpactLevelEnum' description: Expected impact on this offering minimum: 0 maximum: 32767 impact_description: type: string description: Specific description of how this offering will be affected description: '' PatchedMaintenanceAnnouncementRequest: type: object properties: name: type: string minLength: 1 maxLength: 150 message: type: string maxLength: 2000 maintenance_type: allOf: - $ref: '#/components/schemas/MaintenanceTypeEnum' description: Type of maintenance being performed minimum: 0 maximum: 32767 external_reference_url: type: string format: uri description: Optional reference to an external maintenance tracker maxLength: 200 scheduled_start: type: string format: date-time description: When the maintenance is scheduled to begin scheduled_end: type: string format: date-time description: When the maintenance is scheduled to complete service_provider: type: string format: uri description: Service provider announcing the maintenance description: '' PatchedMaintenanceAnnouncementTemplateRequest: type: object properties: name: type: string minLength: 1 maxLength: 150 message: type: string maxLength: 2000 maintenance_type: allOf: - $ref: '#/components/schemas/MaintenanceTypeEnum' description: Type of maintenance being performed minimum: 0 maximum: 32767 service_provider: type: string format: uri description: Service provider announcing the maintenance description: '' PatchedMarketplaceCategoryRequest: type: object description: '' properties: title: type: string minLength: 1 maxLength: 255 description: type: string icon: type: string format: binary nullable: true default_vm_category: type: boolean description: Set to "true" if this category is for OpenStack VM. Only one category can have "true" value. default_volume_category: type: boolean description: Set to true if this category is for OpenStack Volume. Only one category can have "true" value. default_tenant_category: type: boolean description: Set to true if this category is for OpenStack Tenant. Only one category can have "true" value. group: type: string format: uri nullable: true PatchedMessageTemplateRequest: type: object properties: name: type: string minLength: 1 maxLength: 150 subject: type: string minLength: 1 body: type: string minLength: 1 description: '' PatchedMigrationDetailsRequest: type: object properties: mappings: $ref: '#/components/schemas/MappingRequest' error_message: type: string error_traceback: type: string description: '' PatchedNotificationRequest: type: object properties: key: type: string minLength: 1 maxLength: 255 description: type: string maxLength: 2000 description: '' PatchedNotificationTemplateDetailSerializersRequest: type: object properties: path: type: string minLength: 1 description: 'Example: ''flatpages/default.html''' maxLength: 150 name: type: string minLength: 1 maxLength: 150 description: '' PatchedOfferingEstimatedCostPolicyRequest: type: object description: '' properties: scope: type: string format: uri actions: type: string minLength: 1 maxLength: 255 options: description: Fields for saving actions extra data. Keys are name of actions. limit_cost: type: integer maximum: 2147483647 minimum: -2147483648 period: allOf: - $ref: '#/components/schemas/PeriodEnum' minimum: -2147483648 maximum: 2147483647 organization_groups: type: array items: type: string format: uri PatchedOfferingTermsOfServiceRequest: type: object description: '' properties: terms_of_service: type: string terms_of_service_link: type: string format: uri maxLength: 200 version: type: string maxLength: 50 is_active: type: boolean requires_reconsent: type: boolean description: If True, user will be asked to re-consent to the terms of service when the terms of service are updated. PatchedOfferingUsagePolicyRequest: type: object description: '' properties: scope: type: string format: uri actions: type: string minLength: 1 maxLength: 255 options: description: Fields for saving actions extra data. Keys are name of actions. organization_groups: type: array items: type: string format: uri component_limits_set: type: array items: $ref: '#/components/schemas/NestedOfferingComponentLimitRequest' period: allOf: - $ref: '#/components/schemas/PeriodEnum' minimum: -2147483648 maximum: 2147483647 PatchedOfferingUserRequest: type: object description: '' properties: user: type: string format: uri offering: type: string format: uri username: type: string nullable: true maxLength: 100 offering_uuid: type: string format: uuid user_uuid: type: string format: uuid PatchedOfferingUserRoleRequest: type: object properties: name: type: string minLength: 1 maxLength: 150 offering: type: string format: uri description: '' PatchedOfferingUserServiceProviderCommentRequest: type: object description: '' properties: service_provider_comment: type: string service_provider_comment_url: type: string format: uri description: URL link for additional information or actions related to service provider comment maxLength: 200 PatchedOpenStackBackupRequest: type: object description: '' properties: name: type: string minLength: 1 maxLength: 150 description: type: string maxLength: 2000 kept_until: type: string format: date-time nullable: true description: Guaranteed time of backup retention. If null - keep forever. PatchedOpenStackInstanceRequest: type: object description: '' properties: name: type: string minLength: 1 maxLength: 150 description: type: string maxLength: 2000 system_volume_type: type: string format: uri writeOnly: true nullable: true description: Volume type for the system volume data_volume_type: type: string format: uri writeOnly: true nullable: true description: Volume type for the data volume data_volumes: type: array items: $ref: '#/components/schemas/OpenStackDataVolumeRequest' writeOnly: true description: Additional data volumes to attach to the instance PatchedOpenStackNetworkRequest: type: object description: '' properties: name: type: string minLength: 1 maxLength: 150 description: type: string maxLength: 2000 PatchedOpenStackPortRequest: type: object description: '' properties: name: type: string minLength: 1 maxLength: 150 description: type: string maxLength: 2000 security_groups: type: array items: $ref: '#/components/schemas/OpenStackPortNestedSecurityGroupRequest' PatchedOpenStackSecurityGroupUpdateRequest: type: object properties: name: type: string minLength: 1 maxLength: 150 description: type: string maxLength: 2000 description: '' PatchedOpenStackServerGroupRequest: type: object description: '' properties: name: type: string minLength: 1 maxLength: 150 description: type: string maxLength: 2000 policy: description: Server group policy determining the rules for scheduling servers in this group oneOf: - $ref: '#/components/schemas/PolicyEnum' - $ref: '#/components/schemas/BlankEnum' PatchedOpenStackSnapshotRequest: type: object description: '' properties: name: type: string minLength: 1 maxLength: 150 description: type: string maxLength: 2000 metadata: {} kept_until: type: string format: date-time nullable: true description: Guaranteed time of snapshot retention. If null - keep forever. PatchedOpenStackSubNetRequest: type: object description: '' properties: name: type: string minLength: 1 maxLength: 150 description: type: string maxLength: 2000 cidr: type: string minLength: 1 gateway_ip: description: IP address of the gateway for this subnet oneOf: - type: string format: ipv4 - type: string format: ipv6 nullable: true minLength: 1 disable_gateway: type: boolean description: If True, no gateway IP address will be allocated allocation_pools: type: array items: $ref: '#/components/schemas/OpenStackSubNetAllocationPoolRequest' dns_nameservers: type: array items: description: An IPv4 or IPv6 address. oneOf: - type: string format: ipv4 - type: string format: ipv6 minLength: 1 host_routes: type: array items: $ref: '#/components/schemas/OpenStackStaticRouteRequest' PatchedOpenStackTenantRequest: type: object description: '' properties: name: type: string minLength: 1 maxLength: 64 description: type: string maxLength: 2000 availability_zone: type: string description: Optional availability group. Will be used for all instances provisioned in this tenant maxLength: 100 default_volume_type_name: type: string description: Volume type name to use when creating volumes. maxLength: 100 PatchedOpenStackVolumeRequest: type: object description: '' properties: name: type: string minLength: 1 maxLength: 150 description: type: string maxLength: 2000 bootable: type: boolean description: Indicates if this volume can be used to boot an instance PatchedOrganizationGroupRequest: type: object properties: name: type: string minLength: 1 maxLength: 150 parent: type: string format: uri nullable: true description: '' PatchedPaymentProfileRequest: type: object properties: name: type: string minLength: 1 maxLength: 150 organization: type: string format: uri attributes: $ref: '#/components/schemas/PaymentProfileAttributesRequest' payment_type: $ref: '#/components/schemas/PaymentTypeEnum' is_active: type: boolean nullable: true default: true description: '' PatchedPaymentRequest: type: object properties: profile: type: string format: uri date_of_payment: type: string format: date sum: type: string format: decimal pattern: ^-?\d{0,8}(?:\.\d{0,2})?$ proof: type: string format: binary nullable: true description: '' PatchedProjectCreditRequest: type: object properties: value: type: string format: decimal pattern: ^-?\d{0,11}(?:\.\d{0,5})?$ project: type: string format: uri end_date: type: string format: date nullable: true expected_consumption: type: string format: decimal pattern: ^-?\d{0,11}(?:\.\d{0,5})?$ minimal_consumption_logic: $ref: '#/components/schemas/MinimalConsumptionLogicEnum' grace_coefficient: type: string format: decimal pattern: ^-?\d{0,3}(?:\.\d{0,0})?$ apply_as_minimal_consumption: type: boolean description: '' PatchedProjectEstimatedCostPolicyRequest: type: object description: '' properties: scope: type: string format: uri actions: type: string minLength: 1 maxLength: 255 options: description: Fields for saving actions extra data. Keys are name of actions. limit_cost: type: integer maximum: 2147483647 minimum: -2147483648 period: allOf: - $ref: '#/components/schemas/PeriodEnum' minimum: -2147483648 maximum: 2147483647 PatchedProjectRequest: type: object description: '' properties: name: type: string minLength: 1 maxLength: 500 customer: type: string format: uri title: Organization description: type: string type: type: string format: uri nullable: true title: Project type backend_id: type: string maxLength: 255 start_date: type: string format: date nullable: true end_date: type: string format: date nullable: true description: The date is inclusive. Once reached, all project resource will be scheduled for termination. oecd_fos_2007_code: nullable: true oneOf: - $ref: '#/components/schemas/OecdFos2007CodeEnum' - $ref: '#/components/schemas/BlankEnum' - $ref: '#/components/schemas/NullEnum' is_industry: type: boolean image: type: string format: binary nullable: true kind: allOf: - $ref: '#/components/schemas/KindEnum' title: Project type PatchedProjectServiceAccountRequest: type: object properties: username: type: string maxLength: 32 description: type: string error_traceback: type: string email: type: string format: email minLength: 1 maxLength: 320 preferred_identifier: type: string maxLength: 32 project: type: string format: uuid description: '' PatchedProposalProjectRoleMappingRequest: type: object properties: call: type: string format: uri proposal_role: type: string minLength: 1 project_role: type: string minLength: 1 nullable: true description: '' PatchedProposalReviewRequest: type: object description: '' properties: summary_score: type: integer maximum: 32767 minimum: 0 summary_public_comment: type: string summary_private_comment: type: string comment_project_title: type: string nullable: true maxLength: 255 comment_project_summary: type: string nullable: true maxLength: 255 comment_project_is_confidential: type: string nullable: true maxLength: 255 comment_project_has_civilian_purpose: type: string nullable: true maxLength: 255 comment_project_description: type: string nullable: true maxLength: 255 comment_project_duration: type: string nullable: true maxLength: 255 comment_project_supporting_documentation: type: string nullable: true maxLength: 255 comment_resource_requests: type: string nullable: true maxLength: 255 comment_team: type: string nullable: true maxLength: 255 PatchedProtectedCallRequest: type: object description: '' properties: name: type: string minLength: 1 maxLength: 150 description: type: string fixed_duration_in_days: type: integer nullable: true backend_id: type: string maxLength: 255 external_url: type: string format: uri nullable: true maxLength: 200 reviewer_identity_visible_to_submitters: type: boolean description: Whether proposal submitters can see reviewer identities reviews_visible_to_submitters: type: boolean description: Whether proposal submitters can see review comments and scores created_by: type: string format: uri nullable: true reference_code: type: string minLength: 1 compliance_checklist: type: string format: uuid nullable: true description: Compliance checklist that proposals must complete before submission PatchedProtectedRoundRequest: type: object description: '' properties: start_time: type: string format: date-time cutoff_time: type: string format: date-time review_strategy: $ref: '#/components/schemas/ReviewStrategyEnum' deciding_entity: $ref: '#/components/schemas/DecidingEntityEnum' allocation_time: $ref: '#/components/schemas/AllocationTimeEnum' allocation_date: type: string format: date-time nullable: true minimal_average_scoring: type: string format: decimal pattern: ^-?\d{0,4}(?:\.\d{0,1})?$ nullable: true review_duration_in_days: type: integer default: 7 minimum_number_of_reviewers: type: integer maximum: 2147483647 minimum: 0 nullable: true PatchedProviderPlanDetailsRequest: type: object description: '' properties: name: type: string minLength: 1 maxLength: 150 description: type: string article_code: type: string maxLength: 30 max_amount: type: integer maximum: 32767 minimum: 1 nullable: true description: Maximum number of plans that could be active. Plan is disabled when maximum amount is reached. archived: type: boolean description: Forbids creation of new resources. unit_price: type: string format: decimal pattern: ^-?\d{0,12}(?:\.\d{0,10})?$ unit: $ref: '#/components/schemas/BillingUnit' backend_id: type: string maxLength: 255 PatchedQuestionAdminRequest: type: object description: '' properties: description: type: string maxLength: 2000 user_guidance: type: string description: Additional guidance text visible to users when answering and reviewing checklist: type: string format: uri order: type: integer maximum: 2147483647 minimum: 0 required: type: boolean question_type: allOf: - $ref: '#/components/schemas/QuestionTypeEnum' description: Type of question and expected answer format operator: oneOf: - $ref: '#/components/schemas/ChecklistOperators' - $ref: '#/components/schemas/BlankEnum' review_answer_value: nullable: true description: Answer value that trigger review. always_requires_review: type: boolean description: This question always requires review regardless of answer guidance_answer_value: nullable: true description: Answer value that triggers display of user guidance. guidance_operator: description: Operator to use when comparing answer with guidance_answer_value oneOf: - $ref: '#/components/schemas/ChecklistOperators' - $ref: '#/components/schemas/BlankEnum' always_show_guidance: type: boolean description: Show user guidance always, regardless of answer. If False, guidance is conditional on answer matching guidance_answer_value with guidance_operator min_value: type: string format: decimal pattern: ^-?\d{0,16}(?:\.\d{0,4})?$ nullable: true description: Minimum value allowed for NUMBER type questions max_value: type: string format: decimal pattern: ^-?\d{0,16}(?:\.\d{0,4})?$ nullable: true description: Maximum value allowed for NUMBER type questions dependency_logic_operator: allOf: - $ref: '#/components/schemas/DependencyLogicOperatorEnum' description: 'Defines how multiple dependencies are evaluated. AND: All dependencies must be satisfied. OR: At least one dependency must be satisfied.' PatchedQuestionDependencyRequest: type: object description: '' properties: question: type: string format: uri depends_on_question: type: string format: uri required_answer_value: description: The answer value(s) that make this question visible operator: $ref: '#/components/schemas/ChecklistOperators' PatchedQuestionOptionsAdminRequest: type: object description: '' properties: label: type: string minLength: 1 maxLength: 255 order: type: integer maximum: 2147483647 minimum: 0 PatchedRancherApplicationRequest: type: object description: '' properties: name: type: string minLength: 1 maxLength: 150 description: type: string maxLength: 2000 service_settings: type: string format: uri project: type: string format: uri error_message: type: string error_traceback: type: string backend_id: type: string maxLength: 255 runtime_state: type: string maxLength: 150 template: type: string format: uri rancher_project: type: string format: uri namespace: type: string format: uri namespace_name: type: string writeOnly: true minLength: 1 version: type: string minLength: 1 answers: type: object additionalProperties: {} PatchedRancherCatalogRequest: type: object properties: name: type: string minLength: 1 maxLength: 150 description: type: string maxLength: 2000 catalog_url: type: string format: uri minLength: 1 maxLength: 200 branch: type: string minLength: 1 maxLength: 255 scope: type: string description: '' PatchedRancherClusterRequest: type: object description: '' properties: name: type: string minLength: 1 pattern: ^[a-z0-9]([-a-z0-9])+[a-z0-9]$ maxLength: 150 description: type: string maxLength: 2000 vm_project: type: string format: uri nullable: true ssh_public_key: type: string format: uri writeOnly: true install_longhorn: type: boolean default: false description: Longhorn is a distributed block storage deployed on top of Kubernetes cluster PatchedRancherHPARequest: type: object properties: name: type: string minLength: 1 maxLength: 150 description: type: string maxLength: 2000 workload: type: string format: uri nullable: true min_replicas: type: integer maximum: 32767 minimum: 0 max_replicas: type: integer maximum: 32767 minimum: 0 metrics: {} description: '' PatchedRancherIngressRequest: type: object description: '' properties: name: type: string minLength: 1 maxLength: 150 description: type: string maxLength: 2000 service_settings: type: string format: uri project: type: string format: uri error_message: type: string error_traceback: type: string backend_id: type: string maxLength: 255 runtime_state: type: string maxLength: 150 rancher_project: type: string format: uri namespace: type: string format: uri rules: {} PatchedRancherServiceRequest: type: object description: '' properties: name: type: string minLength: 1 maxLength: 150 description: type: string maxLength: 2000 service_settings: type: string format: uri project: type: string format: uri error_message: type: string error_traceback: type: string backend_id: type: string maxLength: 255 runtime_state: type: string maxLength: 150 namespace: type: string format: uri cluster_ip: description: An IPv4 or IPv6 address. oneOf: - type: string format: ipv4 - type: string format: ipv6 nullable: true minLength: 1 selector: nullable: true target_workloads: type: array items: $ref: '#/components/schemas/RancherNestedWorkloadRequest' PatchedRancherWorkloadRequest: type: object properties: name: type: string minLength: 1 maxLength: 150 runtime_state: type: string maxLength: 150 cluster: type: string format: uri nullable: true project: type: string format: uri nullable: true namespace: type: string format: uri nullable: true scale: type: integer maximum: 32767 minimum: 0 description: '' PatchedRemoteSynchronisationRequest: type: object description: '' properties: api_url: type: string format: uri minLength: 1 maxLength: 200 token: type: string minLength: 1 maxLength: 255 remote_organization_name: type: string minLength: 1 maxLength: 255 local_service_provider: type: string format: uri is_active: type: boolean remotelocalcategory_set: type: array items: $ref: '#/components/schemas/NestedRemoteLocalCategoryRequest' PatchedRequestedOfferingRequest: type: object description: '' properties: attributes: {} plan: type: string format: uri nullable: true description: type: string maxLength: 2000 PatchedRequestedResourceRequest: type: object description: '' properties: attributes: {} limits: {} description: type: string maxLength: 2000 requested_offering_uuid: type: string format: uuid writeOnly: true call_resource_template_uuid: type: string format: uuid writeOnly: true PatchedResourceUpdateRequest: type: object properties: name: type: string minLength: 1 maxLength: 150 description: type: string maxLength: 2000 end_date: type: string format: date nullable: true description: The date is inclusive. Once reached, a resource will be scheduled for termination. description: '' PatchedRobotAccountRequest: type: object properties: username: type: string maxLength: 32 description: type: string resource: type: string format: uri type: type: string minLength: 1 description: Type of the robot account. maxLength: 5 users: type: array items: type: string format: uri description: Users who have access to this robot account. keys: {} responsible_user: type: string format: uri nullable: true required: [] description: '' PatchedRoleDetailsRequest: type: object description: '' properties: name: type: string minLength: 1 maxLength: 150 description: type: string maxLength: 2000 description_en: type: string nullable: true title: Description [en] maxLength: 2000 description_et: type: string nullable: true title: Description [et] maxLength: 2000 description_lt: type: string nullable: true title: Description [lt] maxLength: 2000 description_lv: type: string nullable: true title: Description [lv] maxLength: 2000 description_ru: type: string nullable: true title: Description [ru] maxLength: 2000 description_it: type: string nullable: true title: Description [it] maxLength: 2000 description_de: type: string nullable: true title: Description [de] maxLength: 2000 description_da: type: string nullable: true title: Description [da] maxLength: 2000 description_sv: type: string nullable: true title: Description [sv] maxLength: 2000 description_es: type: string nullable: true title: Description [es] maxLength: 2000 description_fr: type: string nullable: true title: Description [fr] maxLength: 2000 description_nb: type: string nullable: true title: Description [nb] maxLength: 2000 description_ar: type: string nullable: true title: Description [ar] maxLength: 2000 description_cs: type: string nullable: true title: Description [cs] maxLength: 2000 is_active: type: boolean PatchedRuleRequest: type: object properties: name: type: string minLength: 1 maxLength: 150 user_affiliations: type: array items: type: string minLength: 1 user_email_patterns: type: array items: type: string minLength: 1 customer: type: string format: uri project_role: type: string format: uri nullable: true project_role_name: type: string writeOnly: true nullable: true minLength: 1 plan: type: string format: uri nullable: true plan_attributes: type: object additionalProperties: {} plan_limits: type: object additionalProperties: {} description: '' PatchedScreenshotRequest: type: object description: '' properties: name: type: string minLength: 1 maxLength: 150 description: type: string maxLength: 2000 PatchedSectionRequest: type: object properties: key: type: string minLength: 1 maxLength: 255 title: type: string minLength: 1 maxLength: 255 category: type: string format: uri is_standalone: type: boolean description: Whether section is rendered as a separate tab. description: '' PatchedServiceProviderRequest: type: object description: '' properties: description: type: string maxLength: 2000 image: type: string format: binary nullable: true PatchedSlurmAllocationRequest: type: object description: '' properties: name: type: string minLength: 1 maxLength: 150 description: type: string maxLength: 2000 PatchedTemplateRequest: type: object properties: name: type: string minLength: 1 maxLength: 150 description: type: string minLength: 1 issue_type: $ref: '#/components/schemas/IssueTypeEnum' description: '' PatchedUserAgreementRequest: type: object properties: content: type: string minLength: 1 agreement_type: $ref: '#/components/schemas/AgreementTypeEnum' description: '' PatchedUserOfferingConsentRequest: type: object description: '' properties: version: type: string maxLength: 50 PatchedUserRequest: type: object description: '' properties: username: type: string minLength: 1 description: Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters pattern: ^[0-9a-z_.@+-]+$ maxLength: 128 native_name: type: string maxLength: 100 job_title: type: string maxLength: 120 phone_number: type: string maxLength: 255 organization: type: string maxLength: 255 description: type: string maxLength: 2000 is_staff: type: boolean title: Staff status description: Designates whether the user can log into this admin site. is_active: type: boolean title: Active description: Designates whether this user should be treated as active. Unselect this instead of deleting accounts. is_support: type: boolean title: Support status description: Designates whether the user is a global support user. token_lifetime: type: integer maximum: 2147483647 minimum: 60 nullable: true description: Token lifetime in seconds. agree_with_policy: type: boolean writeOnly: true description: User must agree with the policy to register. notifications_enabled: type: boolean description: Designates whether the user is allowed to receive email notifications. preferred_language: type: string maxLength: 10 first_name: type: string maxLength: 100 last_name: type: string maxLength: 100 image: type: string format: binary nullable: true PatchedVmwareVirtualMachineRequest: type: object description: '' properties: description: type: string maxLength: 2000 cores: type: integer maximum: 32767 minimum: 1 description: Number of cores in a VM cores_per_socket: type: integer maximum: 32767 minimum: 1 description: Number of cores per socket in a VM ram: type: integer maximum: 2147483647 minimum: 1024 description: Memory size in MiB PatchedWebHookRequest: type: object properties: is_active: type: boolean event_types: type: array items: $ref: '#/components/schemas/EventTypesEnum' event_groups: type: array items: $ref: '#/components/schemas/EventGroupsEnum' destination_url: type: string format: uri minLength: 1 maxLength: 200 content_type: $ref: '#/components/schemas/WebHookContentTypeEnum' description: '' Payment: type: object properties: uuid: type: string format: uuid readOnly: true url: type: string format: uri readOnly: true profile: type: string format: uri date_of_payment: type: string format: date sum: type: string format: decimal pattern: ^-?\d{0,8}(?:\.\d{0,2})?$ proof: type: string format: uri nullable: true invoice: type: string format: uri readOnly: true invoice_uuid: type: string format: uuid readOnly: true invoice_period: type: string nullable: true readOnly: true customer_uuid: type: string format: uuid readOnly: true required: - customer_uuid - date_of_payment - invoice - invoice_period - invoice_uuid - profile - url - uuid description: '' PaymentProfile: type: object properties: uuid: type: string format: uuid readOnly: true url: type: string format: uri readOnly: true name: type: string maxLength: 150 organization_uuid: type: string format: uuid readOnly: true organization: type: string format: uri attributes: $ref: '#/components/schemas/PaymentProfileAttributes' payment_type: $ref: '#/components/schemas/PaymentTypeEnum' payment_type_display: type: string readOnly: true is_active: type: boolean nullable: true default: true required: [] description: '' PaymentProfileAttributes: type: object properties: end_date: type: string agreement_number: type: string contract_sum: type: integer description: '' PaymentProfileAttributesRequest: type: object properties: end_date: type: string minLength: 1 agreement_number: type: string minLength: 1 contract_sum: type: integer description: '' PaymentProfileRequest: type: object properties: name: type: string minLength: 1 maxLength: 150 organization: type: string format: uri attributes: $ref: '#/components/schemas/PaymentProfileAttributesRequest' payment_type: $ref: '#/components/schemas/PaymentTypeEnum' is_active: type: boolean nullable: true default: true required: - name - organization - payment_type description: '' PaymentRequest: type: object properties: profile: type: string format: uri date_of_payment: type: string format: date sum: type: string format: decimal pattern: ^-?\d{0,8}(?:\.\d{0,2})?$ proof: type: string format: binary nullable: true required: - date_of_payment - profile description: '' PaymentTypeEnum: enum: - fixed_price - invoices - payment_gw_monthly type: string description: '' PaymentURLRequest: type: object properties: payment_url: type: string format: uri description: URL for initiating payment via payment gateway. maxLength: 200 description: '' PeriodEnum: enum: - 1 - 2 - 3 - 4 type: integer description: '' Permission: type: object properties: user_uuid: type: string format: uuid readOnly: true user_name: type: string readOnly: true user_slug: type: string readOnly: true created: type: string format: date-time readOnly: true expiration_time: type: string format: date-time nullable: true created_by_full_name: type: string readOnly: true created_by_username: type: string readOnly: true role_name: type: string readOnly: true role_description: type: string readOnly: true role_uuid: type: string format: uuid readOnly: true scope_type: type: string nullable: true readOnly: true scope_uuid: type: string format: uuid readOnly: true scope_name: type: string readOnly: true customer_uuid: type: string format: uuid readOnly: true customer_name: type: string readOnly: true required: [] description: '' PermissionProject: type: object properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true name: type: string maxLength: 500 image: type: string format: uri nullable: true resource_count: type: integer readOnly: true end_date: type: string format: date nullable: true description: The date is inclusive. Once reached, all project resource will be scheduled for termination. required: [] description: '' PermissionRequest: type: object properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true invitation: type: string format: uri state: type: string readOnly: true created: type: string format: date-time readOnly: true created_by_full_name: type: string readOnly: true created_by_username: type: string readOnly: true created_by_email: type: string format: email readOnly: true reviewed_by_full_name: type: string readOnly: true reviewed_by_username: type: string readOnly: true reviewed_at: type: string format: date-time readOnly: true nullable: true description: Timestamp when the review was completed review_comment: type: string nullable: true description: Optional comment provided during review scope_uuid: type: string format: uuid readOnly: true scope_name: type: string readOnly: true customer_uuid: type: string format: uuid readOnly: true customer_name: type: string readOnly: true role_name: type: string readOnly: true role_description: type: string readOnly: true project_name_template: type: string readOnly: true required: - created - created_by_email - created_by_full_name - created_by_username - customer_name - customer_uuid - invitation - project_name_template - reviewed_at - reviewed_by_full_name - reviewed_by_username - role_description - role_name - scope_name - scope_uuid - state - url - uuid description: '' PlanComponent: type: object properties: offering_name: type: string readOnly: true plan_name: type: string readOnly: true plan_unit: allOf: - $ref: '#/components/schemas/BillingUnit' readOnly: true component_name: type: string description: Display name for the measured unit, for example, Floating IP. readOnly: true measured_unit: type: string description: Unit of measurement, for example, GB. readOnly: true billing_type: allOf: - $ref: '#/components/schemas/BillingTypeEnum' readOnly: true amount: type: integer maximum: 2147483647 minimum: 0 price: type: string format: decimal pattern: ^-?\d{0,12}(?:\.\d{0,10})?$ title: Price per unit per billing period. future_price: type: string format: decimal pattern: ^-?\d{0,12}(?:\.\d{0,10})?$ nullable: true title: Price per unit for future month. required: - billing_type - component_name - measured_unit - offering_name - plan_name - plan_unit description: '' PlanUsageResponse: type: object properties: plan_uuid: type: string format: uuid readOnly: true plan_name: type: string readOnly: true limit: type: integer readOnly: true usage: type: integer readOnly: true remaining: type: integer readOnly: true offering_uuid: type: string format: uuid readOnly: true offering_name: type: string readOnly: true customer_provider_uuid: type: string format: uuid readOnly: true customer_provider_name: type: string readOnly: true required: - customer_provider_name - customer_provider_uuid - limit - offering_name - offering_uuid - plan_name - plan_uuid - remaining - usage description: '' PluginComponent: type: object properties: type: type: string name: type: string measured_unit: type: string billing_type: $ref: '#/components/schemas/BillingTypeEnum' required: - billing_type - measured_unit - name - type description: '' PluginOfferingType: type: object properties: offering_type: type: string components: type: array items: $ref: '#/components/schemas/PluginComponent' available_limits: type: array items: type: string required: - available_limits - components - offering_type description: '' PolicyEnum: enum: - affinity type: string description: '' PolicyTypeEnum: enum: - access_as_shared - access_as_external type: string description: '' PricesUpdateRequest: type: object properties: prices: type: object additionalProperties: type: string format: decimal pattern: ^-?\d{0,12}(?:\.\d{0,10})?$ required: - prices description: '' Priority: type: object description: '' properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true name: type: string maxLength: 150 description: type: string maxLength: 2000 icon_url: type: string format: uri maxLength: 500 required: - name - url - uuid Project: type: object description: '' properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true name: type: string maxLength: 500 slug: type: string readOnly: true maxLength: 50 pattern: ^[-a-zA-Z0-9_]+$ customer: type: string format: uri title: Organization customer_uuid: type: string format: uuid readOnly: true customer_name: type: string readOnly: true customer_slug: type: string readOnly: true customer_native_name: type: string readOnly: true customer_abbreviation: type: string readOnly: true description: type: string created: type: string format: date-time readOnly: true type: type: string format: uri nullable: true title: Project type type_name: type: string readOnly: true nullable: true type_uuid: type: string format: uuid readOnly: true nullable: true backend_id: type: string maxLength: 255 start_date: type: string format: date nullable: true end_date: type: string format: date nullable: true description: The date is inclusive. Once reached, all project resource will be scheduled for termination. end_date_requested_by: type: string format: uri readOnly: true nullable: true oecd_fos_2007_code: nullable: true oneOf: - $ref: '#/components/schemas/OecdFos2007CodeEnum' - $ref: '#/components/schemas/BlankEnum' - $ref: '#/components/schemas/NullEnum' oecd_fos_2007_label: type: string readOnly: true is_industry: type: boolean image: type: string format: uri nullable: true resources_count: type: integer readOnly: true max_service_accounts: type: integer maximum: 32767 minimum: 0 readOnly: true nullable: true description: Maximum number of service accounts allowed kind: allOf: - $ref: '#/components/schemas/KindEnum' title: Project type project_credit: type: number format: double nullable: true readOnly: true marketplace_resource_count: type: object additionalProperties: type: integer readOnly: true billing_price_estimate: allOf: - $ref: '#/components/schemas/NestedPriceEstimate' readOnly: true required: [] ProjectAnswer: type: object description: '' properties: project_uuid: type: string format: uuid readOnly: true project_name: type: string readOnly: true completion_uuid: type: string nullable: true description: Get completion UUID. readOnly: true completion_percentage: type: number format: double description: Get completion percentage. readOnly: true is_completed: type: boolean description: Get completion status. readOnly: true requires_review: type: boolean description: Get review requirement status. readOnly: true answers_count: type: integer description: Get count of answers. readOnly: true unanswered_required_count: type: integer description: Get count of unanswered required questions. readOnly: true required: - answers_count - completion_percentage - completion_uuid - is_completed - project_name - project_uuid - requires_review - unanswered_required_count ProjectCredit: type: object properties: uuid: type: string format: uuid readOnly: true url: type: string format: uri readOnly: true value: type: string format: decimal pattern: ^-?\d{0,11}(?:\.\d{0,5})?$ project: type: string format: uri project_name: type: string readOnly: true project_uuid: type: string format: uuid readOnly: true project_slug: type: string readOnly: true customer_name: type: string readOnly: true customer_slug: type: string readOnly: true customer_uuid: type: string format: uuid readOnly: true customer_credit: type: string format: decimal pattern: ^-?\d{0,11}(?:\.\d{0,5})?$ readOnly: true allocated_customer_credit: type: number format: double readOnly: true consumption_last_month: type: number format: double readOnly: true offerings: type: array items: $ref: '#/components/schemas/NestedPublicOffering' readOnly: true end_date: type: string format: date nullable: true expected_consumption: type: string format: decimal pattern: ^-?\d{0,11}(?:\.\d{0,5})?$ minimal_consumption: type: number format: double readOnly: true minimal_consumption_logic: $ref: '#/components/schemas/MinimalConsumptionLogicEnum' grace_coefficient: type: string format: decimal pattern: ^-?\d{0,3}(?:\.\d{0,0})?$ apply_as_minimal_consumption: type: boolean required: - allocated_customer_credit - consumption_last_month - customer_credit - customer_name - customer_slug - customer_uuid - minimal_consumption - offerings - project - project_name - project_slug - project_uuid - url - uuid description: '' ProjectCreditRequest: type: object properties: value: type: string format: decimal pattern: ^-?\d{0,11}(?:\.\d{0,5})?$ project: type: string format: uri end_date: type: string format: date nullable: true expected_consumption: type: string format: decimal pattern: ^-?\d{0,11}(?:\.\d{0,5})?$ minimal_consumption_logic: $ref: '#/components/schemas/MinimalConsumptionLogicEnum' grace_coefficient: type: string format: decimal pattern: ^-?\d{0,3}(?:\.\d{0,0})?$ apply_as_minimal_consumption: type: boolean required: - project description: '' ProjectDetail: type: object description: '' properties: project_uuid: type: string format: uuid readOnly: true project_name: type: string readOnly: true completion_uuid: type: string format: uuid readOnly: true nullable: true completion_percentage: type: number format: double readOnly: true is_completed: type: boolean readOnly: true requires_review: type: boolean readOnly: true answers: type: array items: {} readOnly: true unanswered_required_questions: type: array items: {} readOnly: true required: - answers - completion_percentage - completion_uuid - is_completed - project_name - project_uuid - requires_review - unanswered_required_questions ProjectDetailsResponse: type: object description: '' properties: checklist: allOf: - $ref: '#/components/schemas/ChecklistInfo' readOnly: true total_projects: type: integer readOnly: true projects_with_completions: type: integer readOnly: true fully_completed_projects: type: integer readOnly: true projects_requiring_review: type: integer readOnly: true project_details: type: array items: $ref: '#/components/schemas/ProjectDetail' readOnly: true required: - checklist - fully_completed_projects - project_details - projects_requiring_review - projects_with_completions - total_projects ProjectEstimatedCostPolicy: type: object description: '' properties: uuid: type: string format: uuid readOnly: true url: type: string format: uri readOnly: true scope: type: string format: uri scope_name: type: string readOnly: true scope_uuid: type: string format: uuid readOnly: true actions: type: string maxLength: 255 created: type: string format: date-time readOnly: true created_by_full_name: type: string readOnly: true created_by_username: type: string readOnly: true has_fired: type: boolean readOnly: true fired_datetime: type: string format: date-time readOnly: true options: description: Fields for saving actions extra data. Keys are name of actions. limit_cost: type: integer maximum: 2147483647 minimum: -2147483648 period: allOf: - $ref: '#/components/schemas/PeriodEnum' minimum: -2147483648 maximum: 2147483647 period_name: type: string readOnly: true project_credit: type: number format: double nullable: true readOnly: true customer_credit: type: number format: double nullable: true readOnly: true billing_price_estimate: allOf: - $ref: '#/components/schemas/NestedPriceEstimate' readOnly: true required: - actions - billing_price_estimate - created - created_by_full_name - created_by_username - customer_credit - fired_datetime - has_fired - limit_cost - period_name - project_credit - scope - scope_name - scope_uuid - url - uuid ProjectEstimatedCostPolicyRequest: type: object description: '' properties: scope: type: string format: uri actions: type: string minLength: 1 maxLength: 255 options: description: Fields for saving actions extra data. Keys are name of actions. limit_cost: type: integer maximum: 2147483647 minimum: -2147483648 period: allOf: - $ref: '#/components/schemas/PeriodEnum' minimum: -2147483648 maximum: 2147483647 required: - actions - limit_cost - scope ProjectPermissionLog: type: object description: '' properties: created: type: string format: date-time readOnly: true expiration_time: type: string format: date-time nullable: true created_by: type: string format: uri readOnly: true nullable: true created_by_full_name: type: string readOnly: true nullable: true created_by_username: type: string description: Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters readOnly: true nullable: true project: type: string format: uri readOnly: true project_uuid: type: string format: uuid readOnly: true project_name: type: string readOnly: true project_created: type: string format: date-time readOnly: true project_end_date: type: string format: date-time readOnly: true customer_uuid: type: string format: uuid readOnly: true customer_name: type: string readOnly: true role: type: string readOnly: true role_name: type: string readOnly: true user: type: string format: uri user_full_name: type: string readOnly: true user_native_name: type: string readOnly: true user_username: type: string description: Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters readOnly: true user_uuid: type: string format: uuid readOnly: true user_email: type: string format: email title: Email address readOnly: true required: [] ProjectPermissionReview: type: object description: '' properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true reviewer_full_name: type: string readOnly: true nullable: true reviewer_uuid: type: string format: uuid readOnly: true nullable: true is_pending: type: boolean readOnly: true created: type: string format: date-time readOnly: true closed: type: string format: date-time readOnly: true nullable: true project_uuid: type: string format: uuid readOnly: true project_name: type: string readOnly: true required: - closed - created - is_pending - project_name - project_uuid - reviewer_full_name - reviewer_uuid - url - uuid ProjectQuotas: type: object properties: project_name: type: string readOnly: true customer_name: type: string readOnly: true customer_abbreviation: type: string readOnly: true value: type: integer readOnly: true required: - customer_abbreviation - customer_name - project_name - value description: '' ProjectRequest: type: object description: '' properties: name: type: string minLength: 1 maxLength: 500 customer: type: string format: uri title: Organization description: type: string type: type: string format: uri nullable: true title: Project type backend_id: type: string maxLength: 255 start_date: type: string format: date nullable: true end_date: type: string format: date nullable: true description: The date is inclusive. Once reached, all project resource will be scheduled for termination. oecd_fos_2007_code: nullable: true oneOf: - $ref: '#/components/schemas/OecdFos2007CodeEnum' - $ref: '#/components/schemas/BlankEnum' - $ref: '#/components/schemas/NullEnum' is_industry: type: boolean image: type: string format: binary nullable: true kind: allOf: - $ref: '#/components/schemas/KindEnum' title: Project type required: - customer - name ProjectServiceAccount: type: object properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true created: type: string format: date-time readOnly: true modified: type: string format: date-time readOnly: true username: type: string maxLength: 32 description: type: string error_message: type: string readOnly: true error_traceback: type: string state: allOf: - $ref: '#/components/schemas/ServiceAccountState' readOnly: true token: type: string nullable: true readOnly: true email: type: string format: email maxLength: 320 expires_at: type: string nullable: true readOnly: true preferred_identifier: type: string maxLength: 32 project: type: string format: uuid project_uuid: type: string format: uuid readOnly: true project_name: type: string readOnly: true customer_uuid: type: string format: uuid readOnly: true customer_name: type: string readOnly: true customer_abbreviation: type: string readOnly: true required: - created - customer_abbreviation - customer_name - customer_uuid - error_message - expires_at - modified - project - project_name - project_uuid - state - token - url - uuid description: '' ProjectServiceAccountRequest: type: object properties: username: type: string maxLength: 32 description: type: string error_traceback: type: string email: type: string format: email minLength: 1 maxLength: 320 preferred_identifier: type: string maxLength: 32 project: type: string format: uuid required: - project description: '' ProjectType: type: object properties: uuid: type: string format: uuid readOnly: true url: type: string format: uri readOnly: true name: type: string maxLength: 150 description: type: string maxLength: 2000 required: - name - url - uuid description: '' ProjectUser: type: object properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true username: type: string description: Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters pattern: ^[0-9a-z_.@+-]+$ maxLength: 128 full_name: type: string readOnly: true email: type: string format: email title: Email address maxLength: 320 role: type: string readOnly: true expiration_time: type: string format: date-time nullable: true readOnly: true offering_user_username: type: string nullable: true readOnly: true required: - expiration_time - full_name - offering_user_username - role - url - username - uuid description: '' ProjectsLimitsGroupedByIndustryFlag: type: object properties: limits: type: object additionalProperties: type: object additionalProperties: type: string format: decimal pattern: ^-?\d{0,18}(?:\.\d{0,2})?$ required: - limits description: '' ProjectsLimitsGroupedByOecd: type: object properties: limits: type: object additionalProperties: type: object additionalProperties: type: string format: decimal pattern: ^-?\d{0,18}(?:\.\d{0,2})?$ required: - limits description: '' ProjectsUsagesGroupedByIndustryFlag: type: object properties: usages: type: object additionalProperties: type: object additionalProperties: type: string format: decimal pattern: ^-?\d{0,18}(?:\.\d{0,2})?$ required: - usages description: '' ProjectsUsagesGroupedByOecd: type: object properties: usages: type: object additionalProperties: type: object additionalProperties: type: string format: decimal pattern: ^-?\d{0,18}(?:\.\d{0,2})?$ required: - usages description: '' Proposal: type: object description: '' properties: uuid: type: string format: uuid readOnly: true url: type: string format: uri readOnly: true name: type: string maxLength: 150 description: type: string project_name: type: string readOnly: true project_summary: type: string project_is_confidential: type: boolean project_has_civilian_purpose: type: boolean supporting_documentation: type: array items: $ref: '#/components/schemas/ProposalDocumentation' readOnly: true state: allOf: - $ref: '#/components/schemas/ProposalStates' readOnly: true approved_by: type: string format: uri readOnly: true nullable: true created_by: type: string format: uri readOnly: true nullable: true created_by_name: type: string readOnly: true created_by_uuid: type: string format: uuid readOnly: true duration_in_days: type: integer maximum: 2147483647 minimum: 0 nullable: true description: Duration in days after provisioning of resources. project: type: string format: uri readOnly: true nullable: true round: allOf: - $ref: '#/components/schemas/NestedRound' readOnly: true call_uuid: type: string format: uuid readOnly: true call_name: type: string readOnly: true call_managing_organisation_uuid: type: string format: uuid readOnly: true oecd_fos_2007_code: nullable: true oneOf: - $ref: '#/components/schemas/OecdFos2007CodeEnum' - $ref: '#/components/schemas/BlankEnum' - $ref: '#/components/schemas/NullEnum' oecd_fos_2007_label: type: string readOnly: true allocation_comment: type: string readOnly: true nullable: true created: type: string format: date-time readOnly: true compliance_status: type: object additionalProperties: {} nullable: true readOnly: true can_submit: type: object additionalProperties: {} readOnly: true required: - allocation_comment - approved_by - call_managing_organisation_uuid - call_name - call_uuid - can_submit - compliance_status - created - created_by - created_by_name - created_by_uuid - name - oecd_fos_2007_label - project - project_name - round - state - supporting_documentation - url - uuid ProposalApproveRequest: type: object properties: allocation_comment: type: string minLength: 1 description: '' ProposalDocumentation: type: object properties: file: type: string format: uri nullable: true description: Upload supporting documentation in PDF format. file_name: type: string readOnly: true file_size: type: integer readOnly: true created: type: string format: date-time readOnly: true required: - created - file_name - file_size description: '' ProposalDocumentationRequest: type: object properties: file: type: string format: binary nullable: true description: Upload supporting documentation in PDF format. description: '' ProposalProjectRoleMapping: type: object properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true call: type: string format: uri call_uuid: type: string format: uuid readOnly: true call_name: type: string readOnly: true proposal_role: type: string project_role: type: string nullable: true required: - call - call_name - call_uuid - proposal_role - url - uuid description: '' ProposalProjectRoleMappingRequest: type: object properties: call: type: string format: uri proposal_role: type: string minLength: 1 project_role: type: string minLength: 1 nullable: true required: - call - proposal_role description: '' ProposalRequest: type: object description: '' properties: name: type: string minLength: 1 maxLength: 150 description: type: string project_summary: type: string project_is_confidential: type: boolean project_has_civilian_purpose: type: boolean duration_in_days: type: integer maximum: 2147483647 minimum: 0 nullable: true description: Duration in days after provisioning of resources. round_uuid: type: string format: uuid writeOnly: true oecd_fos_2007_code: nullable: true oneOf: - $ref: '#/components/schemas/OecdFos2007CodeEnum' - $ref: '#/components/schemas/BlankEnum' - $ref: '#/components/schemas/NullEnum' required: - name - round_uuid ProposalReview: type: object description: '' properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true proposal: type: string format: uri proposal_name: type: string readOnly: true proposal_uuid: type: string format: uuid readOnly: true reviewer: type: string format: uri reviewer_full_name: type: string readOnly: true reviewer_uuid: type: string format: uuid readOnly: true anonymous_reviewer_name: type: string nullable: true description: |- Generate an anonymous reviewer identifier like 'Reviewer 1', 'Reviewer 2'. Returns None if the review is not associated with a proposal. readOnly: true state: allOf: - $ref: '#/components/schemas/ProposalReviewStateEnum' readOnly: true review_end_date: type: string format: date-time readOnly: true summary_score: type: integer maximum: 32767 minimum: 0 summary_public_comment: type: string summary_private_comment: type: string round_uuid: type: string format: uuid readOnly: true round_name: type: string readOnly: true round_cutoff_time: type: string format: date-time readOnly: true round_start_time: type: string format: date-time readOnly: true call_name: type: string readOnly: true call_uuid: type: string format: uuid readOnly: true call_managing_organisation_uuid: type: string format: uuid readOnly: true comment_project_title: type: string nullable: true maxLength: 255 comment_project_summary: type: string nullable: true maxLength: 255 comment_project_is_confidential: type: string nullable: true maxLength: 255 comment_project_has_civilian_purpose: type: string nullable: true maxLength: 255 comment_project_description: type: string nullable: true maxLength: 255 comment_project_duration: type: string nullable: true maxLength: 255 comment_project_supporting_documentation: type: string nullable: true maxLength: 255 comment_resource_requests: type: string nullable: true maxLength: 255 comment_team: type: string nullable: true maxLength: 255 required: - anonymous_reviewer_name - call_managing_organisation_uuid - call_name - call_uuid - proposal - proposal_name - proposal_uuid - review_end_date - reviewer - reviewer_full_name - reviewer_uuid - round_cutoff_time - round_name - round_start_time - round_uuid - state - url - uuid ProposalReviewRequest: type: object description: '' properties: proposal: type: string format: uri reviewer: type: string format: uri summary_score: type: integer maximum: 32767 minimum: 0 summary_public_comment: type: string summary_private_comment: type: string comment_project_title: type: string nullable: true maxLength: 255 comment_project_summary: type: string nullable: true maxLength: 255 comment_project_is_confidential: type: string nullable: true maxLength: 255 comment_project_has_civilian_purpose: type: string nullable: true maxLength: 255 comment_project_description: type: string nullable: true maxLength: 255 comment_project_duration: type: string nullable: true maxLength: 255 comment_project_supporting_documentation: type: string nullable: true maxLength: 255 comment_resource_requests: type: string nullable: true maxLength: 255 comment_team: type: string nullable: true maxLength: 255 required: - proposal - reviewer ProposalReviewStateEnum: enum: - created - in_review - submitted - rejected type: string description: '' ProposalStates: enum: - draft - submitted - in_review - accepted - rejected - canceled type: string description: '' ProposalUpdateProjectDetailsRequest: type: object properties: name: type: string minLength: 1 maxLength: 150 description: type: string maxLength: 2000 project_summary: type: string project_is_confidential: type: boolean project_has_civilian_purpose: type: boolean duration_in_days: type: integer maximum: 2147483647 minimum: 0 nullable: true description: Duration in days after provisioning of resources. oecd_fos_2007_code: nullable: true oneOf: - $ref: '#/components/schemas/OecdFos2007CodeEnum' - $ref: '#/components/schemas/BlankEnum' - $ref: '#/components/schemas/NullEnum' required: - name description: '' ProtectedCall: type: object description: '' properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true created: type: string format: date-time readOnly: true start_date: type: string format: date-time readOnly: true end_date: type: string format: date-time readOnly: true slug: type: string maxLength: 50 pattern: ^[-a-zA-Z0-9_]+$ name: type: string maxLength: 150 description: type: string state: allOf: - $ref: '#/components/schemas/CallStates' readOnly: true manager: type: string format: uri manager_uuid: type: string format: uuid readOnly: true customer_name: type: string readOnly: true customer_uuid: type: string format: uuid readOnly: true offerings: type: array items: $ref: '#/components/schemas/NestedRequestedOffering' readOnly: true rounds: type: array items: $ref: '#/components/schemas/NestedRound' readOnly: true documents: type: array items: $ref: '#/components/schemas/CallDocument' readOnly: true resource_templates: type: array items: $ref: '#/components/schemas/CallResourceTemplate' readOnly: true fixed_duration_in_days: type: integer nullable: true backend_id: type: string maxLength: 255 external_url: type: string format: uri nullable: true maxLength: 200 reviewer_identity_visible_to_submitters: type: boolean description: Whether proposal submitters can see reviewer identities reviews_visible_to_submitters: type: boolean description: Whether proposal submitters can see review comments and scores created_by: type: string format: uri nullable: true reference_code: type: string compliance_checklist: type: string format: uuid nullable: true description: Compliance checklist that proposals must complete before submission compliance_checklist_name: type: string readOnly: true required: [] ProtectedCallRequest: type: object description: '' properties: name: type: string minLength: 1 maxLength: 150 description: type: string manager: type: string format: uri fixed_duration_in_days: type: integer nullable: true backend_id: type: string maxLength: 255 external_url: type: string format: uri nullable: true maxLength: 200 reviewer_identity_visible_to_submitters: type: boolean description: Whether proposal submitters can see reviewer identities reviews_visible_to_submitters: type: boolean description: Whether proposal submitters can see review comments and scores created_by: type: string format: uri nullable: true reference_code: type: string minLength: 1 compliance_checklist: type: string format: uuid nullable: true description: Compliance checklist that proposals must complete before submission required: - manager - name ProtectedProposalList: type: object properties: uuid: type: string format: uuid readOnly: true name: type: string maxLength: 150 state: allOf: - $ref: '#/components/schemas/ProposalStates' readOnly: true reviews: type: array items: {} description: |- Return serialized reviews based on user permissions and visibility settings. - Staff, call managers, and reviewers see all reviews. - Submitters see submitted reviews if visibility is enabled. readOnly: true approved_by_name: type: string readOnly: true created_by_name: type: string readOnly: true created: type: string format: date-time readOnly: true required: - approved_by_name - created - created_by_name - name - reviews - state - uuid description: '' ProtectedProposalListRequest: type: object properties: name: type: string minLength: 1 maxLength: 150 required: - name description: '' ProtectedRound: type: object description: '' properties: uuid: type: string format: uuid readOnly: true name: type: string readOnly: true start_time: type: string format: date-time cutoff_time: type: string format: date-time status: allOf: - $ref: '#/components/schemas/StatusEnum' readOnly: true review_strategy: $ref: '#/components/schemas/ReviewStrategyEnum' deciding_entity: $ref: '#/components/schemas/DecidingEntityEnum' allocation_time: $ref: '#/components/schemas/AllocationTimeEnum' allocation_date: type: string format: date-time nullable: true minimal_average_scoring: type: string format: decimal pattern: ^-?\d{0,4}(?:\.\d{0,1})?$ nullable: true review_duration_in_days: type: integer default: 7 minimum_number_of_reviewers: type: integer maximum: 2147483647 minimum: 0 nullable: true url: type: string readOnly: true proposals: type: array items: $ref: '#/components/schemas/ProtectedProposalList' readOnly: true required: - cutoff_time - name - proposals - start_time - status - url - uuid ProtectedRoundRequest: type: object description: '' properties: start_time: type: string format: date-time cutoff_time: type: string format: date-time review_strategy: $ref: '#/components/schemas/ReviewStrategyEnum' deciding_entity: $ref: '#/components/schemas/DecidingEntityEnum' allocation_time: $ref: '#/components/schemas/AllocationTimeEnum' allocation_date: type: string format: date-time nullable: true minimal_average_scoring: type: string format: decimal pattern: ^-?\d{0,4}(?:\.\d{0,1})?$ nullable: true review_duration_in_days: type: integer default: 7 minimum_number_of_reviewers: type: integer maximum: 2147483647 minimum: 0 nullable: true required: - cutoff_time - start_time ProtocolEnum: enum: - tcp - udp - icmp type: string description: '' ProviderOffering: type: object description: '' properties: uuid: type: string format: uuid readOnly: true customer_uuid: type: string format: uuid readOnly: true name: type: string maxLength: 150 slug: type: string maxLength: 50 pattern: ^[-a-zA-Z0-9_]+$ category_title: type: string readOnly: true type: type: string maxLength: 100 state: allOf: - $ref: '#/components/schemas/OfferingState' readOnly: true resources_count: type: integer readOnly: true billing_price_estimate: allOf: - $ref: '#/components/schemas/NestedPriceEstimate' readOnly: true components: type: array items: $ref: '#/components/schemas/OfferingComponent' plans: type: array items: $ref: '#/components/schemas/BaseProviderPlan' options: description: Fields describing resource provision form. resource_options: description: Fields describing resource report form. secret_options: allOf: - $ref: '#/components/schemas/MergedSecretOptions' readOnly: true required: [] ProviderOfferingCosts: type: object properties: period: type: string readOnly: true price: type: number format: double readOnly: true tax: type: number format: double readOnly: true total: type: number format: double readOnly: true required: - period - price - tax - total description: '' ProviderOfferingCustomer: type: object description: '' properties: uuid: type: string format: uuid readOnly: true name: type: string maxLength: 150 slug: type: string maxLength: 50 pattern: ^[-a-zA-Z0-9_]+$ abbreviation: type: string maxLength: 12 phone_number: type: string maxLength: 255 email: type: string format: email title: Email address maxLength: 75 required: - name - slug - uuid ProviderOfferingDetails: type: object description: '' properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true created: type: string format: date-time readOnly: true name: type: string maxLength: 150 slug: type: string maxLength: 50 pattern: ^[-a-zA-Z0-9_]+$ description: type: string maxLength: 2000 full_description: type: string privacy_policy_link: type: string format: uri maxLength: 200 access_url: type: string format: uri description: Publicly accessible offering access URL maxLength: 200 endpoints: type: array items: $ref: '#/components/schemas/NestedEndpoint' readOnly: true roles: type: array items: $ref: '#/components/schemas/NestedRole' readOnly: true customer: type: string format: uri nullable: true customer_uuid: type: string format: uuid readOnly: true nullable: true customer_name: type: string readOnly: true nullable: true project: type: string format: uri readOnly: true nullable: true project_uuid: type: string format: uuid readOnly: true nullable: true project_name: type: string readOnly: true nullable: true category: type: string format: uri category_uuid: type: string format: uuid readOnly: true category_title: type: string readOnly: true attributes: type: object additionalProperties: {} readOnly: true options: allOf: - $ref: '#/components/schemas/OfferingOptions' readOnly: true resource_options: allOf: - $ref: '#/components/schemas/OfferingOptions' readOnly: true components: type: array items: $ref: '#/components/schemas/OfferingComponent' readOnly: true plugin_options: allOf: - $ref: '#/components/schemas/MergedPluginOptions' readOnly: true secret_options: allOf: - $ref: '#/components/schemas/MergedSecretOptions' readOnly: true service_attributes: type: object additionalProperties: {} readOnly: true state: allOf: - $ref: '#/components/schemas/OfferingState' readOnly: true vendor_details: type: string getting_started: type: string integration_guide: type: string thumbnail: type: string format: uri nullable: true order_count: type: integer readOnly: true plans: type: array items: $ref: '#/components/schemas/BaseProviderPlan' readOnly: true screenshots: type: array items: $ref: '#/components/schemas/NestedScreenshot' readOnly: true type: type: string maxLength: 100 shared: type: boolean description: Accessible to all customers. billable: type: boolean description: Purchase and usage is invoiced. scope: type: string readOnly: true scope_uuid: type: string format: uuid readOnly: true nullable: true scope_name: type: string format: uuid readOnly: true nullable: true scope_state: allOf: - $ref: '#/components/schemas/CoreStates' nullable: true readOnly: true scope_error_message: type: string nullable: true readOnly: true files: type: array items: $ref: '#/components/schemas/NestedOfferingFile' readOnly: true quotas: type: array items: $ref: '#/components/schemas/Quota' readOnly: true paused_reason: type: string readOnly: true datacite_doi: type: string maxLength: 255 citation_count: type: integer readOnly: true description: Number of citations of a DOI latitude: type: number format: double nullable: true longitude: type: number format: double nullable: true country: oneOf: - $ref: '#/components/schemas/CountryEnum' - $ref: '#/components/schemas/BlankEnum' backend_id: type: string maxLength: 255 organization_groups: type: array items: $ref: '#/components/schemas/OrganizationGroup' readOnly: true image: type: string format: uri nullable: true total_customers: type: integer nullable: true readOnly: true total_cost: type: integer nullable: true readOnly: true total_cost_estimated: type: integer nullable: true readOnly: true parent_description: type: string readOnly: true nullable: true parent_uuid: type: string format: uuid readOnly: true nullable: true parent_name: type: string readOnly: true nullable: true backend_metadata: {} has_compliance_requirements: type: boolean readOnly: true integration_status: type: array items: $ref: '#/components/schemas/IntegrationStatus' nullable: true readOnly: true google_calendar_is_public: type: boolean nullable: true readOnly: true google_calendar_link: type: string nullable: true description: Get the Google Calendar link for an offering. readOnly: true required: [] ProviderOfferingDetailsRequest: type: object description: '' properties: name: type: string minLength: 1 maxLength: 150 description: type: string maxLength: 2000 full_description: type: string privacy_policy_link: type: string format: uri maxLength: 200 access_url: type: string format: uri description: Publicly accessible offering access URL maxLength: 200 customer: type: string format: uri nullable: true category: type: string format: uri attributes: {} components: type: array items: $ref: '#/components/schemas/OfferingComponentRequest' vendor_details: type: string getting_started: type: string integration_guide: type: string thumbnail: type: string format: binary nullable: true plans: type: array items: $ref: '#/components/schemas/BaseProviderPlanRequest' type: type: string minLength: 1 maxLength: 100 shared: type: boolean description: Accessible to all customers. billable: type: boolean description: Purchase and usage is invoiced. datacite_doi: type: string maxLength: 255 latitude: type: number format: double nullable: true longitude: type: number format: double nullable: true country: oneOf: - $ref: '#/components/schemas/CountryEnum' - $ref: '#/components/schemas/BlankEnum' backend_id: type: string maxLength: 255 image: type: string format: binary nullable: true backend_metadata: {} required: - category - name - type ProviderPlanDetails: type: object description: '' properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true name: type: string maxLength: 150 description: type: string article_code: type: string maxLength: 30 max_amount: type: integer maximum: 32767 minimum: 1 nullable: true description: Maximum number of plans that could be active. Plan is disabled when maximum amount is reached. archived: type: boolean description: Forbids creation of new resources. is_active: type: boolean readOnly: true unit_price: type: string format: decimal pattern: ^-?\d{0,12}(?:\.\d{0,10})?$ unit: $ref: '#/components/schemas/BillingUnit' init_price: type: number format: double readOnly: true switch_price: type: number format: double readOnly: true backend_id: type: string maxLength: 255 organization_groups: type: array items: $ref: '#/components/schemas/OrganizationGroup' readOnly: true offering: type: string format: uri prices: type: object additionalProperties: type: number format: double readOnly: true future_prices: type: object additionalProperties: type: number format: double readOnly: true quotas: type: object additionalProperties: type: number format: double readOnly: true resources_count: type: integer readOnly: true plan_type: type: string readOnly: true minimal_price: type: number format: double readOnly: true required: - future_prices - init_price - is_active - minimal_price - name - offering - organization_groups - plan_type - prices - quotas - resources_count - switch_price - url - uuid ProviderPlanDetailsRequest: type: object description: '' properties: name: type: string minLength: 1 maxLength: 150 description: type: string article_code: type: string maxLength: 30 max_amount: type: integer maximum: 32767 minimum: 1 nullable: true description: Maximum number of plans that could be active. Plan is disabled when maximum amount is reached. archived: type: boolean description: Forbids creation of new resources. unit_price: type: string format: decimal pattern: ^-?\d{0,12}(?:\.\d{0,10})?$ unit: $ref: '#/components/schemas/BillingUnit' backend_id: type: string maxLength: 255 offering: type: string format: uri required: - name - offering ProviderProject: type: object properties: uuid: type: string format: uuid readOnly: true name: type: string maxLength: 500 image: type: string format: uri nullable: true required: [] description: '' ProviderRequestedOffering: type: object properties: uuid: type: string format: uuid readOnly: true state: allOf: - $ref: '#/components/schemas/RequestedOfferingStates' readOnly: true offering: type: string format: uri offering_name: type: string readOnly: true offering_uuid: type: string format: uuid readOnly: true provider_name: type: string readOnly: true category_uuid: type: string format: uuid readOnly: true category_name: type: string readOnly: true call_managing_organisation: type: string readOnly: true attributes: {} plan: type: string format: uri readOnly: true nullable: true plan_details: allOf: - $ref: '#/components/schemas/BasePublicPlan' readOnly: true options: allOf: - $ref: '#/components/schemas/OfferingOptions' readOnly: true components: type: array items: $ref: '#/components/schemas/OfferingComponent' readOnly: true created: type: string format: date-time readOnly: true url: type: string format: uri readOnly: true call_name: type: string readOnly: true call: type: string format: uri description: type: string readOnly: true created_by_name: type: string readOnly: true created_by_email: type: string format: email title: Email address readOnly: true required: - call - call_managing_organisation - call_name - category_name - category_uuid - components - created - created_by_email - created_by_name - description - offering - offering_name - offering_uuid - options - plan - plan_details - provider_name - state - url - uuid description: '' ProviderRequestedResource: type: object properties: uuid: type: string format: uuid readOnly: true url: type: string readOnly: true requested_offering: allOf: - $ref: '#/components/schemas/NestedRequestedOffering' readOnly: true resource: type: string format: uri nullable: true resource_name: type: string readOnly: true call_resource_template: type: string readOnly: true call_resource_template_name: type: string readOnly: true attributes: {} limits: {} description: type: string maxLength: 2000 created_by: type: string format: uri nullable: true created_by_name: type: string readOnly: true proposal_name: type: string readOnly: true proposal: type: string format: uri required: - call_resource_template - call_resource_template_name - created_by_name - proposal - proposal_name - requested_offering - resource_name - url - uuid description: '' ProviderUser: type: object properties: uuid: type: string format: uuid readOnly: true full_name: type: string readOnly: true email: type: string format: email title: Email address maxLength: 320 image: type: string format: uri nullable: true required: [] description: '' PublicCall: type: object description: '' properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true created: type: string format: date-time readOnly: true start_date: type: string format: date-time readOnly: true end_date: type: string format: date-time readOnly: true slug: type: string maxLength: 50 pattern: ^[-a-zA-Z0-9_]+$ name: type: string maxLength: 150 description: type: string state: allOf: - $ref: '#/components/schemas/CallStates' readOnly: true manager: type: string format: uri manager_uuid: type: string format: uuid readOnly: true customer_name: type: string readOnly: true customer_uuid: type: string format: uuid readOnly: true offerings: type: array items: $ref: '#/components/schemas/NestedRequestedOffering' readOnly: true rounds: type: array items: $ref: '#/components/schemas/NestedRound' readOnly: true documents: type: array items: $ref: '#/components/schemas/CallDocument' readOnly: true resource_templates: type: array items: $ref: '#/components/schemas/CallResourceTemplate' readOnly: true fixed_duration_in_days: type: integer maximum: 2147483647 minimum: 0 nullable: true description: Fixed duration in days that applies to all proposals in this call readOnly: true backend_id: type: string maxLength: 255 external_url: type: string format: uri nullable: true maxLength: 200 reviewer_identity_visible_to_submitters: type: boolean description: Whether proposal submitters can see reviewer identities. If False, reviewers appear as 'Reviewer 1', 'Reviewer 2', etc. reviews_visible_to_submitters: type: boolean description: Whether proposal submitters can see review comments and scores. If False, submitters only see final approval/rejection status. required: [] PublicMaintenanceAnnouncement: type: object properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true name: type: string readOnly: true message: type: string readOnly: true maintenance_type: allOf: - $ref: '#/components/schemas/MaintenanceTypeEnum' readOnly: true description: Type of maintenance being performed maintenance_type_display: type: string readOnly: true external_reference_url: type: string format: uri readOnly: true description: Optional reference to an external maintenance tracker state: allOf: - $ref: '#/components/schemas/PublicMaintenanceAnnouncementStateEnum' readOnly: true scheduled_start: type: string format: date-time readOnly: true description: When the maintenance is scheduled to begin scheduled_end: type: string format: date-time readOnly: true description: When the maintenance is scheduled to complete actual_start: type: string format: date-time readOnly: true nullable: true description: When the maintenance actually began actual_end: type: string format: date-time readOnly: true nullable: true description: When the maintenance actually completed affected_offerings: type: array items: $ref: '#/components/schemas/MaintenanceAnnouncementOffering' readOnly: true service_provider_name: type: string readOnly: true required: - actual_end - actual_start - affected_offerings - external_reference_url - maintenance_type - maintenance_type_display - message - name - scheduled_end - scheduled_start - service_provider_name - state - url - uuid description: '' PublicMaintenanceAnnouncementStateEnum: enum: - Scheduled - In progress - Completed type: string description: '' PublicOfferingDetails: type: object description: '' properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true created: type: string format: date-time readOnly: true name: type: string maxLength: 150 slug: type: string readOnly: true maxLength: 50 pattern: ^[-a-zA-Z0-9_]+$ description: type: string maxLength: 2000 full_description: type: string privacy_policy_link: type: string format: uri maxLength: 200 access_url: type: string format: uri description: Publicly accessible offering access URL maxLength: 200 endpoints: type: array items: $ref: '#/components/schemas/NestedEndpoint' readOnly: true roles: type: array items: $ref: '#/components/schemas/NestedRole' readOnly: true customer: type: string format: uri nullable: true customer_uuid: type: string format: uuid readOnly: true nullable: true customer_name: type: string readOnly: true nullable: true project: type: string format: uri readOnly: true nullable: true project_uuid: type: string format: uuid readOnly: true nullable: true project_name: type: string readOnly: true nullable: true category: type: string format: uri category_uuid: type: string format: uuid readOnly: true category_title: type: string readOnly: true attributes: type: object additionalProperties: {} readOnly: true options: allOf: - $ref: '#/components/schemas/OfferingOptions' readOnly: true resource_options: allOf: - $ref: '#/components/schemas/OfferingOptions' readOnly: true components: type: array items: $ref: '#/components/schemas/OfferingComponent' readOnly: true plugin_options: allOf: - $ref: '#/components/schemas/MergedPluginOptions' readOnly: true state: allOf: - $ref: '#/components/schemas/OfferingState' readOnly: true vendor_details: type: string getting_started: type: string integration_guide: type: string thumbnail: type: string format: uri nullable: true order_count: type: integer readOnly: true plans: type: array items: $ref: '#/components/schemas/BasePublicPlan' readOnly: true screenshots: type: array items: $ref: '#/components/schemas/NestedScreenshot' readOnly: true type: type: string maxLength: 100 shared: type: boolean description: Accessible to all customers. billable: type: boolean description: Purchase and usage is invoiced. scope: type: string readOnly: true scope_uuid: type: string format: uuid readOnly: true nullable: true scope_name: type: string format: uuid readOnly: true nullable: true scope_state: allOf: - $ref: '#/components/schemas/CoreStates' nullable: true readOnly: true scope_error_message: type: string nullable: true readOnly: true files: type: array items: $ref: '#/components/schemas/NestedOfferingFile' readOnly: true quotas: type: array items: $ref: '#/components/schemas/Quota' readOnly: true paused_reason: type: string readOnly: true datacite_doi: type: string maxLength: 255 citation_count: type: integer readOnly: true description: Number of citations of a DOI latitude: type: number format: double nullable: true longitude: type: number format: double nullable: true country: oneOf: - $ref: '#/components/schemas/CountryEnum' - $ref: '#/components/schemas/BlankEnum' backend_id: type: string maxLength: 255 organization_groups: type: array items: $ref: '#/components/schemas/OrganizationGroup' readOnly: true image: type: string format: uri nullable: true total_customers: type: integer nullable: true readOnly: true total_cost: type: integer nullable: true readOnly: true total_cost_estimated: type: integer nullable: true readOnly: true parent_description: type: string readOnly: true nullable: true parent_uuid: type: string format: uuid readOnly: true nullable: true parent_name: type: string readOnly: true nullable: true backend_metadata: {} has_compliance_requirements: type: boolean readOnly: true google_calendar_is_public: type: boolean nullable: true readOnly: true google_calendar_link: type: string nullable: true description: Get the Google Calendar link for an offering. readOnly: true promotion_campaigns: type: array items: $ref: '#/components/schemas/NestedCampaign' readOnly: true required: [] PullMarketplaceScriptResourceRequest: type: object properties: resource_uuid: type: string format: uuid required: - resource_uuid description: '' QueryRequest: type: object properties: query: type: string minLength: 1 required: - query description: '' QuestionAdmin: type: object description: '' properties: uuid: type: string format: uuid readOnly: true description: type: string maxLength: 2000 user_guidance: type: string description: Additional guidance text visible to users when answering and reviewing question_options: type: array items: $ref: '#/components/schemas/QuestionOptionsAdmin' readOnly: true url: type: string format: uri readOnly: true checklist_name: type: string readOnly: true checklist_uuid: type: string format: uuid readOnly: true checklist: type: string format: uri order: type: integer maximum: 2147483647 minimum: 0 required: type: boolean question_type: allOf: - $ref: '#/components/schemas/QuestionTypeEnum' description: Type of question and expected answer format operator: oneOf: - $ref: '#/components/schemas/ChecklistOperators' - $ref: '#/components/schemas/BlankEnum' review_answer_value: nullable: true description: Answer value that trigger review. always_requires_review: type: boolean description: This question always requires review regardless of answer guidance_answer_value: nullable: true description: Answer value that triggers display of user guidance. guidance_operator: description: Operator to use when comparing answer with guidance_answer_value oneOf: - $ref: '#/components/schemas/ChecklistOperators' - $ref: '#/components/schemas/BlankEnum' always_show_guidance: type: boolean description: Show user guidance always, regardless of answer. If False, guidance is conditional on answer matching guidance_answer_value with guidance_operator min_value: type: string format: decimal pattern: ^-?\d{0,16}(?:\.\d{0,4})?$ nullable: true description: Minimum value allowed for NUMBER type questions max_value: type: string format: decimal pattern: ^-?\d{0,16}(?:\.\d{0,4})?$ nullable: true description: Maximum value allowed for NUMBER type questions dependency_logic_operator: allOf: - $ref: '#/components/schemas/DependencyLogicOperatorEnum' description: 'Defines how multiple dependencies are evaluated. AND: All dependencies must be satisfied. OR: At least one dependency must be satisfied.' required: - checklist - checklist_name - checklist_uuid - question_options - url - uuid QuestionAdminRequest: type: object description: '' properties: description: type: string maxLength: 2000 user_guidance: type: string description: Additional guidance text visible to users when answering and reviewing checklist: type: string format: uri order: type: integer maximum: 2147483647 minimum: 0 required: type: boolean question_type: allOf: - $ref: '#/components/schemas/QuestionTypeEnum' description: Type of question and expected answer format operator: oneOf: - $ref: '#/components/schemas/ChecklistOperators' - $ref: '#/components/schemas/BlankEnum' review_answer_value: nullable: true description: Answer value that trigger review. always_requires_review: type: boolean description: This question always requires review regardless of answer guidance_answer_value: nullable: true description: Answer value that triggers display of user guidance. guidance_operator: description: Operator to use when comparing answer with guidance_answer_value oneOf: - $ref: '#/components/schemas/ChecklistOperators' - $ref: '#/components/schemas/BlankEnum' always_show_guidance: type: boolean description: Show user guidance always, regardless of answer. If False, guidance is conditional on answer matching guidance_answer_value with guidance_operator min_value: type: string format: decimal pattern: ^-?\d{0,16}(?:\.\d{0,4})?$ nullable: true description: Minimum value allowed for NUMBER type questions max_value: type: string format: decimal pattern: ^-?\d{0,16}(?:\.\d{0,4})?$ nullable: true description: Maximum value allowed for NUMBER type questions dependency_logic_operator: allOf: - $ref: '#/components/schemas/DependencyLogicOperatorEnum' description: 'Defines how multiple dependencies are evaluated. AND: All dependencies must be satisfied. OR: At least one dependency must be satisfied.' required: - checklist QuestionAnswer: type: object description: '' properties: question_uuid: type: string format: uuid readOnly: true question_description: type: string readOnly: true question_type: type: string readOnly: true required: type: boolean readOnly: true order: type: integer readOnly: true min_value: type: string format: decimal pattern: ^-?\d{0,16}(?:\.\d{0,4})?$ readOnly: true nullable: true max_value: type: string format: decimal pattern: ^-?\d{0,16}(?:\.\d{0,4})?$ readOnly: true nullable: true total_projects: type: integer description: Get total projects count. readOnly: true answered_projects_count: type: integer description: Get count of projects that answered this question. readOnly: true project_answers: type: array items: type: object additionalProperties: {} description: Get all project answers for this question. readOnly: true question_options: type: array items: type: object additionalProperties: {} description: Get question options for select-type questions. readOnly: true required: - answered_projects_count - max_value - min_value - order - project_answers - question_description - question_options - question_type - question_uuid - required - total_projects QuestionDependency: type: object description: '' properties: uuid: type: string format: uuid readOnly: true url: type: string format: uri readOnly: true question: type: string format: uri question_name: type: string readOnly: true depends_on_question: type: string format: uri depends_on_question_name: type: string readOnly: true required_answer_value: description: The answer value(s) that make this question visible operator: $ref: '#/components/schemas/ChecklistOperators' required: - depends_on_question - depends_on_question_name - question - question_name - required_answer_value - url - uuid QuestionDependencyRequest: type: object description: '' properties: question: type: string format: uri depends_on_question: type: string format: uri required_answer_value: description: The answer value(s) that make this question visible operator: $ref: '#/components/schemas/ChecklistOperators' required: - depends_on_question - question - required_answer_value QuestionOptionsAdmin: type: object description: '' properties: uuid: type: string format: uuid readOnly: true label: type: string maxLength: 255 order: type: integer maximum: 2147483647 minimum: 0 url: type: string format: uri readOnly: true question: type: string format: uri question_uuid: type: string format: uuid readOnly: true required: - label - question - question_uuid - url - uuid QuestionOptionsAdminRequest: type: object description: '' properties: label: type: string minLength: 1 maxLength: 255 order: type: integer maximum: 2147483647 minimum: 0 question: type: string format: uri required: - label - question QuestionTypeEnum: enum: - boolean - single_select - multi_select - text_input - text_area - number - date - file type: string description: '' QuestionWithAnswer: type: object description: '' properties: uuid: type: string format: uuid readOnly: true description: type: string readOnly: true user_guidance: type: string nullable: true readOnly: true question_type: allOf: - $ref: '#/components/schemas/QuestionTypeEnum' readOnly: true description: Type of question and expected answer format required: type: boolean readOnly: true order: type: integer readOnly: true existing_answer: type: object additionalProperties: {} nullable: true readOnly: true question_options: type: array items: {} nullable: true readOnly: true min_value: type: string format: decimal pattern: ^-?\d{0,16}(?:\.\d{0,4})?$ readOnly: true nullable: true description: Minimum value allowed for NUMBER type questions max_value: type: string format: decimal pattern: ^-?\d{0,16}(?:\.\d{0,4})?$ readOnly: true nullable: true description: Maximum value allowed for NUMBER type questions required: - description - existing_answer - max_value - min_value - order - question_options - question_type - required - user_guidance - uuid QuestionWithAnswerReviewer: type: object description: '' properties: uuid: type: string format: uuid readOnly: true description: type: string readOnly: true user_guidance: type: string nullable: true readOnly: true question_type: allOf: - $ref: '#/components/schemas/QuestionTypeEnum' readOnly: true description: Type of question and expected answer format required: type: boolean readOnly: true order: type: integer readOnly: true existing_answer: type: object additionalProperties: {} nullable: true readOnly: true question_options: type: array items: {} nullable: true readOnly: true min_value: type: string format: decimal pattern: ^-?\d{0,16}(?:\.\d{0,4})?$ readOnly: true nullable: true description: Minimum value allowed for NUMBER type questions max_value: type: string format: decimal pattern: ^-?\d{0,16}(?:\.\d{0,4})?$ readOnly: true nullable: true description: Maximum value allowed for NUMBER type questions operator: oneOf: - $ref: '#/components/schemas/ChecklistOperators' - $ref: '#/components/schemas/BlankEnum' review_answer_value: nullable: true description: Answer value that trigger review. always_requires_review: type: boolean description: This question always requires review regardless of answer required: - description - existing_answer - max_value - min_value - order - question_options - question_type - required - user_guidance - uuid Quota: type: object properties: name: type: string usage: type: integer limit: type: integer required: [] description: '' QuotaRequest: type: object properties: name: type: string minLength: 1 usage: type: integer limit: type: integer required: - limit - name - usage description: '' QuotasUpdateRequest: type: object properties: quotas: type: object additionalProperties: type: integer minimum: 0 required: - quotas description: '' RancherApplication: type: object description: '' properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true name: type: string maxLength: 150 description: type: string maxLength: 2000 service_name: type: string readOnly: true service_settings: type: string format: uri service_settings_uuid: type: string format: uuid readOnly: true service_settings_state: type: string readOnly: true service_settings_error_message: type: string readOnly: true project: type: string format: uri project_name: type: string readOnly: true project_uuid: type: string format: uuid readOnly: true customer: type: string format: uri readOnly: true customer_name: type: string readOnly: true customer_native_name: type: string readOnly: true customer_abbreviation: type: string readOnly: true error_message: type: string error_traceback: type: string resource_type: type: string readOnly: true state: allOf: - $ref: '#/components/schemas/CoreStates' readOnly: true created: type: string format: date-time readOnly: true modified: type: string format: date-time readOnly: true backend_id: type: string maxLength: 255 access_url: type: string nullable: true readOnly: true runtime_state: type: string maxLength: 150 template: type: string format: uri rancher_project: type: string format: uri namespace: type: string format: uri version: type: string answers: type: object additionalProperties: {} rancher_project_name: type: string readOnly: true catalog_name: type: string readOnly: true template_name: type: string readOnly: true external_url: type: string nullable: true readOnly: true marketplace_offering_uuid: type: string nullable: true readOnly: true marketplace_offering_name: type: string nullable: true readOnly: true marketplace_offering_plugin_options: type: object additionalProperties: {} nullable: true readOnly: true marketplace_category_uuid: type: string nullable: true readOnly: true marketplace_category_name: type: string nullable: true readOnly: true marketplace_resource_uuid: type: string nullable: true readOnly: true marketplace_plan_uuid: type: string nullable: true readOnly: true marketplace_resource_state: type: string nullable: true readOnly: true is_usage_based: type: boolean nullable: true readOnly: true is_limit_based: type: boolean nullable: true readOnly: true required: [] RancherApplicationRequest: type: object description: '' properties: name: type: string minLength: 1 maxLength: 150 description: type: string maxLength: 2000 service_settings: type: string format: uri project: type: string format: uri error_message: type: string error_traceback: type: string backend_id: type: string maxLength: 255 runtime_state: type: string maxLength: 150 template: type: string format: uri rancher_project: type: string format: uri namespace: type: string format: uri namespace_name: type: string writeOnly: true minLength: 1 version: type: string minLength: 1 answers: type: object additionalProperties: {} required: - name - project - rancher_project - service_settings - template - version RancherCatalog: type: object properties: uuid: type: string format: uuid readOnly: true url: type: string format: uri readOnly: true created: type: string format: date-time readOnly: true modified: type: string format: date-time readOnly: true name: type: string maxLength: 150 description: type: string maxLength: 2000 catalog_url: type: string format: uri maxLength: 200 branch: type: string maxLength: 255 commit: type: string readOnly: true runtime_state: type: string readOnly: true scope: type: string scope_type: allOf: - $ref: '#/components/schemas/RancherCatalogScopeType' readOnly: true required: - branch - catalog_url - commit - created - modified - name - runtime_state - scope - scope_type - url - uuid description: '' RancherCatalogCreate: type: object properties: uuid: type: string format: uuid readOnly: true url: type: string format: uri readOnly: true created: type: string format: date-time readOnly: true modified: type: string format: date-time readOnly: true name: type: string maxLength: 150 description: type: string maxLength: 2000 catalog_url: type: string format: uri maxLength: 200 branch: type: string maxLength: 255 commit: type: string readOnly: true runtime_state: type: string readOnly: true scope: type: string scope_type: allOf: - $ref: '#/components/schemas/RancherCatalogScopeType' readOnly: true username: type: string maxLength: 255 password: type: string maxLength: 255 required: - branch - catalog_url - commit - created - modified - name - runtime_state - scope - scope_type - url - uuid description: '' RancherCatalogCreateRequest: type: object properties: name: type: string minLength: 1 maxLength: 150 description: type: string maxLength: 2000 catalog_url: type: string format: uri minLength: 1 maxLength: 200 branch: type: string minLength: 1 maxLength: 255 scope: type: string username: type: string maxLength: 255 password: type: string maxLength: 255 required: - branch - catalog_url - name - scope description: '' RancherCatalogRequest: type: object properties: name: type: string minLength: 1 maxLength: 150 description: type: string maxLength: 2000 catalog_url: type: string format: uri minLength: 1 maxLength: 200 branch: type: string minLength: 1 maxLength: 255 scope: type: string required: - branch - catalog_url - name - scope description: '' RancherCatalogScopeType: enum: - global - cluster - project type: string description: '' RancherCatalogUpdate: type: object properties: uuid: type: string format: uuid readOnly: true url: type: string format: uri readOnly: true created: type: string format: date-time readOnly: true modified: type: string format: date-time readOnly: true name: type: string maxLength: 150 description: type: string maxLength: 2000 catalog_url: type: string format: uri maxLength: 200 branch: type: string maxLength: 255 commit: type: string readOnly: true runtime_state: type: string readOnly: true scope: type: string scope_type: allOf: - $ref: '#/components/schemas/RancherCatalogScopeType' readOnly: true required: - branch - catalog_url - commit - created - modified - name - runtime_state - scope - scope_type - url - uuid description: '' RancherCatalogUpdateRequest: type: object properties: name: type: string minLength: 1 maxLength: 150 description: type: string maxLength: 2000 catalog_url: type: string format: uri minLength: 1 maxLength: 200 branch: type: string minLength: 1 maxLength: 255 scope: type: string required: - branch - catalog_url - name - scope description: '' RancherCluster: type: object description: '' properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true name: type: string pattern: ^[a-z0-9]([-a-z0-9])+[a-z0-9]$ maxLength: 150 description: type: string maxLength: 2000 service_name: type: string readOnly: true service_settings: type: string format: uri service_settings_uuid: type: string format: uuid readOnly: true service_settings_state: type: string readOnly: true service_settings_error_message: type: string readOnly: true project: type: string format: uri project_name: type: string readOnly: true project_uuid: type: string format: uuid readOnly: true customer: type: string format: uri readOnly: true customer_name: type: string readOnly: true customer_native_name: type: string readOnly: true customer_abbreviation: type: string readOnly: true error_message: type: string readOnly: true error_traceback: type: string readOnly: true resource_type: type: string readOnly: true state: allOf: - $ref: '#/components/schemas/CoreStates' readOnly: true created: type: string format: date-time readOnly: true modified: type: string format: date-time readOnly: true backend_id: type: string readOnly: true access_url: type: string nullable: true readOnly: true nodes: type: array items: $ref: '#/components/schemas/RancherNestedNode' tenant: type: string format: uri tenant_uuid: type: string format: uuid readOnly: true vm_project: type: string format: uri nullable: true runtime_state: type: string readOnly: true install_longhorn: type: boolean default: false description: Longhorn is a distributed block storage deployed on top of Kubernetes cluster management_security_group: type: string format: uri readOnly: true public_ips: type: array items: $ref: '#/components/schemas/RancherNestedPublicIP' readOnly: true capacity: readOnly: true description: 'Cluster capacity in the format {''cpu'': ''10'', ''ram'': ''49125240Ki'', ''pods'': ''330''}' requested: readOnly: true description: 'Cluster requested resources in the format {''cpu'': ''1450m'', ''memory'': ''884Mi'', ''pods'': ''13''}' kubernetes_version: type: string readOnly: true description: Kubernetes version used in the cluster. router_ips: type: array items: {} readOnly: true marketplace_offering_uuid: type: string nullable: true readOnly: true marketplace_offering_name: type: string nullable: true readOnly: true marketplace_offering_plugin_options: type: object additionalProperties: {} nullable: true readOnly: true marketplace_category_uuid: type: string nullable: true readOnly: true marketplace_category_name: type: string nullable: true readOnly: true marketplace_resource_uuid: type: string nullable: true readOnly: true marketplace_plan_uuid: type: string nullable: true readOnly: true marketplace_resource_state: type: string nullable: true readOnly: true is_usage_based: type: boolean nullable: true readOnly: true is_limit_based: type: boolean nullable: true readOnly: true required: [] RancherClusterReference: type: object properties: uuid: type: string format: uuid readOnly: true name: type: string maxLength: 150 marketplace_uuid: type: string nullable: true readOnly: true required: [] description: '' RancherClusterRequest: type: object description: '' properties: name: type: string minLength: 1 pattern: ^[a-z0-9]([-a-z0-9])+[a-z0-9]$ maxLength: 150 description: type: string maxLength: 2000 service_settings: type: string format: uri project: type: string format: uri nodes: type: array items: $ref: '#/components/schemas/RancherNestedNodeRequest' tenant: type: string format: uri vm_project: type: string format: uri nullable: true ssh_public_key: type: string format: uri writeOnly: true install_longhorn: type: boolean default: false description: Longhorn is a distributed block storage deployed on top of Kubernetes cluster required: - name - nodes - project - service_settings RancherClusterSecurityGroupRule: type: object properties: uuid: type: string format: uuid readOnly: true ethertype: allOf: - $ref: '#/components/schemas/EthertypeEnum' description: IP protocol version - either 'IPv4' or 'IPv6' direction: allOf: - $ref: '#/components/schemas/DirectionEnum' description: Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing) protocol: description: The network protocol (TCP, UDP, ICMP, or empty for any protocol) oneOf: - $ref: '#/components/schemas/ProtocolEnum' - $ref: '#/components/schemas/BlankEnum' from_port: type: integer maximum: 65535 minimum: -2147483648 nullable: true description: Starting port number in the range (1-65535) to_port: type: integer maximum: 65535 minimum: -2147483648 nullable: true description: Ending port number in the range (1-65535) cidr: type: string nullable: true description: CIDR notation for the source/destination network address range maxLength: 255 description: type: string maxLength: 2000 required: - uuid description: '' RancherClusterSecurityGroupRuleRequest: type: object properties: ethertype: allOf: - $ref: '#/components/schemas/EthertypeEnum' description: IP protocol version - either 'IPv4' or 'IPv6' direction: allOf: - $ref: '#/components/schemas/DirectionEnum' description: Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing) protocol: description: The network protocol (TCP, UDP, ICMP, or empty for any protocol) oneOf: - $ref: '#/components/schemas/ProtocolEnum' - $ref: '#/components/schemas/BlankEnum' from_port: type: integer maximum: 65535 minimum: -2147483648 nullable: true description: Starting port number in the range (1-65535) to_port: type: integer maximum: 65535 minimum: -2147483648 nullable: true description: Ending port number in the range (1-65535) cidr: type: string nullable: true description: CIDR notation for the source/destination network address range maxLength: 255 description: type: string maxLength: 2000 description: '' RancherClusterTemplate: type: object properties: uuid: type: string format: uuid readOnly: true name: type: string maxLength: 150 description: type: string maxLength: 2000 created: type: string format: date-time readOnly: true modified: type: string format: date-time readOnly: true nodes: type: array items: $ref: '#/components/schemas/RancherClusterTemplateNode' required: - created - modified - name - nodes - uuid description: '' RancherClusterTemplateNode: type: object properties: min_vcpu: type: integer maximum: 32767 minimum: 0 title: Min vCPU (cores) min_ram: type: integer maximum: 2147483647 minimum: 0 title: Min RAM (GB) system_volume_size: type: integer maximum: 2147483647 minimum: 0 title: System volume size (GB) preferred_volume_type: type: string maxLength: 150 role: $ref: '#/components/schemas/RoleEnum' required: - min_ram - min_vcpu - role - system_volume_size description: '' RancherCreateNode: type: object description: '' properties: cluster: type: string format: uri role: $ref: '#/components/schemas/RoleEnum' uuid: type: string format: uuid readOnly: true required: - cluster - role - uuid RancherCreateNodeRequest: type: object description: '' properties: cluster: type: string format: uri role: $ref: '#/components/schemas/RoleEnum' system_volume_size: type: integer writeOnly: true minimum: 64 system_volume_type: type: string format: uri writeOnly: true nullable: true memory: type: integer writeOnly: true cpu: type: integer writeOnly: true subnet: type: string format: uri writeOnly: true nullable: true flavor: type: string format: uri writeOnly: true nullable: true data_volumes: type: array items: $ref: '#/components/schemas/DataVolumeRequest' writeOnly: true ssh_public_key: type: string format: uri writeOnly: true tenant: type: string format: uri writeOnly: true required: - cluster - role - subnet RancherHPA: type: object properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true name: type: string maxLength: 150 description: type: string maxLength: 2000 created: type: string format: date-time readOnly: true modified: type: string format: date-time readOnly: true runtime_state: type: string readOnly: true cluster: type: string format: uri readOnly: true nullable: true cluster_uuid: type: string format: uuid readOnly: true cluster_name: type: string readOnly: true project: type: string format: uri readOnly: true nullable: true project_uuid: type: string format: uuid readOnly: true project_name: type: string readOnly: true namespace: type: string format: uri readOnly: true nullable: true namespace_uuid: type: string format: uuid readOnly: true namespace_name: type: string readOnly: true workload: type: string format: uri nullable: true workload_uuid: type: string format: uuid readOnly: true workload_name: type: string readOnly: true min_replicas: type: integer maximum: 32767 minimum: 0 max_replicas: type: integer maximum: 32767 minimum: 0 current_replicas: type: integer readOnly: true desired_replicas: type: integer readOnly: true metrics: {} required: - cluster - cluster_name - cluster_uuid - created - current_replicas - desired_replicas - metrics - modified - name - namespace - namespace_name - namespace_uuid - project - project_name - project_uuid - runtime_state - url - uuid - workload_name - workload_uuid description: '' RancherHPARequest: type: object properties: name: type: string minLength: 1 maxLength: 150 description: type: string maxLength: 2000 workload: type: string format: uri nullable: true min_replicas: type: integer maximum: 32767 minimum: 0 max_replicas: type: integer maximum: 32767 minimum: 0 metrics: {} required: - metrics - name description: '' RancherImportYaml: type: object properties: yaml: type: string default_namespace: type: string format: uri nullable: true namespace: type: string format: uri nullable: true required: - yaml description: '' RancherImportYamlRequest: type: object properties: yaml: type: string minLength: 1 default_namespace: type: string format: uri nullable: true namespace: type: string format: uri nullable: true required: - yaml description: '' RancherIngress: type: object description: '' properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true name: type: string maxLength: 150 description: type: string maxLength: 2000 service_name: type: string readOnly: true service_settings: type: string format: uri service_settings_uuid: type: string format: uuid readOnly: true service_settings_state: type: string readOnly: true service_settings_error_message: type: string readOnly: true project: type: string format: uri project_name: type: string readOnly: true project_uuid: type: string format: uuid readOnly: true customer: type: string format: uri readOnly: true customer_name: type: string readOnly: true customer_native_name: type: string readOnly: true customer_abbreviation: type: string readOnly: true error_message: type: string error_traceback: type: string resource_type: type: string readOnly: true state: allOf: - $ref: '#/components/schemas/CoreStates' readOnly: true created: type: string format: date-time readOnly: true modified: type: string format: date-time readOnly: true backend_id: type: string maxLength: 255 access_url: type: string nullable: true readOnly: true runtime_state: type: string maxLength: 150 rancher_project: type: string format: uri rancher_project_name: type: string readOnly: true namespace: type: string format: uri namespace_name: type: string readOnly: true rules: {} marketplace_offering_uuid: type: string nullable: true readOnly: true marketplace_offering_name: type: string nullable: true readOnly: true marketplace_offering_plugin_options: type: object additionalProperties: {} nullable: true readOnly: true marketplace_category_uuid: type: string nullable: true readOnly: true marketplace_category_name: type: string nullable: true readOnly: true marketplace_resource_uuid: type: string nullable: true readOnly: true marketplace_plan_uuid: type: string nullable: true readOnly: true marketplace_resource_state: type: string nullable: true readOnly: true is_usage_based: type: boolean nullable: true readOnly: true is_limit_based: type: boolean nullable: true readOnly: true required: [] RancherIngressRequest: type: object description: '' properties: name: type: string minLength: 1 maxLength: 150 description: type: string maxLength: 2000 service_settings: type: string format: uri project: type: string format: uri error_message: type: string error_traceback: type: string backend_id: type: string maxLength: 255 runtime_state: type: string maxLength: 150 rancher_project: type: string format: uri namespace: type: string format: uri rules: {} required: - name - project - rancher_project - service_settings RancherNamespace: type: object description: '' properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true name: type: string maxLength: 150 created: type: string format: date-time readOnly: true modified: type: string format: date-time readOnly: true runtime_state: type: string maxLength: 150 project: type: string format: uri nullable: true required: - created - modified - name - url - uuid RancherNestedNamespace: type: object properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true name: type: string maxLength: 150 required: - name - url - uuid description: '' RancherNestedNode: type: object description: '' properties: url: type: string format: uri readOnly: true role: $ref: '#/components/schemas/RoleEnum' instance: type: string readOnly: true created: type: string format: date-time readOnly: true modified: type: string format: date-time readOnly: true uuid: type: string format: uuid readOnly: true error_message: type: string readOnly: true error_traceback: type: string backend_id: type: string maxLength: 255 initial_data: readOnly: true description: Initial data for instance creating. runtime_state: type: string readOnly: true k8s_version: type: string readOnly: true docker_version: type: string readOnly: true cpu_allocated: type: number format: double readOnly: true nullable: true cpu_total: type: integer readOnly: true nullable: true ram_allocated: type: integer readOnly: true nullable: true description: Allocated RAM in Mi. ram_total: type: integer readOnly: true nullable: true description: Total RAM in Mi. pods_allocated: type: integer readOnly: true nullable: true pods_total: type: integer readOnly: true nullable: true labels: readOnly: true annotations: readOnly: true required: [] RancherNestedNodeRequest: type: object description: '' properties: subnet: type: string format: uri writeOnly: true nullable: true flavor: type: string format: uri writeOnly: true nullable: true system_volume_size: type: integer writeOnly: true minimum: 64 system_volume_type: type: string format: uri writeOnly: true nullable: true data_volumes: type: array items: $ref: '#/components/schemas/DataVolumeRequest' writeOnly: true memory: type: integer writeOnly: true cpu: type: integer writeOnly: true role: $ref: '#/components/schemas/RoleEnum' tenant: type: string format: uri writeOnly: true error_traceback: type: string backend_id: type: string maxLength: 255 required: - role - subnet RancherNestedPublicIP: type: object properties: floating_ip: type: string format: uri readOnly: true floating_ip_uuid: type: string format: uuid readOnly: true ip_address: description: An IPv4 or IPv6 address. oneOf: - type: string format: ipv4 - type: string format: ipv6 readOnly: true external_ip_address: description: An IPv4 or IPv6 address. oneOf: - type: string format: ipv4 - type: string format: ipv6 readOnly: true required: [] description: '' RancherNestedSecurityGroup: type: object properties: url: type: string format: uri readOnly: true required: - url description: '' RancherNestedWorkload: type: object description: '' properties: uuid: type: string format: uuid readOnly: true url: type: string format: uri readOnly: true name: type: string maxLength: 150 required: [] RancherNestedWorkloadRequest: type: object description: '' properties: name: type: string minLength: 1 maxLength: 150 required: - name RancherNode: type: object properties: uuid: type: string format: uuid readOnly: true url: type: string format: uri readOnly: true created: type: string format: date-time readOnly: true modified: type: string format: date-time readOnly: true name: type: string maxLength: 150 backend_id: type: string readOnly: true project_uuid: type: string format: uuid readOnly: true service_settings_name: type: string readOnly: true service_settings_uuid: type: string format: uuid readOnly: true resource_type: type: string readOnly: true state: allOf: - $ref: '#/components/schemas/CoreStates' readOnly: true cluster: type: string format: uri cluster_name: type: string readOnly: true cluster_uuid: type: string format: uuid readOnly: true instance: type: string instance_name: type: string readOnly: true instance_uuid: type: string format: uuid readOnly: true instance_marketplace_uuid: type: string format: uuid readOnly: true role: $ref: '#/components/schemas/RoleEnum' k8s_version: type: string readOnly: true docker_version: type: string readOnly: true cpu_allocated: type: number format: double readOnly: true nullable: true cpu_total: type: integer readOnly: true nullable: true ram_allocated: type: integer readOnly: true nullable: true description: Allocated RAM in Mi. ram_total: type: integer readOnly: true nullable: true description: Total RAM in Mi. pods_allocated: type: integer readOnly: true nullable: true pods_total: type: integer readOnly: true nullable: true labels: readOnly: true annotations: readOnly: true runtime_state: type: string readOnly: true required: - annotations - backend_id - cluster - cluster_name - cluster_uuid - cpu_allocated - cpu_total - created - docker_version - instance - instance_marketplace_uuid - instance_name - instance_uuid - k8s_version - labels - modified - name - pods_allocated - pods_total - project_uuid - ram_allocated - ram_total - resource_type - role - runtime_state - service_settings_name - service_settings_uuid - state - url - uuid description: '' RancherProject: type: object description: '' properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true name: type: string maxLength: 150 description: type: string maxLength: 2000 created: type: string format: date-time readOnly: true modified: type: string format: date-time readOnly: true runtime_state: type: string maxLength: 150 cluster: type: string format: uri nullable: true namespaces: type: array items: $ref: '#/components/schemas/RancherNestedNamespace' required: - created - modified - name - namespaces - url - uuid RancherRoleScopeType: enum: - cluster - project type: string description: '' RancherService: type: object description: '' properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true name: type: string maxLength: 150 description: type: string maxLength: 2000 service_name: type: string readOnly: true service_settings: type: string format: uri service_settings_uuid: type: string format: uuid readOnly: true service_settings_state: type: string readOnly: true service_settings_error_message: type: string readOnly: true project: type: string format: uri project_name: type: string readOnly: true project_uuid: type: string format: uuid readOnly: true customer: type: string format: uri readOnly: true customer_name: type: string readOnly: true customer_native_name: type: string readOnly: true customer_abbreviation: type: string readOnly: true error_message: type: string error_traceback: type: string resource_type: type: string readOnly: true state: allOf: - $ref: '#/components/schemas/CoreStates' readOnly: true created: type: string format: date-time readOnly: true modified: type: string format: date-time readOnly: true backend_id: type: string maxLength: 255 access_url: type: string nullable: true readOnly: true runtime_state: type: string maxLength: 150 namespace: type: string format: uri namespace_name: type: string readOnly: true cluster_ip: description: An IPv4 or IPv6 address. oneOf: - type: string format: ipv4 - type: string format: ipv6 nullable: true selector: nullable: true target_workloads: type: array items: $ref: '#/components/schemas/RancherNestedWorkload' marketplace_offering_uuid: type: string nullable: true readOnly: true marketplace_offering_name: type: string nullable: true readOnly: true marketplace_offering_plugin_options: type: object additionalProperties: {} nullable: true readOnly: true marketplace_category_uuid: type: string nullable: true readOnly: true marketplace_category_name: type: string nullable: true readOnly: true marketplace_resource_uuid: type: string nullable: true readOnly: true marketplace_plan_uuid: type: string nullable: true readOnly: true marketplace_resource_state: type: string nullable: true readOnly: true is_usage_based: type: boolean nullable: true readOnly: true is_limit_based: type: boolean nullable: true readOnly: true required: [] RancherServiceRequest: type: object description: '' properties: name: type: string minLength: 1 maxLength: 150 description: type: string maxLength: 2000 service_settings: type: string format: uri project: type: string format: uri error_message: type: string error_traceback: type: string backend_id: type: string maxLength: 255 runtime_state: type: string maxLength: 150 namespace: type: string format: uri cluster_ip: description: An IPv4 or IPv6 address. oneOf: - type: string format: ipv4 - type: string format: ipv6 nullable: true minLength: 1 selector: nullable: true target_workloads: type: array items: $ref: '#/components/schemas/RancherNestedWorkloadRequest' required: - name - project - service_settings RancherTemplate: type: object description: '' properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true name: type: string maxLength: 150 description: type: string maxLength: 2000 created: type: string format: date-time readOnly: true modified: type: string format: date-time readOnly: true runtime_state: type: string maxLength: 150 catalog: type: string format: uri nullable: true cluster: type: string format: uri nullable: true project: type: string format: uri nullable: true icon: type: string format: uri nullable: true project_url: type: string format: uri maxLength: 500 default_version: type: string maxLength: 255 catalog_name: type: string readOnly: true versions: type: array items: type: string maxLength: 255 required: - catalog_name - created - default_version - modified - name - url - uuid - versions RancherTemplateBaseQuestion: type: object properties: label: type: string description: type: string variable: type: string required: type: boolean validate_: title: 'Validate ' type: $ref: '#/components/schemas/RancherTemplateQuestionType' default: type: string nullable: true group: type: string showIf: type: string required: - label - type - variable description: '' RancherTemplateQuestion: type: object properties: label: type: string description: type: string variable: type: string required: type: boolean validate_: title: 'Validate ' type: $ref: '#/components/schemas/RancherTemplateQuestionType' default: type: string nullable: true group: type: string showIf: type: string subquestions: type: array items: $ref: '#/components/schemas/RancherTemplateBaseQuestion' showSubquestionIf: type: string required: - label - type - variable description: '' RancherTemplateQuestionType: enum: - boolean - string - enum - secret type: string description: '' RancherUser: type: object properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true user: type: string format: uri cluster_roles: type: array items: $ref: '#/components/schemas/RancherUserClusterLink' readOnly: true project_roles: type: array items: $ref: '#/components/schemas/RancherUserProjectLink' readOnly: true settings: type: string format: uri is_active: type: boolean user_name: type: string description: Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters readOnly: true full_name: type: string readOnly: true required: - cluster_roles - full_name - project_roles - settings - url - user - user_name - uuid description: '' RancherUserClusterLink: type: object properties: cluster: type: string format: uri role: type: string format: uri cluster_name: type: string readOnly: true cluster_uuid: type: string format: uuid readOnly: true required: - cluster - cluster_name - cluster_uuid - role description: '' RancherUserProjectLink: type: object properties: project: type: string format: uri role: type: string format: uri project_name: type: string readOnly: true project_uuid: type: string format: uuid readOnly: true required: - project - project_name - project_uuid - role description: '' RancherWorkload: type: object properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true name: type: string maxLength: 150 created: type: string format: date-time readOnly: true modified: type: string format: date-time readOnly: true runtime_state: type: string maxLength: 150 cluster: type: string format: uri nullable: true cluster_uuid: type: string format: uuid readOnly: true cluster_name: type: string readOnly: true project: type: string format: uri nullable: true project_uuid: type: string format: uuid readOnly: true project_name: type: string readOnly: true namespace: type: string format: uri nullable: true namespace_uuid: type: string format: uuid readOnly: true namespace_name: type: string readOnly: true scale: type: integer maximum: 32767 minimum: 0 required: - cluster_name - cluster_uuid - created - modified - name - namespace_name - namespace_uuid - project_name - project_uuid - scale - url - uuid description: '' RancherWorkloadRequest: type: object properties: name: type: string minLength: 1 maxLength: 150 runtime_state: type: string maxLength: 150 cluster: type: string format: uri nullable: true project: type: string format: uri nullable: true namespace: type: string format: uri nullable: true scale: type: integer maximum: 32767 minimum: 0 required: - name - scale description: '' ReferenceNumberRequest: type: object properties: reference_number: type: string description: Reference number associated with the invoice. maxLength: 300 description: '' RemoteCredentialsRequest: type: object properties: api_url: type: string format: uri minLength: 1 token: type: string minLength: 1 required: - api_url - token description: '' RemoteCustomer: type: object properties: uuid: type: string format: uuid readOnly: true name: type: string readOnly: true abbreviation: type: string readOnly: true phone_number: type: string readOnly: true email: type: string readOnly: true required: - abbreviation - email - name - phone_number - uuid description: '' RemoteEduteamsRequestRequest: type: object properties: cuid: type: string minLength: 1 maxLength: 256 required: - cuid description: '' RemoteEduteamsUUID: type: object properties: uuid: type: string format: uuid required: - uuid description: '' RemoteOffering: type: object properties: uuid: type: string format: uuid readOnly: true name: type: string readOnly: true type: type: string readOnly: true state: type: string readOnly: true category_title: type: string readOnly: true required: - category_title - name - state - type - uuid description: '' RemoteOfferingCreateRequest: type: object properties: api_url: type: string format: uri minLength: 1 token: type: string minLength: 1 remote_offering_uuid: type: string format: uuid local_category_uuid: type: string format: uuid local_customer_uuid: type: string format: uuid remote_customer_uuid: type: string format: uuid required: - api_url - local_category_uuid - local_customer_uuid - remote_customer_uuid - remote_offering_uuid - token description: '' RemoteOfferingCreateResponse: type: object properties: uuid: type: string format: uuid readOnly: true required: - uuid description: '' RemoteProjectUpdateRequest: type: object properties: uuid: type: string format: uuid readOnly: true state: type: string readOnly: true customer_name: type: string readOnly: true customer_uuid: type: string readOnly: true offering_name: type: string readOnly: true offering_uuid: type: string format: uuid readOnly: true created: type: string format: date-time readOnly: true reviewed_at: type: string format: date-time readOnly: true nullable: true description: Timestamp when the review was completed reviewed_by_full_name: type: string readOnly: true reviewed_by_uuid: type: string format: uuid readOnly: true review_comment: type: string nullable: true description: Optional comment provided during review old_name: type: string maxLength: 500 new_name: type: string maxLength: 500 old_description: type: string maxLength: 2000 new_description: type: string maxLength: 2000 old_end_date: type: string format: date nullable: true new_end_date: type: string format: date nullable: true old_oecd_fos_2007_code: type: string nullable: true maxLength: 5 old_oecd_fos_2007_label: type: string readOnly: true new_oecd_fos_2007_code: type: string nullable: true maxLength: 5 new_oecd_fos_2007_label: type: string readOnly: true old_is_industry: type: boolean nullable: true new_is_industry: type: boolean nullable: true created_by: type: integer nullable: true required: - created - customer_name - customer_uuid - new_oecd_fos_2007_label - offering_name - offering_uuid - old_oecd_fos_2007_label - reviewed_at - reviewed_by_full_name - reviewed_by_uuid - state - uuid description: '' RemoteResourceOrder: type: object description: '' properties: order_uuid: type: string format: uuid readOnly: true description: Order UUID remote_state: allOf: - $ref: '#/components/schemas/RemoteResourceOrderRemoteStateEnum' readOnly: true description: Remote order state local_state: allOf: - $ref: '#/components/schemas/OrderState' readOnly: true description: Local order state sync_status: allOf: - $ref: '#/components/schemas/SyncStatusEnum' readOnly: true description: 'Sync status: in_sync, out_of_sync, sync_failed' required: - local_state - order_uuid - remote_state - sync_status RemoteResourceOrderRemoteStateEnum: enum: - 1 - 7 - 8 - 2 - 3 - 4 - 5 - 6 type: integer description: '' RemoteResourceSyncStatus: type: object description: '' properties: local_state: allOf: - $ref: '#/components/schemas/ResourceState' readOnly: true description: Local resource state remote_state: readOnly: true nullable: true description: Remote resource state oneOf: - $ref: '#/components/schemas/RemoteResourceSyncStatusRemoteStateEnum' - $ref: '#/components/schemas/NullEnum' sync_status: allOf: - $ref: '#/components/schemas/SyncStatusEnum' readOnly: true description: 'Sync status: in_sync, out_of_sync, sync_failed' last_sync: type: string format: date-time readOnly: true nullable: true description: Last sync timestamp required: - last_sync - local_state - remote_state - sync_status RemoteResourceSyncStatusRemoteStateEnum: enum: - 1 - 2 - 3 - 4 - 5 - 6 type: integer description: '' RemoteResourceTeamMember: type: object description: '' properties: full_name: type: string readOnly: true description: Full name local_role: type: string readOnly: true description: Local role remote_role: type: string readOnly: true description: Remote role sync_status: allOf: - $ref: '#/components/schemas/SyncStatusEnum' readOnly: true description: 'Sync status: in_sync, out_of_sync, sync_failed' required: - full_name - local_role - remote_role - sync_status RemoteSynchronisation: type: object description: '' properties: uuid: type: string format: uuid readOnly: true url: type: string format: uri readOnly: true api_url: type: string format: uri maxLength: 200 token: type: string maxLength: 255 remote_organization_uuid: type: string format: uuid remote_organization_name: type: string maxLength: 255 local_service_provider: type: string format: uri local_service_provider_name: type: string readOnly: true is_active: type: boolean last_execution: type: string format: date-time readOnly: true nullable: true last_output: type: string readOnly: true get_state_display: type: string readOnly: true error_message: type: string readOnly: true created: type: string format: date-time readOnly: true modified: type: string format: date-time readOnly: true remotelocalcategory_set: type: array items: $ref: '#/components/schemas/NestedRemoteLocalCategory' required: - api_url - created - error_message - get_state_display - last_execution - last_output - local_service_provider - local_service_provider_name - modified - remote_organization_name - remote_organization_uuid - remotelocalcategory_set - token - url - uuid RemoteSynchronisationRequest: type: object description: '' properties: api_url: type: string format: uri minLength: 1 maxLength: 200 token: type: string minLength: 1 maxLength: 255 remote_organization_uuid: type: string format: uuid remote_organization_name: type: string minLength: 1 maxLength: 255 local_service_provider: type: string format: uri is_active: type: boolean remotelocalcategory_set: type: array items: $ref: '#/components/schemas/NestedRemoteLocalCategoryRequest' required: - api_url - local_service_provider - remote_organization_name - remote_organization_uuid - remotelocalcategory_set - token RemoveOfferingComponentRequest: type: object properties: uuid: type: string format: uuid required: - uuid description: '' ReportSection: type: object properties: header: type: string body: type: string required: [] description: '' ReportSectionRequest: type: object properties: header: type: string minLength: 1 body: type: string minLength: 1 required: - body - header description: '' RequestTypes: enum: - Create - Update - Terminate type: string description: '' RequestedOffering: type: object description: '' properties: uuid: type: string format: uuid readOnly: true state: allOf: - $ref: '#/components/schemas/RequestedOfferingStates' readOnly: true offering: type: string format: uri offering_name: type: string readOnly: true offering_uuid: type: string format: uuid readOnly: true provider_name: type: string readOnly: true category_uuid: type: string format: uuid readOnly: true category_name: type: string readOnly: true call_managing_organisation: type: string readOnly: true attributes: {} plan: type: string format: uri nullable: true plan_details: allOf: - $ref: '#/components/schemas/BasePublicPlan' readOnly: true options: allOf: - $ref: '#/components/schemas/OfferingOptions' readOnly: true components: type: array items: $ref: '#/components/schemas/OfferingComponent' readOnly: true created: type: string format: date-time readOnly: true url: type: string readOnly: true approved_by: type: string format: uri readOnly: true nullable: true created_by: type: string format: uri readOnly: true nullable: true created_by_name: type: string readOnly: true approved_by_name: type: string readOnly: true description: type: string maxLength: 2000 required: - approved_by - approved_by_name - call_managing_organisation - category_name - category_uuid - components - created - created_by - created_by_name - offering - offering_name - offering_uuid - options - plan_details - provider_name - state - url - uuid RequestedOfferingRequest: type: object description: '' properties: offering: type: string format: uri attributes: {} plan: type: string format: uri nullable: true description: type: string maxLength: 2000 required: - offering RequestedOfferingStates: enum: - requested - accepted - canceled type: string description: '' RequestedResource: type: object description: '' properties: uuid: type: string format: uuid readOnly: true url: type: string readOnly: true requested_offering: allOf: - $ref: '#/components/schemas/NestedRequestedOffering' readOnly: true resource: type: string format: uri readOnly: true nullable: true resource_name: type: string readOnly: true call_resource_template: type: string readOnly: true call_resource_template_name: type: string readOnly: true attributes: {} limits: {} description: type: string maxLength: 2000 created_by: type: string format: uri readOnly: true nullable: true created_by_name: type: string readOnly: true required: - call_resource_template - call_resource_template_name - created_by - created_by_name - requested_offering - resource - resource_name - url - uuid RequestedResourceRequest: type: object description: '' properties: attributes: {} limits: {} description: type: string maxLength: 2000 requested_offering_uuid: type: string format: uuid writeOnly: true call_resource_template_uuid: type: string format: uuid writeOnly: true Resource: type: object description: '' properties: offering: type: string format: uri offering_name: type: string readOnly: true offering_uuid: type: string format: uuid readOnly: true offering_description: type: string readOnly: true offering_image: type: string format: uri readOnly: true offering_thumbnail: type: string format: uri readOnly: true offering_type: type: string readOnly: true offering_shared: type: boolean description: Accessible to all customers. readOnly: true offering_billable: type: boolean description: Purchase and usage is invoiced. readOnly: true offering_plugin_options: description: Public data used by specific plugin, such as storage mode for OpenStack. readOnly: true provider_name: type: string readOnly: true provider_uuid: type: string format: uuid readOnly: true category_title: type: string readOnly: true category_uuid: type: string format: uuid readOnly: true category_icon: type: string format: uri readOnly: true plan: type: string format: uri plan_unit: allOf: - $ref: '#/components/schemas/BillingUnit' readOnly: true nullable: true plan_name: type: string readOnly: true nullable: true plan_uuid: type: string format: uuid readOnly: true nullable: true plan_description: type: string readOnly: true nullable: true attributes: type: object additionalProperties: {} readOnly: true limits: type: object additionalProperties: type: integer readOnly: true uuid: type: string format: uuid readOnly: true created: type: string format: date-time readOnly: true modified: type: string format: date-time readOnly: true url: type: string format: uri readOnly: true scope: type: string readOnly: true description: type: string readOnly: true state: allOf: - $ref: '#/components/schemas/ResourceState' readOnly: true resource_uuid: type: string format: uuid readOnly: true nullable: true backend_id: type: string readOnly: true effective_id: type: string readOnly: true resource_type: type: string nullable: true readOnly: true project: type: string format: uri readOnly: true project_uuid: type: string format: uuid readOnly: true project_name: type: string readOnly: true project_description: type: string readOnly: true project_end_date: type: string format: date nullable: true description: The date is inclusive. Once reached, all project resource will be scheduled for termination. readOnly: true project_end_date_requested_by: type: string format: uri readOnly: true customer_uuid: type: string format: uuid readOnly: true customer_name: type: string readOnly: true offering_slug: type: string readOnly: true parent_offering_uuid: type: string format: uuid readOnly: true parent_offering_name: type: string readOnly: true parent_offering_slug: type: string readOnly: true parent_uuid: type: string format: uuid readOnly: true parent_name: type: string readOnly: true backend_metadata: allOf: - $ref: '#/components/schemas/BackendMetadata' readOnly: true is_usage_based: type: boolean readOnly: true is_limit_based: type: boolean readOnly: true name: type: string maxLength: 150 slug: type: string readOnly: true maxLength: 50 pattern: ^[-a-zA-Z0-9_]+$ current_usages: type: object additionalProperties: type: integer readOnly: true can_terminate: type: boolean readOnly: true report: type: array items: $ref: '#/components/schemas/ReportSection' readOnly: true end_date: type: string format: date nullable: true description: The date is inclusive. Once reached, a resource will be scheduled for termination. end_date_requested_by: type: string format: uri readOnly: true nullable: true username: type: string nullable: true readOnly: true limit_usage: type: object additionalProperties: type: number format: double readOnly: true downscaled: type: boolean restrict_member_access: type: boolean readOnly: true paused: type: boolean endpoints: type: array items: $ref: '#/components/schemas/NestedEndpoint' readOnly: true error_message: type: string readOnly: true error_traceback: type: string readOnly: true offering_customer_uuid: type: string format: uuid readOnly: true options: readOnly: true nullable: true available_actions: type: array items: type: string readOnly: true last_sync: type: string format: date-time readOnly: true order_in_progress: allOf: - $ref: '#/components/schemas/OrderDetails' readOnly: true nullable: true creation_order: allOf: - $ref: '#/components/schemas/OrderDetails' readOnly: true nullable: true service_settings_uuid: type: string format: uuid readOnly: true project_slug: type: string readOnly: true customer_slug: type: string readOnly: true user_requires_reconsent: type: boolean description: Check if the current user needs to re-consent for this resource's offering. readOnly: true required: [] ResourceBackendIDRequest: type: object properties: backend_id: type: string maxLength: 255 description: '' ResourceBackendMetadataRequest: type: object properties: backend_metadata: {} required: - backend_metadata description: '' ResourceEndDateByProviderRequest: type: object properties: end_date: type: string format: date nullable: true description: The date is inclusive. Once reached, a resource will be scheduled for termination. description: '' ResourceLimitPeriod: type: object properties: start: type: string end: type: string quantity: type: integer billing_periods: type: integer total: type: string required: [] description: '' ResourceOffering: type: object properties: name: type: string maxLength: 150 uuid: type: string format: uuid readOnly: true required: - name - uuid description: '' ResourceOptionsRequest: type: object properties: options: nullable: true description: '' ResourcePlanPeriod: type: object properties: uuid: type: string format: uuid readOnly: true plan_name: type: string readOnly: true plan_uuid: type: string format: uuid readOnly: true start: type: string format: date-time nullable: true end: type: string format: date-time nullable: true components: type: array items: $ref: '#/components/schemas/BaseComponentUsage' required: - components - plan_name - plan_uuid - uuid description: '' ResourceReportRequest: type: object properties: report: type: array items: $ref: '#/components/schemas/ReportSectionRequest' required: - report description: '' ResourceResponseStatus: type: object properties: status: type: string readOnly: true required: - status description: '' ResourceSetLimitsRequest: type: object properties: limits: {} required: - limits description: '' ResourceSetStateErredRequest: type: object properties: error_message: type: string error_traceback: type: string description: '' ResourceSlugRequest: type: object properties: slug: type: string minLength: 1 maxLength: 50 pattern: ^[-a-zA-Z0-9_]+$ required: - slug description: '' ResourceState: enum: - Creating - OK - Erred - Updating - Terminating - Terminated type: string description: '' ResourceSuggestName: type: object properties: project: type: string format: uuid offering: type: string format: uuid required: - offering - project description: '' ResourceSuggestNameRequest: type: object properties: project: type: string format: uuid offering: type: string format: uuid required: - offering - project description: '' ResourceSwitchPlanRequest: type: object properties: plan: type: string format: uri required: - plan description: '' ResourceTerminateRequest: type: object properties: attributes: title: Termination attributes description: '' ResourceUpdate: type: object properties: name: type: string maxLength: 150 description: type: string maxLength: 2000 end_date: type: string format: date nullable: true description: The date is inclusive. Once reached, a resource will be scheduled for termination. required: - name description: '' ResourceUpdateLimitsRequest: type: object properties: limits: type: object additionalProperties: type: integer minimum: 0 required: - limits description: '' ResourceUpdateRequest: type: object properties: name: type: string minLength: 1 maxLength: 150 description: type: string maxLength: 2000 end_date: type: string format: date nullable: true description: The date is inclusive. Once reached, a resource will be scheduled for termination. required: - name description: '' ResourceUser: type: object properties: uuid: type: string format: uuid readOnly: true resource: type: string format: uri role: type: string format: uri user: type: string format: uri resource_uuid: type: string format: uuid readOnly: true role_uuid: type: string format: uuid readOnly: true user_uuid: type: string format: uuid readOnly: true resource_name: type: string readOnly: true role_name: type: string readOnly: true user_username: type: string description: Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters readOnly: true user_full_name: type: string readOnly: true required: - resource - resource_name - resource_uuid - role - role_name - role_uuid - user - user_full_name - user_username - user_uuid - uuid description: '' ResourceUserRequest: type: object properties: resource: type: string format: uri role: type: string format: uri user: type: string format: uri required: - resource - role - user description: '' ResourcesLimits: type: object properties: offering_uuid: type: string format: uuid readOnly: true name: type: string readOnly: true value: type: integer readOnly: true offering_country: type: string readOnly: true organization_group_name: type: string readOnly: true organization_group_uuid: type: string readOnly: true required: - name - offering_country - offering_uuid - organization_group_name - organization_group_uuid - value description: '' ReviewComment: type: object properties: comment: type: string description: '' ReviewCommentRequest: type: object properties: comment: type: string minLength: 1 description: '' ReviewStrategyEnum: enum: - after_round - after_proposal type: string description: '' ReviewSubmitRequest: type: object properties: summary_score: type: integer maximum: 32767 minimum: 0 summary_public_comment: type: string summary_private_comment: type: string description: '' RmqConnection: type: object properties: source_ip: description: An IPv4 or IPv6 address. oneOf: - type: string format: ipv4 - type: string format: ipv6 readOnly: true vhost: type: string readOnly: true required: - source_ip - vhost description: '' RmqSubscription: type: object properties: created: type: string format: date-time readOnly: true uuid: type: string format: uuid readOnly: true source_ip: description: An IPv4 or IPv6 address. oneOf: - type: string format: ipv4 - type: string format: ipv6 readOnly: true required: - created - source_ip - uuid description: '' RmqUserStatsItem: type: object properties: username: type: string readOnly: true connections: type: array items: $ref: '#/components/schemas/RmqConnection' readOnly: true required: - connections - username description: '' RmqVHostStatsItem: type: object properties: name: type: string readOnly: true waldur_user: allOf: - $ref: '#/components/schemas/RmqWaldurUser' readOnly: true subscriptions: type: array items: $ref: '#/components/schemas/RmqSubscription' readOnly: true required: - name - subscriptions - waldur_user description: '' RmqWaldurUser: type: object properties: full_name: type: string readOnly: true username: type: string readOnly: true email: type: string format: email readOnly: true required: - email - full_name - username description: '' RobotAccount: type: object properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true created: type: string format: date-time readOnly: true modified: type: string format: date-time readOnly: true username: type: string maxLength: 32 description: type: string error_message: type: string readOnly: true error_traceback: type: string readOnly: true state: type: string readOnly: true resource: type: string format: uri type: type: string description: Type of the robot account. maxLength: 5 users: type: array items: type: string format: uri description: Users who have access to this robot account. keys: {} backend_id: type: string readOnly: true fingerprints: type: array items: $ref: '#/components/schemas/Fingerprint' readOnly: true responsible_user: type: string format: uri nullable: true required: - backend_id - created - fingerprints - modified - resource - type - url - uuid description: '' RobotAccountDetails: type: object description: '' properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true created: type: string format: date-time readOnly: true modified: type: string format: date-time readOnly: true username: type: string maxLength: 32 description: type: string error_message: type: string readOnly: true error_traceback: type: string readOnly: true state: type: string readOnly: true resource: type: string format: uri type: type: string description: Type of the robot account. maxLength: 5 users: type: array items: $ref: '#/components/schemas/BasicUser' readOnly: true keys: {} backend_id: type: string readOnly: true fingerprints: type: array items: $ref: '#/components/schemas/Fingerprint' readOnly: true responsible_user: allOf: - $ref: '#/components/schemas/BasicUser' readOnly: true nullable: true user_keys: type: array items: $ref: '#/components/schemas/SshKey' readOnly: true resource_name: type: string readOnly: true resource_uuid: type: string format: uuid readOnly: true project_name: type: string readOnly: true project_uuid: type: string format: uuid readOnly: true customer_uuid: type: string format: uuid readOnly: true customer_name: type: string readOnly: true offering_customer_uuid: type: string format: uuid readOnly: true offering_plugin_options: allOf: - $ref: '#/components/schemas/MergedPluginOptions' readOnly: true required: [] RobotAccountErrorRequest: type: object properties: error_message: type: string minLength: 1 description: Error message to be saved to the robot account description: '' RobotAccountRequest: type: object properties: username: type: string maxLength: 32 description: type: string resource: type: string format: uri type: type: string minLength: 1 description: Type of the robot account. maxLength: 5 users: type: array items: type: string format: uri description: Users who have access to this robot account. keys: {} responsible_user: type: string format: uri nullable: true required: - resource - type description: '' RoleDescription: type: object properties: description: type: string maxLength: 2000 description_en: type: string nullable: true title: Description [en] maxLength: 2000 description_et: type: string nullable: true title: Description [et] maxLength: 2000 description_lt: type: string nullable: true title: Description [lt] maxLength: 2000 description_lv: type: string nullable: true title: Description [lv] maxLength: 2000 description_ru: type: string nullable: true title: Description [ru] maxLength: 2000 description_it: type: string nullable: true title: Description [it] maxLength: 2000 description_de: type: string nullable: true title: Description [de] maxLength: 2000 description_da: type: string nullable: true title: Description [da] maxLength: 2000 description_sv: type: string nullable: true title: Description [sv] maxLength: 2000 description_es: type: string nullable: true title: Description [es] maxLength: 2000 description_fr: type: string nullable: true title: Description [fr] maxLength: 2000 description_nb: type: string nullable: true title: Description [nb] maxLength: 2000 description_ar: type: string nullable: true title: Description [ar] maxLength: 2000 description_cs: type: string nullable: true title: Description [cs] maxLength: 2000 description: '' RoleDescriptionRequest: type: object properties: description: type: string maxLength: 2000 description_en: type: string nullable: true title: Description [en] maxLength: 2000 description_et: type: string nullable: true title: Description [et] maxLength: 2000 description_lt: type: string nullable: true title: Description [lt] maxLength: 2000 description_lv: type: string nullable: true title: Description [lv] maxLength: 2000 description_ru: type: string nullable: true title: Description [ru] maxLength: 2000 description_it: type: string nullable: true title: Description [it] maxLength: 2000 description_de: type: string nullable: true title: Description [de] maxLength: 2000 description_da: type: string nullable: true title: Description [da] maxLength: 2000 description_sv: type: string nullable: true title: Description [sv] maxLength: 2000 description_es: type: string nullable: true title: Description [es] maxLength: 2000 description_fr: type: string nullable: true title: Description [fr] maxLength: 2000 description_nb: type: string nullable: true title: Description [nb] maxLength: 2000 description_ar: type: string nullable: true title: Description [ar] maxLength: 2000 description_cs: type: string nullable: true title: Description [cs] maxLength: 2000 description: '' RoleDetails: type: object description: '' properties: uuid: type: string format: uuid readOnly: true name: type: string maxLength: 150 description: type: string maxLength: 2000 description_en: type: string nullable: true title: Description [en] maxLength: 2000 description_et: type: string nullable: true title: Description [et] maxLength: 2000 description_lt: type: string nullable: true title: Description [lt] maxLength: 2000 description_lv: type: string nullable: true title: Description [lv] maxLength: 2000 description_ru: type: string nullable: true title: Description [ru] maxLength: 2000 description_it: type: string nullable: true title: Description [it] maxLength: 2000 description_de: type: string nullable: true title: Description [de] maxLength: 2000 description_da: type: string nullable: true title: Description [da] maxLength: 2000 description_sv: type: string nullable: true title: Description [sv] maxLength: 2000 description_es: type: string nullable: true title: Description [es] maxLength: 2000 description_fr: type: string nullable: true title: Description [fr] maxLength: 2000 description_nb: type: string nullable: true title: Description [nb] maxLength: 2000 description_ar: type: string nullable: true title: Description [ar] maxLength: 2000 description_cs: type: string nullable: true title: Description [cs] maxLength: 2000 permissions: type: array items: type: string readOnly: true is_system_role: type: boolean readOnly: true is_active: type: boolean users_count: type: integer readOnly: true content_type: allOf: - $ref: '#/components/schemas/RoleType' readOnly: true required: [] RoleEnum: enum: - agent - server type: string description: '' RoleModifyRequest: type: object description: '' properties: name: type: string minLength: 1 maxLength: 150 description: type: string maxLength: 2000 description_en: type: string nullable: true title: Description [en] maxLength: 2000 description_et: type: string nullable: true title: Description [et] maxLength: 2000 description_lt: type: string nullable: true title: Description [lt] maxLength: 2000 description_lv: type: string nullable: true title: Description [lv] maxLength: 2000 description_ru: type: string nullable: true title: Description [ru] maxLength: 2000 description_it: type: string nullable: true title: Description [it] maxLength: 2000 description_de: type: string nullable: true title: Description [de] maxLength: 2000 description_da: type: string nullable: true title: Description [da] maxLength: 2000 description_sv: type: string nullable: true title: Description [sv] maxLength: 2000 description_es: type: string nullable: true title: Description [es] maxLength: 2000 description_fr: type: string nullable: true title: Description [fr] maxLength: 2000 description_nb: type: string nullable: true title: Description [nb] maxLength: 2000 description_ar: type: string nullable: true title: Description [ar] maxLength: 2000 description_cs: type: string nullable: true title: Description [cs] maxLength: 2000 permissions: {} is_active: type: boolean content_type: type: string minLength: 1 required: - content_type - name - permissions RoleTemplate: type: object properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true name: type: string readOnly: true description: Role internal name scope_type: allOf: - $ref: '#/components/schemas/RancherRoleScopeType' readOnly: true display_name: type: string readOnly: true description: Role public name settings: type: string format: uri readOnly: true required: - display_name - name - scope_type - settings - url - uuid description: '' RoleType: enum: - customer - service_provider - call_organizer - project - offering - call - proposal type: string description: '' RoundReviewer: type: object properties: full_name: type: string readOnly: true email: type: string format: email accepted_proposals: type: integer rejected_proposals: type: integer in_review_proposals: type: integer required: - accepted_proposals - email - full_name - in_review_proposals - rejected_proposals description: '' Rule: type: object properties: name: type: string maxLength: 150 uuid: type: string format: uuid readOnly: true url: type: string format: uri readOnly: true user_affiliations: type: array items: type: string user_email_patterns: type: array items: type: string customer: type: string format: uri customer_name: type: string readOnly: true customer_uuid: type: string readOnly: true project_role: type: string format: uri nullable: true project_role_display_name: type: string readOnly: true project_role_description: type: string readOnly: true plan: type: string format: uri nullable: true plan_attributes: type: object additionalProperties: {} plan_limits: type: object additionalProperties: {} plan_name: type: string readOnly: true offering_name: type: string readOnly: true offering_uuid: type: string format: uuid readOnly: true category_title: type: string readOnly: true category_url: type: string format: uri readOnly: true required: - category_title - category_url - customer - customer_name - customer_uuid - name - offering_name - offering_uuid - plan_name - project_role_description - project_role_display_name - url - uuid description: '' RuleRequest: type: object properties: name: type: string minLength: 1 maxLength: 150 user_affiliations: type: array items: type: string minLength: 1 user_email_patterns: type: array items: type: string minLength: 1 customer: type: string format: uri project_role: type: string format: uri nullable: true project_role_name: type: string writeOnly: true nullable: true minLength: 1 plan: type: string format: uri nullable: true plan_attributes: type: object additionalProperties: {} plan_limits: type: object additionalProperties: {} required: - customer - name description: '' RuntimeStates: type: object properties: value: type: string readOnly: true label: type: string readOnly: true required: - label - value description: '' Saml2Login: type: object properties: idp: type: string required: - idp description: '' Saml2LoginComplete: type: object properties: SAMLResponse: type: string required: - SAMLResponse description: '' Saml2LoginCompleteRequest: type: object properties: SAMLResponse: type: string minLength: 1 required: - SAMLResponse description: '' Saml2LoginRequest: type: object properties: idp: type: string minLength: 1 required: - idp description: '' Saml2LogoutComplete: type: object properties: SAMLResponse: type: string SAMLRequest: type: string description: '' Saml2LogoutCompleteRequest: type: object properties: SAMLResponse: type: string minLength: 1 SAMLRequest: type: string minLength: 1 description: '' Saml2Provider: type: object properties: name: type: string url: type: string format: uri maxLength: 200 required: - name - url description: '' Screenshot: type: object description: '' properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true name: type: string maxLength: 150 created: type: string format: date-time readOnly: true description: type: string maxLength: 2000 image: type: string format: uri thumbnail: type: string format: uri readOnly: true nullable: true offering: type: string format: uri customer_uuid: type: string format: uuid readOnly: true required: - created - customer_uuid - image - name - offering - thumbnail - url - uuid ScreenshotRequest: type: object description: '' properties: name: type: string minLength: 1 maxLength: 150 description: type: string maxLength: 2000 image: type: string format: binary offering: type: string format: uri required: - image - name - offering Section: type: object properties: url: type: string format: uri readOnly: true key: type: string maxLength: 255 created: type: string format: date-time readOnly: true title: type: string maxLength: 255 category: type: string format: uri category_title: type: string readOnly: true is_standalone: type: boolean description: Whether section is rendered as a separate tab. required: - category - category_title - created - key - title - url description: '' SectionRequest: type: object properties: key: type: string minLength: 1 maxLength: 255 title: type: string minLength: 1 maxLength: 255 category: type: string format: uri is_standalone: type: boolean description: Whether section is rendered as a separate tab. required: - category - key - title description: '' ServiceAccountState: enum: - OK - Closed - Erred description: '' ServiceProvider: type: object description: '' properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true created: type: string format: date-time readOnly: true description: type: string maxLength: 2000 enable_notifications: type: boolean customer: type: string format: uri customer_name: type: string readOnly: true customer_uuid: type: string format: uuid readOnly: true customer_image: type: string format: uri readOnly: true customer_abbreviation: type: string readOnly: true customer_slug: type: string readOnly: true customer_native_name: type: string readOnly: true customer_country: type: string readOnly: true image: type: string format: uri nullable: true organization_groups: type: array items: $ref: '#/components/schemas/OrganizationGroup' readOnly: true offering_count: type: integer readOnly: true required: [] ServiceProviderApiSecretCode: type: object properties: api_secret_code: type: string readOnly: true required: - api_secret_code description: '' ServiceProviderComplianceOverview: type: object description: '' properties: offering_uuid: type: string format: uuid readOnly: true offering_name: type: string readOnly: true checklist_name: type: string readOnly: true nullable: true total_users: type: integer readOnly: true users_with_completions: type: integer readOnly: true completed_users: type: integer readOnly: true pending_users: type: integer readOnly: true compliance_rate: type: number format: double readOnly: true required: - checklist_name - completed_users - compliance_rate - offering_name - offering_uuid - pending_users - total_users - users_with_completions ServiceProviderOfferingUserCompliance: type: object description: '' properties: uuid: type: string format: uuid readOnly: true user_full_name: type: string readOnly: true user_email: type: string readOnly: true offering_name: type: string readOnly: true checklist_name: type: string readOnly: true nullable: true username: type: string readOnly: true nullable: true state: allOf: - $ref: '#/components/schemas/ServiceProviderOfferingUserComplianceStateEnum' readOnly: true completion_percentage: type: integer nullable: true readOnly: true compliance_status: type: string readOnly: true last_updated: type: string format: date-time nullable: true readOnly: true created: type: string format: date-time readOnly: true required: - checklist_name - completion_percentage - compliance_status - created - last_updated - offering_name - state - user_email - user_full_name - username - uuid ServiceProviderOfferingUserComplianceStateEnum: enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 type: integer description: '' ServiceProviderRequest: type: object description: '' properties: description: type: string maxLength: 2000 customer: type: string format: uri image: type: string format: binary nullable: true required: - customer ServiceProviderRevenues: type: object properties: total: type: integer readOnly: true year: type: integer readOnly: true month: type: integer readOnly: true required: - month - total - year description: '' ServiceProviderSignature: type: object properties: customer: type: string format: uuid data: type: string dry_run: type: boolean default: false required: - customer - data description: '' ServiceProviderSignatureRequest: type: object properties: customer: type: string format: uuid data: type: string minLength: 1 dry_run: type: boolean default: false required: - customer - data description: '' ServiceProviderStatistics: type: object properties: active_campaigns: type: integer readOnly: true current_customers: type: integer readOnly: true customers_number_change: type: integer readOnly: true active_resources: type: integer readOnly: true resources_number_change: type: integer readOnly: true active_and_paused_offerings: type: integer readOnly: true unresolved_tickets: type: integer readOnly: true pending_orders: type: integer readOnly: true erred_resources: type: integer readOnly: true required: - active_and_paused_offerings - active_campaigns - active_resources - current_customers - customers_number_change - erred_resources - pending_orders - resources_number_change - unresolved_tickets description: '' ServiceSettings: type: object description: '' properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true name: type: string maxLength: 150 type: type: string maxLength: 255 state: allOf: - $ref: '#/components/schemas/ServiceSettingsStateEnum' readOnly: true error_message: type: string readOnly: true shared: type: boolean description: Anybody can use it customer: type: string format: uri nullable: true title: Organization customer_name: type: string readOnly: true nullable: true customer_native_name: type: string readOnly: true terms_of_services: type: string format: uri maxLength: 255 scope: type: string nullable: true scope_uuid: type: string format: uuid readOnly: true options: type: object additionalProperties: {} readOnly: true required: [] ServiceSettingsStateEnum: enum: - CREATION_SCHEDULED - CREATING - UPDATE_SCHEDULED - UPDATING - DELETION_SCHEDULED - DELETING - OK - ERRED type: string description: '' SetMtu: type: object properties: mtu: type: integer required: - mtu description: '' SetMtuRequest: type: object properties: mtu: type: integer required: - mtu description: '' SetOfferingsUsername: type: object properties: user_uuid: type: string format: uuid username: type: string required: - user_uuid - username description: '' SetOfferingsUsernameRequest: type: object properties: user_uuid: type: string format: uuid username: type: string required: - user_uuid - username description: '' SlurmAllocation: type: object description: '' properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true name: type: string maxLength: 150 description: type: string maxLength: 2000 service_name: type: string readOnly: true service_settings: type: string format: uri service_settings_uuid: type: string format: uuid readOnly: true service_settings_state: type: string readOnly: true service_settings_error_message: type: string readOnly: true project: type: string format: uri project_name: type: string readOnly: true project_uuid: type: string format: uuid readOnly: true customer: type: string format: uri readOnly: true customer_name: type: string readOnly: true customer_native_name: type: string readOnly: true customer_abbreviation: type: string readOnly: true error_message: type: string readOnly: true error_traceback: type: string readOnly: true resource_type: type: string readOnly: true state: allOf: - $ref: '#/components/schemas/CoreStates' readOnly: true created: type: string format: date-time readOnly: true modified: type: string format: date-time readOnly: true backend_id: type: string readOnly: true access_url: type: string nullable: true readOnly: true cpu_limit: type: integer readOnly: true minimum: 0 cpu_usage: type: integer readOnly: true gpu_limit: type: integer readOnly: true minimum: 0 gpu_usage: type: integer readOnly: true ram_limit: type: integer readOnly: true minimum: 0 ram_usage: type: integer readOnly: true username: type: string nullable: true readOnly: true gateway: type: string nullable: true readOnly: true is_active: type: boolean readOnly: true marketplace_offering_uuid: type: string nullable: true readOnly: true marketplace_offering_name: type: string nullable: true readOnly: true marketplace_offering_plugin_options: type: object additionalProperties: {} nullable: true readOnly: true marketplace_category_uuid: type: string nullable: true readOnly: true marketplace_category_name: type: string nullable: true readOnly: true marketplace_resource_uuid: type: string nullable: true readOnly: true marketplace_plan_uuid: type: string nullable: true readOnly: true marketplace_resource_state: type: string nullable: true readOnly: true is_usage_based: type: boolean nullable: true readOnly: true is_limit_based: type: boolean nullable: true readOnly: true required: [] SlurmAllocationRequest: type: object description: '' properties: name: type: string minLength: 1 maxLength: 150 description: type: string maxLength: 2000 service_settings: type: string format: uri project: type: string format: uri required: - name - project - service_settings SlurmAllocationSetLimits: type: object properties: cpu_limit: type: integer minimum: -1 gpu_limit: type: integer minimum: -1 ram_limit: type: integer minimum: -1 required: - cpu_limit - gpu_limit - ram_limit description: '' SlurmAllocationSetLimitsRequest: type: object properties: cpu_limit: type: integer minimum: -1 gpu_limit: type: integer minimum: -1 ram_limit: type: integer minimum: -1 required: - cpu_limit - gpu_limit - ram_limit description: '' SlurmAllocationUserUsage: type: object properties: cpu_usage: type: integer maximum: 9223372036854775807 minimum: -9223372036854775808 format: int64 ram_usage: type: integer maximum: 9223372036854775807 minimum: -9223372036854775808 format: int64 gpu_usage: type: integer maximum: 9223372036854775807 minimum: -9223372036854775808 format: int64 month: type: integer maximum: 12 minimum: 1 year: type: integer maximum: 32767 minimum: 0 allocation: type: string format: uri user: type: string format: uri nullable: true username: type: string maxLength: 32 full_name: type: string readOnly: true required: - allocation - full_name - month - username - year description: '' SlurmAssociation: type: object properties: uuid: type: string format: uuid readOnly: true username: type: string pattern: ^[a-zA-Z0-9_.][a-zA-Z0-9_.-]*[a-zA-Z0-9_.$-]?$ maxLength: 128 allocation: type: string format: uri required: - allocation - username - uuid description: '' SmaxWebHookReceiver: type: object properties: id: type: string required: - id description: '' SmaxWebHookReceiverRequest: type: object properties: id: type: string minLength: 1 required: - id description: '' SshKey: type: object description: '' properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true name: type: string maxLength: 150 public_key: type: string maxLength: 2000 fingerprint_md5: type: string readOnly: true fingerprint_sha256: type: string readOnly: true fingerprint_sha512: type: string readOnly: true user_uuid: type: string format: uuid readOnly: true is_shared: type: boolean readOnly: true type: type: string readOnly: true required: [] SshKeyRequest: type: object description: '' properties: name: type: string maxLength: 150 public_key: type: string minLength: 1 maxLength: 2000 required: - public_key StateTransitionError: type: object properties: detail: type: string description: Error message to be displayed to the user required: - detail description: '' StatusEnum: enum: - scheduled - open - ended type: string description: '' StorageModeEnum: enum: - fixed - dynamic type: string description: '' SubNetMapping: type: object properties: src_cidr: type: string dst_cidr: type: string required: - dst_cidr - src_cidr description: '' SubNetMappingRequest: type: object properties: src_cidr: type: string minLength: 1 dst_cidr: type: string minLength: 1 required: - dst_cidr - src_cidr description: '' SubmitRequestResponse: type: object properties: uuid: type: string description: UUID of the created permission request scope_name: type: string description: Name of the invitation scope scope_uuid: type: string description: UUID of the invitation scope required: - scope_name - scope_uuid - uuid description: '' SubresourceOffering: type: object properties: uuid: type: string format: uuid readOnly: true type: type: string readOnly: true required: - type - uuid description: '' SupportStats: type: object properties: open_issues_count: type: integer readOnly: true closed_this_month_count: type: integer readOnly: true recent_broadcasts_count: type: integer readOnly: true required: - closed_this_month_count - open_issues_count - recent_broadcasts_count description: '' SupportUser: type: object description: '' properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true name: type: string maxLength: 150 backend_id: type: string nullable: true maxLength: 255 user: type: string format: uri nullable: true backend_name: type: string nullable: true maxLength: 255 required: - backend_id - name - url - user - uuid SyncStatusEnum: enum: - in_sync - out_of_sync - sync_failed type: string description: '' TableSize: type: object properties: table_name: type: string readOnly: true total_size: type: integer readOnly: true data_size: type: integer readOnly: true external_size: type: integer readOnly: true required: - data_size - external_size - table_name - total_size description: '' Template: type: object properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true name: type: string maxLength: 150 description: type: string issue_type: $ref: '#/components/schemas/IssueTypeEnum' attachments: type: array items: $ref: '#/components/schemas/TemplateAttachment' readOnly: true required: - attachments - description - name - url - uuid description: '' TemplateAttachment: type: object properties: uuid: type: string format: uuid readOnly: true name: type: string maxLength: 150 file: type: string format: uri mime_type: type: string readOnly: true file_size: type: integer readOnly: true created: type: string format: date-time readOnly: true required: - created - file - file_size - mime_type - name - uuid description: '' TemplateAttachmentRequest: type: object properties: name: type: string minLength: 1 maxLength: 150 file: type: string format: binary required: - file - name description: '' TemplateRequest: type: object properties: name: type: string minLength: 1 maxLength: 150 description: type: string minLength: 1 issue_type: $ref: '#/components/schemas/IssueTypeEnum' required: - description - name description: '' TemplateVersion: type: object properties: readme: type: string readOnly: true app_readme: type: string readOnly: true questions: type: array items: $ref: '#/components/schemas/RancherTemplateQuestion' readOnly: true required: - app_readme - questions - readme description: '' Tenant: type: object properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true name: type: string maxLength: 150 required: - name - url - uuid description: '' TokenRequest: type: object properties: token: type: string minLength: 1 required: - token description: '' TotalCustomerCost: type: object properties: total: type: number format: double readOnly: true price: type: number format: double readOnly: true required: - price - total description: '' UpdateOfferingComponentRequest: type: object properties: uuid: type: string format: uuid billing_type: $ref: '#/components/schemas/BillingTypeEnum' type: type: string minLength: 1 description: Unique internal name of the measured unit, for example floating_ip. pattern: ^[a-zA-Z0-9_\-\/:]+$ maxLength: 50 name: type: string minLength: 1 description: Display name for the measured unit, for example, Floating IP. maxLength: 150 description: type: string maxLength: 2000 measured_unit: type: string description: Unit of measurement, for example, GB. maxLength: 30 unit_factor: type: integer maximum: 2147483647 minimum: -2147483648 description: The conversion factor from backend units to measured_unit limit_period: nullable: true oneOf: - $ref: '#/components/schemas/LimitPeriodEnum' - $ref: '#/components/schemas/BlankEnum' - $ref: '#/components/schemas/NullEnum' limit_amount: type: integer maximum: 2147483647 minimum: -2147483648 nullable: true article_code: type: string maxLength: 30 max_value: type: integer maximum: 2147483647 minimum: -2147483648 nullable: true min_value: type: integer maximum: 2147483647 minimum: -2147483648 nullable: true max_available_limit: type: integer maximum: 2147483647 minimum: -2147483648 nullable: true is_boolean: type: boolean default_limit: type: integer maximum: 2147483647 minimum: -2147483648 nullable: true required: - billing_type - name - type - uuid description: '' User: type: object description: '' properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true username: type: string description: Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters pattern: ^[0-9a-z_.@+-]+$ maxLength: 128 slug: type: string readOnly: true maxLength: 50 pattern: ^[-a-zA-Z0-9_]+$ full_name: type: string readOnly: true maxLength: 200 native_name: type: string maxLength: 100 job_title: type: string maxLength: 120 email: type: string format: email phone_number: type: string maxLength: 255 organization: type: string maxLength: 255 civil_number: type: string readOnly: true nullable: true description: type: string maxLength: 2000 is_staff: type: boolean title: Staff status description: Designates whether the user can log into this admin site. is_active: type: boolean title: Active description: Designates whether this user should be treated as active. Unselect this instead of deleting accounts. is_support: type: boolean title: Support status description: Designates whether the user is a global support user. token: type: string readOnly: true token_lifetime: type: integer maximum: 2147483647 minimum: 60 nullable: true description: Token lifetime in seconds. token_expires_at: type: string format: date-time nullable: true readOnly: true registration_method: type: string readOnly: true description: Indicates what registration method was used. date_joined: type: string format: date-time readOnly: true agreement_date: type: string format: date-time readOnly: true nullable: true description: Indicates when the user has agreed with the policy. notifications_enabled: type: boolean description: Designates whether the user is allowed to receive email notifications. preferred_language: type: string maxLength: 10 permissions: type: array items: $ref: '#/components/schemas/Permission' readOnly: true requested_email: type: string nullable: true readOnly: true affiliations: readOnly: true description: Person's affiliation within organization such as student, faculty, staff. first_name: type: string maxLength: 100 last_name: type: string maxLength: 100 identity_provider_name: type: string readOnly: true identity_provider_label: type: string readOnly: true identity_provider_management_url: type: string readOnly: true identity_provider_fields: type: array items: type: string readOnly: true image: type: string format: uri nullable: true identity_source: type: string readOnly: true title: Source of identity description: Indicates what identity provider was used. has_active_session: type: boolean readOnly: true required: [] UserAgreement: type: object properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true content: type: string agreement_type: $ref: '#/components/schemas/AgreementTypeEnum' created: type: string format: date-time readOnly: true modified: type: string format: date-time readOnly: true required: - agreement_type - content - created - modified - url - uuid description: '' UserAgreementRequest: type: object properties: content: type: string minLength: 1 agreement_type: $ref: '#/components/schemas/AgreementTypeEnum' required: - agreement_type - content description: '' UserAuthToken: type: object properties: created: type: string format: date-time readOnly: true user_first_name: type: string readOnly: true user_last_name: type: string readOnly: true user_username: type: string description: Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters readOnly: true user_is_active: type: boolean title: Active description: Designates whether this user should be treated as active. Unselect this instead of deleting accounts. readOnly: true user_token_lifetime: type: integer maximum: 2147483647 minimum: 60 nullable: true description: Token lifetime in seconds. readOnly: true token: type: string readOnly: true required: - created - token - user_first_name - user_is_active - user_last_name - user_token_lifetime - user_username description: '' UserEmailChangeRequest: type: object properties: email: type: string format: email minLength: 1 required: - email description: '' UserOfferingConsent: type: object description: '' properties: uuid: type: string format: uuid readOnly: true user_uuid: type: string format: uuid readOnly: true offering_uuid: type: string format: uuid readOnly: true agreement_date: type: string format: date-time readOnly: true version: type: string maxLength: 50 revocation_date: type: string format: date-time readOnly: true nullable: true created: type: string format: date-time readOnly: true user_username: type: string description: Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters readOnly: true user_full_name: type: string readOnly: true user_email: type: string format: email title: Email address readOnly: true offering_name: type: string readOnly: true offering_slug: type: string readOnly: true offering_url: type: string format: uri readOnly: true modified: type: string format: date-time readOnly: true has_consent: type: boolean readOnly: true requires_reconsent: type: boolean readOnly: true required: - agreement_date - created - has_consent - modified - offering_name - offering_slug - offering_url - offering_uuid - requires_reconsent - revocation_date - user_email - user_full_name - user_username - user_uuid - uuid UserOfferingConsentCreate: type: object properties: offering: type: string format: uuid required: - offering description: '' UserOfferingConsentCreateRequest: type: object properties: offering: type: string format: uuid required: - offering description: '' UserOfferingConsentRequest: type: object description: '' properties: version: type: string maxLength: 50 UserRequest: type: object description: '' properties: username: type: string minLength: 1 description: Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters pattern: ^[0-9a-z_.@+-]+$ maxLength: 128 native_name: type: string maxLength: 100 job_title: type: string maxLength: 120 email: type: string format: email minLength: 1 phone_number: type: string maxLength: 255 organization: type: string maxLength: 255 description: type: string maxLength: 2000 is_staff: type: boolean title: Staff status description: Designates whether the user can log into this admin site. is_active: type: boolean title: Active description: Designates whether this user should be treated as active. Unselect this instead of deleting accounts. is_support: type: boolean title: Support status description: Designates whether the user is a global support user. token_lifetime: type: integer maximum: 2147483647 minimum: 60 nullable: true description: Token lifetime in seconds. agree_with_policy: type: boolean writeOnly: true description: User must agree with the policy to register. notifications_enabled: type: boolean description: Designates whether the user is allowed to receive email notifications. preferred_language: type: string maxLength: 10 first_name: type: string maxLength: 100 last_name: type: string maxLength: 100 image: type: string format: binary nullable: true required: - email - username UserRoleCreateRequest: type: object properties: role: type: string minLength: 1 user: type: string format: uuid expiration_time: type: string format: date-time nullable: true required: - role - user description: '' UserRoleDeleteRequest: type: object properties: role: type: string minLength: 1 user: type: string format: uuid expiration_time: type: string format: date-time nullable: true required: - role - user description: '' UserRoleDetails: type: object properties: uuid: type: string format: uuid readOnly: true created: type: string format: date-time readOnly: true expiration_time: type: string format: date-time nullable: true role_name: type: string readOnly: true role_uuid: type: string format: uuid readOnly: true user_email: type: string format: email title: Email address readOnly: true user_full_name: type: string readOnly: true user_username: type: string description: Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters readOnly: true user_uuid: type: string format: uuid readOnly: true user_image: type: string format: uri readOnly: true created_by_full_name: type: string readOnly: true created_by_uuid: type: string format: uuid readOnly: true required: [] description: '' UserRoleExpirationTime: type: object properties: expiration_time: type: string format: date-time nullable: true required: - expiration_time description: '' UserRoleUpdateRequest: type: object properties: role: type: string minLength: 1 user: type: string format: uuid expiration_time: type: string format: date-time nullable: true required: - role - user description: '' UsernameGenerationPolicyEnum: enum: - service_provider - anonymized - full_name - waldur_username - freeipa - identity_claim type: string description: '' Version: type: object properties: version: type: string description: Current installed version of the application latest_version: type: string description: Latest available version from GitHub, if available. required: - version description: '' VisibilityEnum: enum: - private - public type: string description: '' VisibleInvitationDetails: type: object properties: scope_uuid: type: string format: uuid readOnly: true scope_name: type: string readOnly: true scope_description: type: string description: |- Get the description field from the scope if it exists. Returns empty string if scope doesn't have a description field. readOnly: true scope_type: type: string nullable: true readOnly: true customer_uuid: type: string format: uuid readOnly: true customer_name: type: string readOnly: true role_name: type: string readOnly: true role_description: type: string readOnly: true created_by_full_name: type: string readOnly: true created_by_username: type: string readOnly: true email: type: string format: email description: Invitation link will be sent to this email. Note that user can accept invitation with different email. maxLength: 254 error_message: type: string readOnly: true execution_state: allOf: - $ref: '#/components/schemas/ExecutionStateEnum' readOnly: true state: allOf: - $ref: '#/components/schemas/InvitationState' readOnly: true required: - created_by_full_name - created_by_username - customer_name - customer_uuid - email - error_message - execution_state - role_description - role_name - scope_description - scope_name - scope_type - scope_uuid - state description: '' VmwareCluster: type: object description: '' properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true name: type: string maxLength: 150 required: - name - url - uuid VmwareDatastore: type: object description: '' properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true name: type: string maxLength: 150 type: type: string maxLength: 255 capacity: type: integer maximum: 2147483647 minimum: 0 nullable: true description: Capacity, in MB. free_space: type: integer maximum: 2147483647 minimum: 0 nullable: true description: Available space, in MB. required: - name - type - url - uuid VmwareDisk: type: object description: '' properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true name: type: string readOnly: true description: type: string maxLength: 2000 service_name: type: string readOnly: true service_settings: type: string format: uri readOnly: true service_settings_uuid: type: string format: uuid readOnly: true service_settings_state: type: string readOnly: true service_settings_error_message: type: string readOnly: true project: type: string format: uri readOnly: true project_name: type: string readOnly: true project_uuid: type: string format: uuid readOnly: true customer: type: string format: uri readOnly: true customer_name: type: string readOnly: true customer_native_name: type: string readOnly: true customer_abbreviation: type: string readOnly: true error_message: type: string readOnly: true error_traceback: type: string readOnly: true resource_type: type: string readOnly: true state: allOf: - $ref: '#/components/schemas/CoreStates' readOnly: true created: type: string format: date-time readOnly: true modified: type: string format: date-time readOnly: true backend_id: type: string readOnly: true access_url: type: string nullable: true readOnly: true size: type: integer maximum: 2147483647 minimum: 1024 description: Size in MiB vm: type: string format: uri readOnly: true vm_uuid: type: string format: uuid readOnly: true vm_name: type: string readOnly: true marketplace_offering_uuid: type: string nullable: true readOnly: true marketplace_offering_name: type: string nullable: true readOnly: true marketplace_offering_plugin_options: type: object additionalProperties: {} nullable: true readOnly: true marketplace_category_uuid: type: string nullable: true readOnly: true marketplace_category_name: type: string nullable: true readOnly: true marketplace_resource_uuid: type: string nullable: true readOnly: true marketplace_plan_uuid: type: string nullable: true readOnly: true marketplace_resource_state: type: string nullable: true readOnly: true is_usage_based: type: boolean nullable: true readOnly: true is_limit_based: type: boolean nullable: true readOnly: true required: [] VmwareDiskExtend: type: object properties: size: type: integer maximum: 2147483647 minimum: 0 description: Size in MiB required: - size description: '' VmwareDiskExtendRequest: type: object properties: size: type: integer maximum: 2147483647 minimum: 0 description: Size in MiB required: - size description: '' VmwareDiskRequest: type: object description: '' properties: description: type: string maxLength: 2000 size: type: integer maximum: 2147483647 minimum: 1024 description: Size in MiB required: - size VmwareFolder: type: object description: '' properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true name: type: string maxLength: 150 required: - name - url - uuid VmwareLimit: type: object properties: max_cpu: type: integer readOnly: true max_cores_per_socket: type: integer readOnly: true max_ram: type: integer readOnly: true max_disk: type: integer readOnly: true max_disk_total: type: integer readOnly: true required: - max_cores_per_socket - max_cpu - max_disk - max_disk_total - max_ram description: '' VmwareNestedDisk: type: object properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true size: type: integer maximum: 2147483647 minimum: 0 description: Size in MiB required: [] description: '' VmwareNestedDiskRequest: type: object properties: size: type: integer maximum: 2147483647 minimum: 0 description: Size in MiB required: - size description: '' VmwareNestedNetwork: type: object description: '' properties: uuid: type: string format: uuid readOnly: true url: type: string format: uri readOnly: true name: type: string maxLength: 150 type: type: string maxLength: 255 required: - name - type - url - uuid VmwareNestedNetworkRequest: type: object description: '' properties: name: type: string minLength: 1 maxLength: 150 type: type: string minLength: 1 maxLength: 255 required: - name - type VmwareNestedPort: type: object properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true name: type: string maxLength: 150 mac_address: type: string readOnly: true network: type: string format: uri required: [] description: '' VmwareNestedPortRequest: type: object properties: name: type: string minLength: 1 maxLength: 150 network: type: string format: uri required: - name - network description: '' VmwareNetwork: type: object description: '' properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true name: type: string maxLength: 150 type: type: string maxLength: 255 required: - name - type - url - uuid VmwarePort: type: object description: '' properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true name: type: string readOnly: true description: type: string maxLength: 2000 service_name: type: string readOnly: true service_settings: type: string format: uri readOnly: true service_settings_uuid: type: string format: uuid readOnly: true service_settings_state: type: string readOnly: true service_settings_error_message: type: string readOnly: true project: type: string format: uri readOnly: true project_name: type: string readOnly: true project_uuid: type: string format: uuid readOnly: true customer: type: string format: uri readOnly: true customer_name: type: string readOnly: true customer_native_name: type: string readOnly: true customer_abbreviation: type: string readOnly: true error_message: type: string readOnly: true error_traceback: type: string readOnly: true resource_type: type: string readOnly: true state: allOf: - $ref: '#/components/schemas/CoreStates' readOnly: true created: type: string format: date-time readOnly: true modified: type: string format: date-time readOnly: true backend_id: type: string readOnly: true access_url: type: string nullable: true readOnly: true mac_address: type: string readOnly: true vm: type: string format: uri readOnly: true vm_uuid: type: string format: uuid readOnly: true vm_name: type: string readOnly: true network: type: string format: uri network_name: type: string readOnly: true marketplace_offering_uuid: type: string nullable: true readOnly: true marketplace_offering_name: type: string nullable: true readOnly: true marketplace_offering_plugin_options: type: object additionalProperties: {} nullable: true readOnly: true marketplace_category_uuid: type: string nullable: true readOnly: true marketplace_category_name: type: string nullable: true readOnly: true marketplace_resource_uuid: type: string nullable: true readOnly: true marketplace_plan_uuid: type: string nullable: true readOnly: true marketplace_resource_state: type: string nullable: true readOnly: true is_usage_based: type: boolean nullable: true readOnly: true is_limit_based: type: boolean nullable: true readOnly: true required: [] VmwarePortRequest: type: object description: '' properties: description: type: string maxLength: 2000 network: type: string format: uri required: - network VmwareTemplate: type: object description: '' properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true name: type: string maxLength: 150 description: type: string maxLength: 2000 created: type: string format: date-time modified: type: string format: date-time guest_os: type: string description: Defines the valid guest operating system types used for configuring a virtual machine maxLength: 50 guest_os_name: type: string readOnly: true cores: type: integer maximum: 32767 minimum: 0 description: Number of cores in a VM cores_per_socket: type: integer maximum: 32767 minimum: 0 description: Number of cores per socket in a VM ram: type: integer maximum: 2147483647 minimum: 0 description: Memory size in MiB disk: type: integer maximum: 2147483647 minimum: 0 description: Disk size in MiB required: - created - guest_os - guest_os_name - modified - name - url - uuid VmwareVirtualMachine: type: object description: '' properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true name: type: string maxLength: 150 description: type: string maxLength: 2000 service_name: type: string readOnly: true service_settings: type: string format: uri service_settings_uuid: type: string format: uuid readOnly: true service_settings_state: type: string readOnly: true service_settings_error_message: type: string readOnly: true project: type: string format: uri project_name: type: string readOnly: true project_uuid: type: string format: uuid readOnly: true customer: type: string format: uri readOnly: true customer_name: type: string readOnly: true customer_native_name: type: string readOnly: true customer_abbreviation: type: string readOnly: true error_message: type: string readOnly: true error_traceback: type: string readOnly: true resource_type: type: string readOnly: true state: allOf: - $ref: '#/components/schemas/CoreStates' readOnly: true created: type: string format: date-time readOnly: true modified: type: string format: date-time readOnly: true backend_id: type: string readOnly: true access_url: type: string nullable: true readOnly: true guest_os: nullable: true oneOf: - $ref: '#/components/schemas/GuestOsEnum' - $ref: '#/components/schemas/NullEnum' guest_os_name: type: string readOnly: true cores: type: integer maximum: 32767 minimum: 1 description: Number of cores in a VM cores_per_socket: type: integer maximum: 32767 minimum: 1 description: Number of cores per socket in a VM ram: type: integer maximum: 2147483647 minimum: 1024 description: Memory size in MiB disk: type: integer readOnly: true description: Disk size in MiB disks: type: array items: $ref: '#/components/schemas/VmwareNestedDisk' readOnly: true runtime_state: type: string readOnly: true cluster: type: string format: uri nullable: true datastore: type: string format: uri nullable: true folder: type: string format: uri nullable: true template_name: type: string readOnly: true cluster_name: type: string readOnly: true datastore_name: type: string readOnly: true folder_name: type: string readOnly: true ports: type: array items: $ref: '#/components/schemas/VmwareNestedPort' readOnly: true guest_power_state: allOf: - $ref: '#/components/schemas/GuestPowerStateEnum' readOnly: true title: The power state of the guest operating system. tools_state: type: string readOnly: true tools_installed: type: boolean readOnly: true marketplace_offering_uuid: type: string nullable: true readOnly: true marketplace_offering_name: type: string nullable: true readOnly: true marketplace_offering_plugin_options: type: object additionalProperties: {} nullable: true readOnly: true marketplace_category_uuid: type: string nullable: true readOnly: true marketplace_category_name: type: string nullable: true readOnly: true marketplace_resource_uuid: type: string nullable: true readOnly: true marketplace_plan_uuid: type: string nullable: true readOnly: true marketplace_resource_state: type: string nullable: true readOnly: true is_usage_based: type: boolean nullable: true readOnly: true is_limit_based: type: boolean nullable: true readOnly: true required: [] VmwareVirtualMachineRequest: type: object description: '' properties: name: type: string minLength: 1 maxLength: 150 description: type: string maxLength: 2000 service_settings: type: string format: uri project: type: string format: uri guest_os: nullable: true oneOf: - $ref: '#/components/schemas/GuestOsEnum' - $ref: '#/components/schemas/NullEnum' cores: type: integer maximum: 32767 minimum: 1 description: Number of cores in a VM cores_per_socket: type: integer maximum: 32767 minimum: 1 description: Number of cores per socket in a VM ram: type: integer maximum: 2147483647 minimum: 1024 description: Memory size in MiB template: type: string format: uri writeOnly: true nullable: true cluster: type: string format: uri nullable: true networks: type: array items: $ref: '#/components/schemas/VmwareNestedNetworkRequest' writeOnly: true datastore: type: string format: uri nullable: true folder: type: string format: uri nullable: true required: - name - project - service_settings VolumeAttachRequest: type: object description: '' properties: instance: type: string format: uri description: Instance that this volume is attached to, if any required: - instance VolumeTypeEnum: enum: - gp2 - io1 - standard type: string description: '' VolumeTypeMapping: type: object properties: src_type_uuid: type: string format: uuid dst_type_uuid: type: string format: uuid required: - dst_type_uuid - src_type_uuid description: '' VolumeTypeMappingRequest: type: object properties: src_type_uuid: type: string format: uuid dst_type_uuid: type: string format: uuid required: - dst_type_uuid - src_type_uuid description: '' WebHook: type: object properties: url: type: string format: uri readOnly: true uuid: type: string format: uuid readOnly: true is_active: type: boolean author_uuid: type: string format: uuid readOnly: true event_types: type: array items: $ref: '#/components/schemas/EventTypesEnum' event_groups: type: array items: $ref: '#/components/schemas/EventGroupsEnum' created: type: string format: date-time readOnly: true modified: type: string format: date-time readOnly: true hook_type: type: string readOnly: true author_fullname: type: string readOnly: true author_username: type: string readOnly: true author_email: type: string readOnly: true destination_url: type: string format: uri maxLength: 200 content_type: $ref: '#/components/schemas/WebHookContentTypeEnum' required: - author_email - author_fullname - author_username - author_uuid - created - destination_url - hook_type - modified - url - uuid description: '' WebHookContentTypeEnum: enum: - json - form type: string description: '' WebHookReceiver: type: object properties: webhookEvent: $ref: '#/components/schemas/WebhookEventEnum' issue: $ref: '#/components/schemas/JiraIssue' comment: $ref: '#/components/schemas/JiraComment' changelog: $ref: '#/components/schemas/JiraChangelog' issue_event_type_name: type: string required: - issue - webhookEvent description: '' WebHookReceiverRequest: type: object properties: webhookEvent: $ref: '#/components/schemas/WebhookEventEnum' issue: $ref: '#/components/schemas/JiraIssueRequest' comment: $ref: '#/components/schemas/JiraCommentRequest' changelog: $ref: '#/components/schemas/JiraChangelogRequest' issue_event_type_name: type: string minLength: 1 required: - issue - webhookEvent description: '' WebHookRequest: type: object properties: is_active: type: boolean event_types: type: array items: $ref: '#/components/schemas/EventTypesEnum' event_groups: type: array items: $ref: '#/components/schemas/EventGroupsEnum' destination_url: type: string format: uri minLength: 1 maxLength: 200 content_type: $ref: '#/components/schemas/WebHookContentTypeEnum' required: - destination_url description: '' WebhookEventEnum: enum: - jira:issue_updated - jira:issue_deleted - comment_created - comment_updated - comment_deleted type: string description: '' WidgetEnum: enum: - csv - filesize - attached_instance type: string description: '' AzureVirtualMachineCreateOrderAttributes: type: object description: |- This mixin allows to specify list of fields to be rendered by serializer. It expects that request is available in serializer's context. It is disabled for nested serializers (where parent is another serializer) but remains active for list views (where parent is a ListSerializer). properties: name: type: string minLength: 1 pattern: ^[a-zA-Z][a-zA-Z0-9-]{0,13}[a-zA-Z0-9]$ maxLength: 15 description: type: string maxLength: 2000 size: type: string format: uri image: type: string format: uri location: type: string format: uri writeOnly: true required: - image - location - name - project - service_settings - size AzureSQLServerCreateOrderAttributes: type: object description: |- This mixin allows to specify list of fields to be rendered by serializer. It expects that request is available in serializer's context. It is disabled for nested serializers (where parent is another serializer) but remains active for list views (where parent is a ListSerializer). properties: name: type: string minLength: 1 pattern: ^[a-z0-9][a-z0-9-]+[a-z0-9]$ maxLength: 80 description: type: string maxLength: 2000 location: type: string format: uri writeOnly: true required: - location - name - project - service_settings OpenStackTenantCreateOrderAttributes: type: object description: |- This mixin allows to specify list of fields to be rendered by serializer. It expects that request is available in serializer's context. It is disabled for nested serializers (where parent is another serializer) but remains active for list views (where parent is a ListSerializer). properties: name: type: string minLength: 1 maxLength: 64 description: type: string maxLength: 2000 user_username: type: string description: Username of the tenant user maxLength: 50 user_password: type: string description: Password of the tenant user maxLength: 50 subnet_cidr: type: string writeOnly: true minLength: 1 default: 192.168.42.0/24 skip_connection_extnet: type: boolean default: false skip_creation_of_default_router: type: boolean default: false availability_zone: type: string description: Optional availability group. Will be used for all instances provisioned in this tenant maxLength: 100 required: - name - project - service_settings OpenStackInstanceCreateOrderAttributes: type: object description: |- This mixin allows to specify list of fields to be rendered by serializer. It expects that request is available in serializer's context. It is disabled for nested serializers (where parent is another serializer) but remains active for list views (where parent is a ListSerializer). properties: name: type: string minLength: 1 maxLength: 150 description: type: string maxLength: 2000 flavor: type: string format: uri writeOnly: true description: The flavor to use for the instance image: type: string format: uri writeOnly: true description: The OS image to use for the instance ports: type: array items: $ref: '#/components/schemas/OpenStackNestedPortRequest' description: Network ports to attach to the instance floating_ips: type: array items: $ref: '#/components/schemas/OpenStackNestedFloatingIPRequest' description: Floating IPs to assign to the instance system_volume_size: type: integer minimum: 1024 writeOnly: true description: Size of the system volume in MiB. Minimum size is 1024 MiB (1 GiB) system_volume_type: type: string format: uri writeOnly: true nullable: true description: Volume type for the system volume data_volume_size: type: integer minimum: 1024 writeOnly: true description: Size of the data volume in MiB. Minimum size is 1024 MiB (1 GiB) data_volume_type: type: string format: uri writeOnly: true nullable: true description: Volume type for the data volume ssh_public_key: type: string format: uri writeOnly: true user_data: type: string description: Additional data that will be added to instance on provisioning availability_zone: type: string format: uri nullable: true description: Availability zone where this instance is located connect_directly_to_external_network: type: boolean description: If True, instance will be connected directly to external network data_volumes: type: array items: $ref: '#/components/schemas/OpenStackDataVolumeRequest' writeOnly: true description: Additional data volumes to attach to the instance security_groups: type: array items: $ref: '#/components/schemas/OpenStackNestedSecurityGroupRequest' description: Security groups to attach to the instance required: - flavor - image - name - ports - project - system_volume_size - tenant OpenStackVolumeCreateOrderAttributes: type: object description: |- This mixin allows to specify list of fields to be rendered by serializer. It expects that request is available in serializer's context. It is disabled for nested serializers (where parent is another serializer) but remains active for list views (where parent is a ListSerializer). properties: name: type: string minLength: 1 maxLength: 150 description: type: string maxLength: 2000 image: type: string format: uri nullable: true description: Image that this volume was created from, if any size: type: integer maximum: 2147483647 minimum: 0 nullable: true description: Size in MiB availability_zone: type: string format: uri nullable: true description: Availability zone where this volume is located type: type: string format: uri nullable: true description: Type of the volume (e.g. SSD, HDD) required: - name - project - tenant MarketplaceRancherCreateOrderAttributes: type: object description: |- This mixin allows to specify list of fields to be rendered by serializer. It expects that request is available in serializer's context. It is disabled for nested serializers (where parent is another serializer) but remains active for list views (where parent is a ListSerializer). properties: name: type: string minLength: 1 pattern: ^[a-z0-9]([-a-z0-9])+[a-z0-9]$ maxLength: 150 description: type: string maxLength: 2000 nodes: type: array items: $ref: '#/components/schemas/RancherNestedNodeRequest' tenant: type: string format: uri ssh_public_key: type: string format: uri writeOnly: true install_longhorn: type: boolean default: false description: Longhorn is a distributed block storage deployed on top of Kubernetes cluster vm_project: type: string format: uri nullable: true required: - name - nodes - project - service_settings MarketplaceManagedRancherCreateOrderAttributes: type: object properties: name: type: string minLength: 1 description: Unique identifier for the cluster worker_nodes_count: type: integer worker_nodes_flavor_name: type: string minLength: 1 worker_nodes_data_volume_size: type: integer description: Data volume size for worker nodes in MB (consistent with OpenStack) worker_nodes_data_volume_type_name: type: string minLength: 1 openstack_offering_uuid_list: type: array items: type: string format: uuid description: List of UUID of OpenStack offerings where tenant can be created install_longhorn: type: boolean default: false description: Longhorn is a distributed block storage deployed on top of Kubernetes cluster worker_nodes_longhorn_volume_size: type: integer description: Longhorn storage volume size for worker nodes in MB (consistent with OpenStack) worker_nodes_longhorn_volume_type_name: type: string minLength: 1 required: - name - worker_nodes_count - worker_nodes_data_volume_size - worker_nodes_flavor_name SlurmInvoicesSlurmPackageCreateOrderAttributes: type: object description: |- This mixin allows to specify list of fields to be rendered by serializer. It expects that request is available in serializer's context. It is disabled for nested serializers (where parent is another serializer) but remains active for list views (where parent is a ListSerializer). properties: name: type: string minLength: 1 maxLength: 150 description: type: string maxLength: 2000 required: - name - project - service_settings VMwareVirtualMachineCreateOrderAttributes: type: object description: |- This mixin allows to specify list of fields to be rendered by serializer. It expects that request is available in serializer's context. It is disabled for nested serializers (where parent is another serializer) but remains active for list views (where parent is a ListSerializer). properties: name: type: string minLength: 1 maxLength: 150 description: type: string maxLength: 2000 guest_os: enum: - DOS - WIN_31 - WIN_95 - WIN_98 - WIN_ME - WIN_NT - WIN_2000_PRO - WIN_2000_SERV - WIN_2000_ADV_SERV - WIN_XP_HOME - WIN_XP_PRO - WIN_XP_PRO_64 - WIN_NET_WEB - WIN_NET_STANDARD - WIN_NET_ENTERPRISE - WIN_NET_DATACENTER - WIN_NET_BUSINESS - WIN_NET_STANDARD_64 - WIN_NET_ENTERPRISE_64 - WIN_LONGHORN - WIN_LONGHORN_64 - WIN_NET_DATACENTER_64 - WIN_VISTA - WIN_VISTA_64 - WINDOWS_7 - WINDOWS_7_64 - WINDOWS_7_SERVER_64 - WINDOWS_8 - WINDOWS_8_64 - WINDOWS_8_SERVER_64 - WINDOWS_9 - WINDOWS_9_64 - WINDOWS_9_SERVER_64 - WINDOWS_HYPERV - FREEBSD - FREEBSD_64 - REDHAT - RHEL_2 - RHEL_3 - RHEL_3_64 - RHEL_4 - RHEL_4_64 - RHEL_5 - RHEL_5_64 - RHEL_6 - RHEL_6_64 - RHEL_7 - RHEL_7_64 - CENTOS - CENTOS_64 - CENTOS_6 - CENTOS_6_64 - CENTOS_7 - CENTOS_7_64 - ORACLE_LINUX - ORACLE_LINUX_64 - ORACLE_LINUX_6 - ORACLE_LINUX_6_64 - ORACLE_LINUX_7 - ORACLE_LINUX_7_64 - SUSE - SUSE_64 - SLES - SLES_64 - SLES_10 - SLES_10_64 - SLES_11 - SLES_11_64 - SLES_12 - SLES_12_64 - NLD_9 - OES - SJDS - MANDRAKE - MANDRIVA - MANDRIVA_64 - TURBO_LINUX - TURBO_LINUX_64 - UBUNTU - UBUNTU_64 - DEBIAN_4 - DEBIAN_4_64 - DEBIAN_5 - DEBIAN_5_64 - DEBIAN_6 - DEBIAN_6_64 - DEBIAN_7 - DEBIAN_7_64 - DEBIAN_8 - DEBIAN_8_64 - DEBIAN_9 - DEBIAN_9_64 - DEBIAN_10 - DEBIAN_10_64 - ASIANUX_3 - ASIANUX_3_64 - ASIANUX_4 - ASIANUX_4_64 - ASIANUX_5_64 - ASIANUX_7_64 - OPENSUSE - OPENSUSE_64 - FEDORA - FEDORA_64 - COREOS_64 - VMWARE_PHOTON_64 - OTHER_24X_LINUX - OTHER_24X_LINUX_64 - OTHER_26X_LINUX - OTHER_26X_LINUX_64 - OTHER_3X_LINUX - OTHER_3X_LINUX_64 - OTHER_LINUX - GENERIC_LINUX - OTHER_LINUX_64 - SOLARIS_6 - SOLARIS_7 - SOLARIS_8 - SOLARIS_9 - SOLARIS_10 - SOLARIS_10_64 - SOLARIS_11_64 - OS2 - ECOMSTATION - ECOMSTATION_2 - NETWARE_4 - NETWARE_5 - NETWARE_6 - OPENSERVER_5 - OPENSERVER_6 - UNIXWARE_7 - DARWIN - DARWIN_64 - DARWIN_10 - DARWIN_10_64 - DARWIN_11 - DARWIN_11_64 - DARWIN_12_64 - DARWIN_13_64 - DARWIN_14_64 - DARWIN_15_64 - DARWIN_16_64 - VMKERNEL - VMKERNEL_5 - VMKERNEL_6 - VMKERNEL_65 - OTHER - OTHER_64 - null type: string x-spec-enum-id: c8a1af7d3d87c676 nullable: true cores_per_socket: type: integer maximum: 32767 minimum: 1 description: Number of cores per socket in a VM template: type: string format: uri writeOnly: true nullable: true cluster: type: string format: uri nullable: true datastore: type: string format: uri nullable: true required: - name - project - service_settings OpenStackNestedSecurityGroupRequest: type: object properties: url: type: string format: uri GenericOrderAttributes: type: object description: A generic JSON object for offerings without a predefined schema. Allows any key-value pairs. additionalProperties: true properties: name: type: string description: The name of the resource to be created. Will be displayed in the portal. maxLength: 150 description: type: string description: A free-form description for the resource. securitySchemes: tokenAuth: type: apiKey in: header name: Authorization description: '' waldurCookieAuth: type: apiKey in: cookie name: sessionid description: '' waldurOIDCAuth: type: http scheme: bearer description: '' parameters: Page: name: page required: false in: query description: A page number within the paginated result set. schema: type: integer PageSize: name: page_size required: false in: query description: Number of results to return per page. schema: type: integer headers: XResultCount: description: Total number of results available schema: type: integer example: 42