{ "components": { "schemas": { "AccessKey": { "properties": { "displayName": { "example": "****************TGVP", "title": "Displayname", "type": "string" }, "expires": { "example": "2022-12-02T17:23:00.000Z", "nullable": true, "title": "Expires", "type": "string" }, "keyId": { "description": "Identifies the pair of access key and secret access key for deletion", "example": "abcABC_01234-0123456789abcABCabc0123456789==", "title": "Keyid", "type": "string" } }, "required": [ "displayName", "keyId", "expires" ], "title": "AccessKey", "type": "object" }, "Bucket": { "properties": { "name": { "example": "bucket-1", "title": "Name", "type": "string" }, "objectLockEnabled": { "description": "Whether S3 Object Lock is enabled for this bucket", "example": false, "title": "Objectlockenabled", "type": "boolean" }, "region": { "example": "eu01", "title": "Region", "type": "string" }, "urlPathStyle": { "description": "URL in path style", "example": "https://object.storage.eu01.onstackit.cloud/bucket-1", "title": "Urlpathstyle", "type": "string" }, "urlVirtualHostedStyle": { "description": "URL in virtual hosted style", "example": "https://bucket-1.object.storage.eu01.onstackit.cloud", "title": "Urlvirtualhostedstyle", "type": "string" } }, "required": [ "name", "region", "urlPathStyle", "urlVirtualHostedStyle", "objectLockEnabled" ], "title": "Bucket", "type": "object" }, "ComplianceLockResponse": { "properties": { "maxRetentionDays": { "description": "Maximum retention period in days", "example": 365, "title": "Maxretentiondays", "type": "integer" }, "project": { "description": "Project ID", "example": "cd5e788d-5b7b-4ab9-a20d-e790205df10b", "title": "Project", "type": "string" } }, "required": [ "project", "maxRetentionDays" ], "title": "ComplianceLockResponse", "type": "object" }, "CreateAccessKeyPayload": { "properties": { "expires": { "description": "Expiration date. Null means never expires.", "example": "2020-09-04T00:00:00.000Z", "format": "date-time", "nullable": true, "title": "Expires", "type": "string" } }, "title": "CreateAccessKeyRequest", "type": "object" }, "CreateAccessKeyResponse": { "properties": { "accessKey": { "description": "Access key", "example": "AF17TKP7BTQX4HSLOXBA", "title": "Accesskey", "type": "string" }, "displayName": { "description": "Obfuscated access key", "example": "****************OXBA", "title": "Displayname", "type": "string" }, "expires": { "description": "Expiration date. Null means never expires.", "example": "2020-09-04T00:00:00.000Z", "nullable": true, "title": "Expires", "type": "string" }, "keyId": { "description": "Identifies the pair of access key and secret access key for deletion", "example": "abcABC_01234-0123456789abcABCabc0123456789==", "title": "Keyid", "type": "string" }, "project": { "description": "Project ID", "example": "cd5e788d-5b7b-4ab9-a20d-e790205df10b", "title": "Project", "type": "string" }, "secretAccessKey": { "description": "Secret access key", "example": "abcABC+123456789012345678901234567890123", "title": "Secretaccesskey", "type": "string" } }, "required": [ "project", "keyId", "displayName", "expires", "accessKey", "secretAccessKey" ], "title": "CreateAccessKeyResponse", "type": "object" }, "CreateBucketResponse": { "properties": { "bucket": { "description": "Name of the bucket", "example": "bucket-1", "title": "Bucket", "type": "string" }, "project": { "description": "Project ID", "example": "cd5e788d-5b7b-4ab9-a20d-e790205df10b", "title": "Project", "type": "string" } }, "required": [ "project", "bucket" ], "title": "CreateBucketResponse", "type": "object" }, "CreateCredentialsGroupPayload": { "properties": { "displayName": { "description": "Name of the group holding credentials", "example": "group-name-1", "maxLength": 32, "minLength": 1, "title": "Credentials group name", "type": "string" } }, "required": [ "displayName" ], "title": "CreateCredentialsGroupRequest", "type": "object" }, "CreateCredentialsGroupResponse": { "properties": { "credentialsGroup": { "$ref": "#/components/schemas/CredentialsGroup" }, "project": { "description": "Project ID", "example": "cd5e788d-5b7b-4ab9-a20d-e790205df10b", "title": "Project", "type": "string" } }, "required": [ "project", "credentialsGroup" ], "title": "CreateCredentialsGroupResponse", "type": "object" }, "CredentialsGroup": { "properties": { "credentialsGroupId": { "description": "The ID of the credentials group", "example": "3969597f-d2f3-4c07-8533-1a4bf8159c0e", "title": "Credentials group ID", "type": "string" }, "displayName": { "description": "Name of the group holding credentials", "example": "group-name-1", "title": "Credentials group name", "type": "string" }, "urn": { "description": "Credentials group URN", "example": "urn:sgws:identity::12345678901234567890:group/credentials-group-123456", "title": "Urn", "type": "string" } }, "required": [ "credentialsGroupId", "urn", "displayName" ], "title": "CredentialsGroup", "type": "object" }, "CredentialsGroupExtended": { "properties": { "credentialsGroupId": { "description": "The ID of the credentials group", "example": "3969597f-d2f3-4c07-8533-1a4bf8159c0e", "title": "Credentials group ID", "type": "string" }, "displayName": { "description": "Name of the group holding credentials", "example": "group-name-1", "title": "Credentials group name", "type": "string" }, "urn": { "description": "StorageGRID group URN", "example": "urn:sgws:identity::12345678901234567890:group/credentials-group-123456", "title": "Urn", "type": "string" }, "userUrn": { "description": "StorageGRID user URN", "example": "urn:sgws:identity::12345678901234567890:user/credentials-group-123456", "title": "User URN", "type": "string" } }, "required": [ "credentialsGroupId", "urn", "userUrn", "displayName" ], "title": "CredentialsGroupExtended", "type": "object" }, "DefaultRetentionResponse": { "properties": { "bucket": { "description": "Name of the bucket", "example": "bucket-1", "title": "Bucket", "type": "string" }, "days": { "description": "Retention period in days", "example": 90, "title": "Days", "type": "integer" }, "mode": { "$ref": "#/components/schemas/RetentionMode" }, "project": { "description": "Project ID", "example": "cd5e788d-5b7b-4ab9-a20d-e790205df10b", "title": "Project", "type": "string" } }, "required": [ "project", "bucket", "mode", "days" ], "title": "DefaultRetentionResponse", "type": "object" }, "DeleteAccessKeyResponse": { "properties": { "keyId": { "description": "Identifies the pair of access key and secret access key for deletion", "example": "abcABC_01234-0123456789abcABCabc0123456789==", "title": "Keyid", "type": "string" }, "project": { "description": "Project ID", "example": "cd5e788d-5b7b-4ab9-a20d-e790205df10b", "title": "Project", "type": "string" } }, "required": [ "project", "keyId" ], "title": "DeleteAccessKeyResponse", "type": "object" }, "DeleteBucketResponse": { "properties": { "bucket": { "description": "Name of the bucket", "example": "bucket-1", "title": "Bucket", "type": "string" }, "project": { "description": "Project ID", "example": "cd5e788d-5b7b-4ab9-a20d-e790205df10b", "title": "Project", "type": "string" } }, "required": [ "project", "bucket" ], "title": "DeleteBucketResponse", "type": "object" }, "DeleteCredentialsGroupResponse": { "properties": { "credentialsGroupId": { "description": "The ID of the credentials group", "example": "3969597f-d2f3-4c07-8533-1a4bf8159c0e", "title": "Credentials group ID", "type": "string" }, "project": { "description": "Project ID", "example": "cd5e788d-5b7b-4ab9-a20d-e790205df10b", "title": "Project", "type": "string" } }, "required": [ "project", "credentialsGroupId" ], "title": "DeleteCredentialsGroupResponse", "type": "object" }, "DeleteDefaultRetentionResponse": { "properties": { "bucket": { "description": "Name of the bucket", "example": "bucket-1", "title": "Bucket", "type": "string" }, "project": { "description": "Project ID", "example": "cd5e788d-5b7b-4ab9-a20d-e790205df10b", "title": "Project", "type": "string" } }, "required": [ "project", "bucket" ], "title": "DeleteDefaultRetentionResponse", "type": "object" }, "DetailedError": { "properties": { "key": { "example": "example.error_key", "title": "Error Key", "type": "string" }, "msg": { "example": "Some details about the error.", "title": "Error message", "type": "string" } }, "required": [ "key", "msg" ], "title": "DetailedError", "type": "object" }, "ErrorMessage": { "properties": { "detail": { "items": { "$ref": "#/components/schemas/DetailedError" }, "title": "Detail", "type": "array" } }, "required": [ "detail" ], "title": "ErrorMessage", "type": "object" }, "GetBucketResponse": { "properties": { "bucket": { "$ref": "#/components/schemas/Bucket" }, "project": { "description": "Project ID", "example": "cd5e788d-5b7b-4ab9-a20d-e790205df10b", "title": "Project", "type": "string" } }, "required": [ "project", "bucket" ], "title": "GetBucketResponse", "type": "object" }, "GetCredentialsGroupResponse": { "properties": { "credentialsGroup": { "$ref": "#/components/schemas/CredentialsGroupExtended" }, "project": { "description": "Project ID", "example": "cd5e788d-5b7b-4ab9-a20d-e790205df10b", "title": "Project", "type": "string" } }, "required": [ "project", "credentialsGroup" ], "title": "GetCredentialsGroupResponse", "type": "object" }, "HTTPValidationError": { "properties": { "detail": { "items": { "$ref": "#/components/schemas/ValidationError" }, "title": "Detail", "type": "array" } }, "title": "HTTPValidationError", "type": "object" }, "ListAccessKeysResponse": { "properties": { "accessKeys": { "items": { "$ref": "#/components/schemas/AccessKey" }, "title": "Accesskeys", "type": "array" }, "project": { "description": "Project ID", "example": "cd5e788d-5b7b-4ab9-a20d-e790205df10b", "title": "Project", "type": "string" } }, "required": [ "project", "accessKeys" ], "title": "GetAccessKeysResponse", "type": "object" }, "ListBucketsResponse": { "properties": { "buckets": { "items": { "$ref": "#/components/schemas/Bucket" }, "title": "Buckets", "type": "array" }, "project": { "description": "Project ID", "example": "cd5e788d-5b7b-4ab9-a20d-e790205df10b", "title": "Project", "type": "string" } }, "required": [ "project", "buckets" ], "title": "GetBucketsResponse", "type": "object" }, "ListCredentialsGroupsResponse": { "properties": { "credentialsGroups": { "items": { "$ref": "#/components/schemas/CredentialsGroup" }, "title": "Credentialsgroups", "type": "array" }, "project": { "description": "Project ID", "example": "cd5e788d-5b7b-4ab9-a20d-e790205df10b", "title": "Project", "type": "string" } }, "required": [ "project", "credentialsGroups" ], "title": "GetCredentialsGroupsResponse", "type": "object" }, "ProjectScope": { "description": "The scope of a STACKIT project can be public (default) or can have client specific special requirements.", "enum": [ "PUBLIC", "SCHWARZ" ], "title": "ProjectScope", "type": "string" }, "ProjectStatus": { "properties": { "labels": { "additionalProperties": { "type": "string" }, "description": "Project labels", "example": { "contact": "Bob", "environment": "development", "owner": "Alice" }, "title": "Labels", "type": "object" }, "project": { "description": "Project ID", "example": "cd5e788d-5b7b-4ab9-a20d-e790205df10b", "title": "Project", "type": "string" }, "scope": { "allOf": [ { "$ref": "#/components/schemas/ProjectScope" } ], "description": "Project Scope", "example": "PUBLIC" } }, "required": [ "project", "scope" ], "title": "ProjectResponse", "type": "object" }, "RateLimitError": { "properties": { "error": { "example": "Too Many Requests", "title": "Error", "type": "string" }, "message": { "example": "rate limit on IP level exceeded; please try again later", "title": "Message", "type": "string" }, "path": { "example": "/v2/project/66b03760-125b-4c63-9624-741e8a418c02/regions/eu01/bucket/rate-limit-test-mj", "title": "Path", "type": "string" }, "status": { "example": 429, "format": "int32", "title": "Status", "type": "integer" }, "timestamp": { "example": "2026-09-17T10:25:57Z", "format": "date-time", "title": "Timestamp", "type": "string" } }, "title": "RateLimitError", "type": "object" }, "RetentionMode": { "description": "The retention mode for default retention on a bucket.", "enum": [ "COMPLIANCE", "GOVERNANCE" ], "title": "RetentionMode", "type": "string" }, "SetDefaultRetentionPayload": { "properties": { "days": { "description": "Retention period in days", "example": 90, "exclusiveMinimum": true, "minimum": 0, "title": "Days", "type": "integer" }, "mode": { "$ref": "#/components/schemas/RetentionMode" } }, "required": [ "mode", "days" ], "title": "DefaultRetentionRequest", "type": "object" }, "UpdateServicePayload": { "properties": { "labels": { "additionalProperties": { "type": "string" }, "description": "Project labels", "example": { "contact": "Bob", "environment": "development", "owner": "Alice" }, "title": "Labels", "type": "object" } }, "required": [ "labels" ], "title": "PutProjectRequest", "type": "object" }, "ValidationError": { "properties": { "loc": { "items": { "anyOf": [ { "type": "string" }, { "format": "int32", "type": "integer" } ] }, "title": "Location", "type": "array" }, "msg": { "title": "Message", "type": "string" }, "type": { "title": "Error Type", "type": "string" } }, "required": [ "loc", "msg", "type" ], "title": "ValidationError", "type": "object" } } }, "info": { "description": "STACKIT API to manage the Object Storage", "termsOfService": "https://stackit.de/en/imprint", "title": "STACKIT Object Storage API", "version": "2.0.1" }, "openapi": "3.0.2", "paths": { "/v2/project/{projectId}/regions/{region}": { "delete": { "description": "Delete the given project", "operationId": "DisableService", "parameters": [ { "description": "STACKIT project ID", "in": "path", "name": "projectId", "required": true, "schema": { "description": "STACKIT project ID", "example": "cd5e788d-5b7b-4ab9-a20d-e790205df10b", "title": "Project ID", "type": "string" } }, { "description": "STACKIT Region", "in": "path", "name": "region", "required": true, "schema": { "description": "STACKIT Region", "example": "eu01", "title": "STACKIT Region", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectStatus" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } }, "description": "Not Found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } }, "description": "Internal Server Error" } }, "summary": "Delete Project", "x-stackit-authorization": { "actions": [ "object-storage.service.delete" ], "resource-id": "projectId", "resource-id-type": "dynamic", "resource-type": "project" } }, "get": { "description": "Get project details.", "operationId": "GetServiceStatus", "parameters": [ { "description": "STACKIT project ID", "in": "path", "name": "projectId", "required": true, "schema": { "description": "STACKIT project ID", "example": "cd5e788d-5b7b-4ab9-a20d-e790205df10b", "title": "Project ID", "type": "string" } }, { "description": "STACKIT Region", "in": "path", "name": "region", "required": true, "schema": { "description": "STACKIT Region", "example": "eu01", "title": "STACKIT Region", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectStatus" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } }, "description": "Internal Server Error" } }, "summary": "Get Project", "x-stackit-authorization": { "actions": [ "object-storage.service.list" ], "resource-id": "projectId", "resource-id-type": "dynamic", "resource-type": "project" } }, "post": { "description": "Create a project. Creation will also be successful if the project already exists, but will not create a duplicate", "operationId": "EnableService", "parameters": [ { "description": "STACKIT project ID", "in": "path", "name": "projectId", "required": true, "schema": { "description": "STACKIT project ID", "example": "cd5e788d-5b7b-4ab9-a20d-e790205df10b", "title": "Project ID", "type": "string" } }, { "description": "STACKIT Region", "in": "path", "name": "region", "required": true, "schema": { "description": "STACKIT Region", "example": "eu01", "title": "STACKIT Region", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectStatus" } } }, "description": "OK" }, "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectStatus" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } }, "description": "Forbidden" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } }, "description": "Internal Server Error" } }, "summary": "Create Project", "x-stackit-authorization": { "actions": [ "object-storage.service.create" ], "resource-id": "projectId", "resource-id-type": "dynamic", "resource-type": "project" } }, "put": { "description": "Update project details.", "operationId": "UpdateService", "parameters": [ { "description": "STACKIT project ID", "in": "path", "name": "projectId", "required": true, "schema": { "description": "STACKIT project ID", "example": "cd5e788d-5b7b-4ab9-a20d-e790205df10b", "title": "Project ID", "type": "string" } }, { "description": "STACKIT Region", "in": "path", "name": "region", "required": true, "schema": { "description": "STACKIT Region", "example": "eu01", "title": "STACKIT Region", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateServicePayload" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectStatus" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } }, "description": "Internal Server Error" } }, "summary": "Update Project", "x-stackit-authorization": { "actions": [ "object-storage.service.update" ], "resource-id": "projectId", "resource-id-type": "dynamic", "resource-type": "project" } } }, "/v2/project/{projectId}/regions/{region}/access-key": { "post": { "description": "Create an access key for the given project.", "operationId": "CreateAccessKey", "parameters": [ { "description": "STACKIT project ID", "in": "path", "name": "projectId", "required": true, "schema": { "description": "STACKIT project ID", "example": "cd5e788d-5b7b-4ab9-a20d-e790205df10b", "title": "Project ID", "type": "string" } }, { "description": "STACKIT Region", "in": "path", "name": "region", "required": true, "schema": { "description": "STACKIT Region", "example": "eu01", "title": "STACKIT Region", "type": "string" } }, { "in": "query", "name": "credentials-group", "schema": { "maxLength": 36, "minLength": 36, "title": "Credentials-Group", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAccessKeyPayload" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAccessKeyResponse" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } }, "description": "Internal Server Error" } }, "summary": "Create Access Key", "x-stackit-authorization": { "actions": [ "object-storage.access-key.create" ], "resource-id": "projectId", "resource-id-type": "dynamic", "resource-type": "project" } } }, "/v2/project/{projectId}/regions/{region}/access-key/{keyId}": { "delete": { "description": "Delete an access key from the given project.", "operationId": "DeleteAccessKey", "parameters": [ { "description": "STACKIT project ID", "in": "path", "name": "projectId", "required": true, "schema": { "description": "STACKIT project ID", "example": "cd5e788d-5b7b-4ab9-a20d-e790205df10b", "title": "Project ID", "type": "string" } }, { "description": "STACKIT Region", "in": "path", "name": "region", "required": true, "schema": { "description": "STACKIT Region", "example": "eu01", "title": "STACKIT Region", "type": "string" } }, { "description": "Object storage access key", "in": "path", "name": "keyId", "required": true, "schema": { "description": "Object storage access key", "example": "abcABC_01234-0123456789abcABCabc0123456789==", "title": "Key Id", "type": "string" } }, { "in": "query", "name": "credentials-group", "schema": { "maxLength": 36, "minLength": 36, "title": "Credentials-Group", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteAccessKeyResponse" } } }, "description": "Successful Response" }, "307": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } }, "description": "Temporary Redirect" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } }, "description": "Internal Server Error" } }, "summary": "Delete Access Key", "x-stackit-authorization": { "actions": [ "object-storage.access-key.delete" ], "resource-id": "projectId", "resource-id-type": "dynamic", "resource-type": "project" } } }, "/v2/project/{projectId}/regions/{region}/access-keys": { "get": { "description": "Get a list of access keys for the given project.", "operationId": "ListAccessKeys", "parameters": [ { "description": "STACKIT project ID", "in": "path", "name": "projectId", "required": true, "schema": { "description": "STACKIT project ID", "example": "cd5e788d-5b7b-4ab9-a20d-e790205df10b", "title": "Project ID", "type": "string" } }, { "description": "STACKIT Region", "in": "path", "name": "region", "required": true, "schema": { "description": "STACKIT Region", "example": "eu01", "title": "STACKIT Region", "type": "string" } }, { "in": "query", "name": "credentials-group", "schema": { "maxLength": 36, "minLength": 36, "title": "Credentials-Group", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListAccessKeysResponse" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } }, "description": "Internal Server Error" } }, "summary": "Get Access Keys", "x-stackit-authorization": { "actions": [ "object-storage.access-key.list" ], "resource-id": "projectId", "resource-id-type": "dynamic", "resource-type": "project" } } }, "/v2/project/{projectId}/regions/{region}/bucket/{bucketName}": { "delete": { "description": "Delete a bucket from the given project.", "operationId": "DeleteBucket", "parameters": [ { "description": "STACKIT project ID", "in": "path", "name": "projectId", "required": true, "schema": { "description": "STACKIT project ID", "example": "cd5e788d-5b7b-4ab9-a20d-e790205df10b", "title": "Project ID", "type": "string" } }, { "description": "STACKIT Region", "in": "path", "name": "region", "required": true, "schema": { "description": "STACKIT Region", "example": "eu01", "title": "STACKIT Region", "type": "string" } }, { "description": "The name has to be dns-conform.", "in": "path", "name": "bucketName", "required": true, "schema": { "description": "The name has to be dns-conform.", "example": "bucket-1", "maxLength": 63, "minLength": 3, "title": "Bucket Name", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteBucketResponse" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } }, "description": "Internal Server Error" } }, "summary": "Delete Bucket", "x-stackit-authorization": { "actions": [ "object-storage.bucket.delete" ], "resource-id": "projectId", "resource-id-type": "dynamic", "resource-type": "project" } }, "get": { "description": "Get information for the given bucket in the project.", "operationId": "GetBucket", "parameters": [ { "description": "STACKIT project ID", "in": "path", "name": "projectId", "required": true, "schema": { "description": "STACKIT project ID", "example": "cd5e788d-5b7b-4ab9-a20d-e790205df10b", "title": "Project ID", "type": "string" } }, { "description": "STACKIT Region", "in": "path", "name": "region", "required": true, "schema": { "description": "STACKIT Region", "example": "eu01", "title": "STACKIT Region", "type": "string" } }, { "description": "The name has to be dns-conform.", "in": "path", "name": "bucketName", "required": true, "schema": { "description": "The name has to be dns-conform.", "example": "bucket-1", "maxLength": 63, "minLength": 3, "title": "Bucket Name", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetBucketResponse" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } }, "description": "Internal Server Error" } }, "summary": "Get Bucket", "x-stackit-authorization": { "actions": [ "object-storage.bucket.list" ], "resource-id": "projectId", "resource-id-type": "dynamic", "resource-type": "project" } }, "post": { "description": "Create a bucket for the given project. Bucket with the same name cannot already exists in the object storage", "operationId": "CreateBucket", "parameters": [ { "description": "STACKIT project ID", "in": "path", "name": "projectId", "required": true, "schema": { "description": "STACKIT project ID", "example": "cd5e788d-5b7b-4ab9-a20d-e790205df10b", "title": "Project ID", "type": "string" } }, { "description": "STACKIT Region", "in": "path", "name": "region", "required": true, "schema": { "description": "STACKIT Region", "example": "eu01", "title": "STACKIT Region", "type": "string" } }, { "description": "The name has to be dns-conform.", "in": "path", "name": "bucketName", "required": true, "schema": { "description": "The name has to be dns-conform.", "example": "bucket-1", "maxLength": 63, "minLength": 3, "title": "Bucket Name", "type": "string" } }, { "description": "Enable S3 Object Lock on this bucket. Can only be set at creation time. Requires an active project-level compliance lock.", "in": "query", "name": "objectLockEnabled", "schema": { "default": false, "title": "Object Lock Enabled", "type": "boolean" } } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateBucketResponse" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } }, "description": "Not Found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } }, "description": "Internal Server Error" } }, "summary": "Create Bucket", "x-stackit-authorization": { "actions": [ "object-storage.bucket.create" ], "resource-id": "projectId", "resource-id-type": "dynamic", "resource-type": "project" } } }, "/v2/project/{projectId}/regions/{region}/bucket/{bucketName}/default-retention": { "delete": { "description": "Remove the default retention from a bucket. Object Lock itself remains enabled.", "operationId": "DeleteDefaultRetention", "parameters": [ { "description": "STACKIT project ID", "in": "path", "name": "projectId", "required": true, "schema": { "description": "STACKIT project ID", "example": "cd5e788d-5b7b-4ab9-a20d-e790205df10b", "title": "Project ID", "type": "string" } }, { "description": "STACKIT Region", "in": "path", "name": "region", "required": true, "schema": { "description": "STACKIT Region", "example": "eu01", "title": "STACKIT Region", "type": "string" } }, { "description": "The name has to be dns-conform.", "in": "path", "name": "bucketName", "required": true, "schema": { "description": "The name has to be dns-conform.", "example": "bucket-1", "maxLength": 63, "minLength": 3, "title": "Bucket Name", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteDefaultRetentionResponse" } } }, "description": "Successful Response" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } }, "description": "Not Found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } }, "description": "Conflict" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } }, "description": "Internal Server Error" } }, "summary": "Delete Default Retention", "x-stackit-authorization": { "actions": [ "object-storage.bucket.update" ], "resource-id": "projectId", "resource-id-type": "dynamic", "resource-type": "project" } }, "get": { "description": "Get the default retention configuration for a bucket.", "operationId": "GetDefaultRetention", "parameters": [ { "description": "STACKIT project ID", "in": "path", "name": "projectId", "required": true, "schema": { "description": "STACKIT project ID", "example": "cd5e788d-5b7b-4ab9-a20d-e790205df10b", "title": "Project ID", "type": "string" } }, { "description": "STACKIT Region", "in": "path", "name": "region", "required": true, "schema": { "description": "STACKIT Region", "example": "eu01", "title": "STACKIT Region", "type": "string" } }, { "description": "The name has to be dns-conform.", "in": "path", "name": "bucketName", "required": true, "schema": { "description": "The name has to be dns-conform.", "example": "bucket-1", "maxLength": 63, "minLength": 3, "title": "Bucket Name", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DefaultRetentionResponse" } } }, "description": "Successful Response" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } }, "description": "Not Found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } }, "description": "Conflict" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } }, "description": "Internal Server Error" } }, "summary": "Get Default Retention", "x-stackit-authorization": { "actions": [ "object-storage.bucket.list" ], "resource-id": "projectId", "resource-id-type": "dynamic", "resource-type": "project" } }, "put": { "description": "Set or update the default retention for a bucket.", "operationId": "SetDefaultRetention", "parameters": [ { "description": "STACKIT project ID", "in": "path", "name": "projectId", "required": true, "schema": { "description": "STACKIT project ID", "example": "cd5e788d-5b7b-4ab9-a20d-e790205df10b", "title": "Project ID", "type": "string" } }, { "description": "STACKIT Region", "in": "path", "name": "region", "required": true, "schema": { "description": "STACKIT Region", "example": "eu01", "title": "STACKIT Region", "type": "string" } }, { "description": "The name has to be dns-conform.", "in": "path", "name": "bucketName", "required": true, "schema": { "description": "The name has to be dns-conform.", "example": "bucket-1", "maxLength": 63, "minLength": 3, "title": "Bucket Name", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetDefaultRetentionPayload" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DefaultRetentionResponse" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } }, "description": "Bad Request" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } }, "description": "Not Found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } }, "description": "Conflict" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } }, "description": "Internal Server Error" } }, "summary": "Update Default Retention", "x-stackit-authorization": { "actions": [ "object-storage.bucket.update" ], "resource-id": "projectId", "resource-id-type": "dynamic", "resource-type": "project" } } }, "/v2/project/{projectId}/regions/{region}/buckets": { "get": { "description": "Get the list of all buckets in the given project", "operationId": "ListBuckets", "parameters": [ { "description": "STACKIT project ID", "in": "path", "name": "projectId", "required": true, "schema": { "description": "STACKIT project ID", "example": "cd5e788d-5b7b-4ab9-a20d-e790205df10b", "title": "Project ID", "type": "string" } }, { "description": "STACKIT Region", "in": "path", "name": "region", "required": true, "schema": { "description": "STACKIT Region", "example": "eu01", "title": "STACKIT Region", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListBucketsResponse" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } }, "description": "Internal Server Error" } }, "summary": "Get Buckets", "x-stackit-authorization": { "actions": [ "object-storage.bucket.list" ], "resource-id": "projectId", "resource-id-type": "dynamic", "resource-type": "project" } } }, "/v2/project/{projectId}/regions/{region}/compliance-lock": { "delete": { "description": "Remove compliance lock from a project.", "operationId": "DeleteComplianceLock", "parameters": [ { "description": "STACKIT project ID", "in": "path", "name": "projectId", "required": true, "schema": { "description": "STACKIT project ID", "example": "cd5e788d-5b7b-4ab9-a20d-e790205df10b", "title": "Project ID", "type": "string" } }, { "description": "STACKIT Region", "in": "path", "name": "region", "required": true, "schema": { "description": "STACKIT Region", "example": "eu01", "title": "STACKIT Region", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ComplianceLockResponse" } } }, "description": "Successful Response" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } }, "description": "Not Found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } }, "description": "Conflict" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } }, "description": "Internal Server Error" } }, "summary": "Delete Compliance Lock", "x-stackit-authorization": { "actions": [ "object-storage.compliance-lock.delete" ], "resource-id": "projectId", "resource-id-type": "dynamic", "resource-type": "project" } }, "get": { "description": "Get the project-level compliance lock.", "operationId": "GetComplianceLock", "parameters": [ { "description": "STACKIT project ID", "in": "path", "name": "projectId", "required": true, "schema": { "description": "STACKIT project ID", "example": "cd5e788d-5b7b-4ab9-a20d-e790205df10b", "title": "Project ID", "type": "string" } }, { "description": "STACKIT Region", "in": "path", "name": "region", "required": true, "schema": { "description": "STACKIT Region", "example": "eu01", "title": "STACKIT Region", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ComplianceLockResponse" } } }, "description": "Successful Response" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } }, "description": "Not Found" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } }, "description": "Internal Server Error" } }, "summary": "Get Compliance Lock", "x-stackit-authorization": { "actions": [ "object-storage.compliance-lock.list" ], "resource-id": "projectId", "resource-id-type": "dynamic", "resource-type": "project" } }, "post": { "description": "Enable compliance lock for a project.", "operationId": "CreateComplianceLock", "parameters": [ { "description": "STACKIT project ID", "in": "path", "name": "projectId", "required": true, "schema": { "description": "STACKIT project ID", "example": "cd5e788d-5b7b-4ab9-a20d-e790205df10b", "title": "Project ID", "type": "string" } }, { "description": "STACKIT Region", "in": "path", "name": "region", "required": true, "schema": { "description": "STACKIT Region", "example": "eu01", "title": "STACKIT Region", "type": "string" } } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ComplianceLockResponse" } } }, "description": "Successful Response" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } }, "description": "Not Found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } }, "description": "Conflict" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } }, "description": "Internal Server Error" } }, "summary": "Create Compliance Lock", "x-stackit-authorization": { "actions": [ "object-storage.compliance-lock.create" ], "resource-id": "projectId", "resource-id-type": "dynamic", "resource-type": "project" } } }, "/v2/project/{projectId}/regions/{region}/credentials-group": { "post": { "operationId": "CreateCredentialsGroup", "parameters": [ { "description": "STACKIT project ID", "in": "path", "name": "projectId", "required": true, "schema": { "description": "STACKIT project ID", "example": "cd5e788d-5b7b-4ab9-a20d-e790205df10b", "title": "Project ID", "type": "string" } }, { "description": "STACKIT Region", "in": "path", "name": "region", "required": true, "schema": { "description": "STACKIT Region", "example": "eu01", "title": "STACKIT Region", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCredentialsGroupPayload" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCredentialsGroupResponse" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } }, "description": "Not Found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } }, "description": "Internal Server Error" } }, "summary": "Create Credentials Group", "x-stackit-authorization": { "actions": [ "object-storage.credentials-group.create" ], "resource-id": "projectId", "resource-id-type": "dynamic", "resource-type": "project" } } }, "/v2/project/{projectId}/regions/{region}/credentials-group/{groupId}": { "delete": { "description": "Delete a credentials group inside a project if the project exists and no valid access keys are left in the group.", "operationId": "DeleteCredentialsGroup", "parameters": [ { "description": "STACKIT project ID", "in": "path", "name": "projectId", "required": true, "schema": { "description": "STACKIT project ID", "example": "cd5e788d-5b7b-4ab9-a20d-e790205df10b", "title": "Project ID", "type": "string" } }, { "description": "STACKIT Region", "in": "path", "name": "region", "required": true, "schema": { "description": "STACKIT Region", "example": "eu01", "title": "STACKIT Region", "type": "string" } }, { "description": "Id of the credentials group", "in": "path", "name": "groupId", "required": true, "schema": { "description": "Id of the credentials group", "example": "3969597f-d2f3-4c07-8533-1a4bf8159c0e", "title": "Credentials Group Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteCredentialsGroupResponse" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } }, "description": "Internal Server Error" } }, "summary": "Delete Credentials Group", "x-stackit-authorization": { "actions": [ "object-storage.credentials-group.delete" ], "resource-id": "projectId", "resource-id-type": "dynamic", "resource-type": "project" } }, "get": { "description": "Get the details of a single credentials group", "operationId": "GetCredentialsGroup", "parameters": [ { "description": "STACKIT project ID", "in": "path", "name": "projectId", "required": true, "schema": { "description": "STACKIT project ID", "example": "cd5e788d-5b7b-4ab9-a20d-e790205df10b", "title": "Project ID", "type": "string" } }, { "description": "STACKIT Region", "in": "path", "name": "region", "required": true, "schema": { "description": "STACKIT Region", "example": "eu01", "title": "STACKIT Region", "type": "string" } }, { "description": "Id of the credentials group", "in": "path", "name": "groupId", "required": true, "schema": { "description": "Id of the credentials group", "example": "3969597f-d2f3-4c07-8533-1a4bf8159c0e", "title": "Credentials Group Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCredentialsGroupResponse" } } }, "description": "Successful Response" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } }, "description": "Internal Server Error" } }, "summary": "Get Credentials Group", "x-stackit-authorization": { "actions": [ "object-storage.credentials-group.list" ], "resource-id": "projectId", "resource-id-type": "dynamic", "resource-type": "project" } } }, "/v2/project/{projectId}/regions/{region}/credentials-groups": { "get": { "description": "Get credentials groups inside a project if the project exists", "operationId": "ListCredentialsGroups", "parameters": [ { "description": "STACKIT project ID", "in": "path", "name": "projectId", "required": true, "schema": { "description": "STACKIT project ID", "example": "cd5e788d-5b7b-4ab9-a20d-e790205df10b", "title": "Project ID", "type": "string" } }, { "description": "STACKIT Region", "in": "path", "name": "region", "required": true, "schema": { "description": "STACKIT Region", "example": "eu01", "title": "STACKIT Region", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListCredentialsGroupsResponse" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } }, "description": "Internal Server Error" } }, "summary": "Get Credentials Groups", "x-stackit-authorization": { "actions": [ "object-storage.credentials-group.list" ], "resource-id": "projectId", "resource-id-type": "dynamic", "resource-type": "project" } } } }, "servers": [ { "url": "https://object-storage.api.stackit.cloud", "variables": { "region": { "default": "global" } } } ] }