Autodesk Buckets API

Bucket related operations

GitHub OpenAPI

Operations 6

GET /oss/v2/buckets List Buckets #
POST /oss/v2/buckets Create Bucket #
DELETE /oss/v2/buckets/{bucketKey} Delete Bucket #
GET /oss/v2/buckets/{bucketKey}/details Get Bucket Details #
POST /oss/v2/buckets/{bucketKey}/transfer Transfer Bucket Ownership #
POST /oss/v2/buckets/{bucketKey}/protect Protect Bucket #

Documentation

📖
Documentation
https://aps.autodesk.com/en/docs/acc/v1/overview/field-guide/issues/
📖
Documentation
https://aps.autodesk.com/developer/overview/autodesk-construction-cloud
📖
Documentation
https://aps.autodesk.com/developer/overview/authentication-api
📖
APIReference
https://aps.autodesk.com/en/docs/oauth/v2/reference/http
📖
GettingStarted
https://aps.autodesk.com/en/docs/oauth/v2/tutorials
📖
Documentation
https://aps.autodesk.com/developer/overview/data-management-api
📖
GettingStarted
https://aps.autodesk.com/en/docs/data/v2/tutorials/
📖
Documentation
https://aps.autodesk.com/developer/overview/model-derivative-api
📖
APIReference
https://aps.autodesk.com/en/docs/model-derivative/v2/reference/
📖
GettingStarted
https://aps.autodesk.com/en/docs/model-derivative/v2/tutorials/
📖
Documentation
https://aps.autodesk.com/developer/overview/automation-api
📖
Documentation
https://aps.autodesk.com/webhooks-api
📖
APIReference
https://aps.autodesk.com/en/docs/webhooks/v1/reference/
📖
GettingStarted
https://aps.autodesk.com/en/docs/webhooks/v1/tutorials/
📖
Documentation
https://aps.autodesk.com/developer/overview/reality-capture-api
📖
GettingStarted
https://aps.autodesk.com/en/docs/reality-capture/v1/tutorials/create-3d-mesh-from-photos/
📖
Documentation
https://aps.autodesk.com/developer/overview/sustainability-data-api
📖
APIReference
https://aps.autodesk.com/en/docs/sustainability/v3/reference/http/
📖
GettingStarted
https://aps.autodesk.com/en/docs/sustainability/v3/tutorials/tutorial_01/
📖
Documentation
https://aps.autodesk.com/developer/overview/parameters-api
📖
GettingStarted
https://aps.autodesk.com/en/docs/parameters/v1/tutorials/getting-started/
📖
Documentation
https://aps.autodesk.com/developer/overview/tandem-data-api
📖
Documentation
https://aps.autodesk.com/developer/overview/flow-graph-engine-api
📖
APIReference
https://aps.autodesk.com/en/docs/flow_graph_engine/v1/reference/quick_reference/
📖
GettingStarted
https://aps.autodesk.com/en/docs/acc/v1/tutorials/admin
📖
APIReference
https://aps.autodesk.com/en/docs/acc/v1/reference
📖
Documentation
https://aps.autodesk.com/developer/overview/bim-360-api
📖
APIReference
https://aps.autodesk.com/en/docs/bim360/v1/reference/
📖
Documentation
https://aps.autodesk.com/en/docs/oauth/v2/reference/http
📖
Documentation
https://aps.autodesk.com/en/docs/data/v2/tutorials/
📖
Documentation
https://aps.autodesk.com/en/docs/acc/v1/tutorials/admin
📖
Documentation
https://aps.autodesk.com/en/docs/model-derivative/v2/reference/
📖
Documentation
https://github.com/autodesk-platform-services/aps-sdk-openapi/tree/main/secureserviceaccount
📖
Documentation
https://aps.autodesk.com/en/docs/webhooks/v1/reference/

Specifications

SDKs

Schemas & Data

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/autodesk:autodesk-buckets-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

autodesk-buckets-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: oss Buckets API
  version: '1.0'
  description: The Object Storage Service (OSS) allows your application to download and upload raw files (such as PDF, XLS, DWG, or RVT) that are managed by the Data service.
  contact:
    name: Autodesk Platform Services
    url: https://aps.autodesk.com/
    email: aps.help@autodesk.com
  termsOfService: https://www.autodesk.com/company/legal-notices-trademarks/terms-of-service-autodesk360-web-services/forge-platform-web-services-api-terms-of-service
  x-support: https://stackoverflow.com/questions/tagged/autodesk-data-management
servers:
- url: https://developer.api.autodesk.com
tags:
- name: Buckets
  description: Bucket related operations
paths:
  /oss/v2/buckets:
    get:
      tags:
      - Buckets
      summary: List Buckets
      description: Retrieves a list of buckets owned by the calling application.
      operationId: getBuckets
      parameters:
      - $ref: '#/components/parameters/region'
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/startAt'
      responses:
        '200':
          description: The list of buckets was successfully retrieved.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/BucketsPage'
            application/json:
              examples:
                basic-list:
                  summary: Basic Successful List Bucket (200)
                  value:
                    items:
                    - bucketKey: 00001fbf-8505-49ab-8a42-44c6a96adbd0
                      createdDate: 1441329298362
                      policyKey: transient
                    - bucketKey: 0003114d
                      createdDate: 1440119769765
                      policyKey: transient
                    - bucketKey: 0003fbc1-389a-4194-915a-38313797d753
                      createdDate: 1453886285506
                      policyKey: transient
                    - bucketKey: 00048aa5
                      createdDate: 1436255268102
                      policyKey: transient
                    - bucketKey: 000524bf
                      createdDate: 1453197455111
                      policyKey: transient
                    - bucketKey: 0006db6d
                      createdDate: 1461978883040
                      policyKey: transient
                    - bucketKey: 00074953-5d83-4aeb-b598-8f727703c94e
                      createdDate: 1447934893704
                      policyKey: transient
                    - bucketKey: 00085601-78b2-44e4-82f3-a252fde022d2
                      createdDate: 1441504885576
                      policyKey: transient
                    - bucketKey: 000b1e61-216e-4480-bcd3-9ec5ca56364f
                      createdDate: 1448268266859
                      policyKey: transient
                    - bucketKey: 000e37cc
                      createdDate: 1437441338604
                      policyKey: transient
                    next: https://developer.api.autodesk.com/oss/v2/buckets?region=US&startAt=000e37cc
              schema:
                $ref: '#/components/schemas/BucketsPage'
        '400':
          $ref: '#/components/responses/BAD_REQUEST'
        '401':
          $ref: '#/components/responses/UNAUTHORIZED'
        '403':
          $ref: '#/components/responses/FORBIDDEN'
        '404':
          $ref: '#/components/responses/NOT_FOUND'
        '500':
          $ref: '#/components/responses/INTERNAL_SERVER_ERROR'
      security:
      - 2-legged:
        - bucket:read
      x-codeSamples:
      - lang: cURL
        source: 'curl -v "https://developer.api.autodesk.com/oss/v2/buckets" -X GET -H "Authorization: Bearer RhS6iEVMnEfl77MBSK3l2je06UHj"'
    post:
      tags:
      - Buckets
      summary: Create Bucket
      description: 'Creates a new bucket.


        Buckets are virtual containers within the Object Storage Service (OSS), which you can use to store and manage objects (files) in the cloud. The application creating the bucket is the owner of the bucket.


        **Note:** Do not use this operation to create buckets for BIM360 Document Management. Use POST projects/{project_id}/storage instead. For details, see Upload Files to BIM 360 Document Management.'
      operationId: createBucket
      parameters:
      - $ref: '#/components/parameters/region_header'
      requestBody:
        content:
          application/json:
            examples:
              success:
                summary: Create bucket - Success (200)
                value:
                  bucketKey: apptestbucket
                  policyKey: transient
            schema:
              $ref: '#/components/schemas/CreateBucketsPayload'
        required: true
      responses:
        '200':
          description: The bucket was successfully created.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Bucket'
            application/json:
              examples:
                success:
                  summary: Create bucket - Success (200)
                  value:
                    bucketKey: apptestbucket
                    bucketOwner: RlKfGlAbb7N8VJwLllOvpfonB1Ex52qG
                    createdDate: 1463785698600
                    permissions:
                    - authId: RlKffonB1Ex52GlAbb7N8VJwLllOvpqG
                      access: full
                    policyKey: transient
              schema:
                $ref: '#/components/schemas/Bucket'
        '400':
          $ref: '#/components/responses/BAD_REQUEST'
        '401':
          $ref: '#/components/responses/UNAUTHORIZED'
        '403':
          $ref: '#/components/responses/FORBIDDEN'
        '409':
          description: The specified bucket key already exists.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Reason'
            application/json:
              examples:
                conflict:
                  summary: Create Bucket - Conflict (409)
                  value:
                    reason: Bucket already exists
              schema:
                $ref: '#/components/schemas/Reason'
        '500':
          $ref: '#/components/responses/INTERNAL_SERVER_ERROR'
      security:
      - 2-legged:
        - bucket:create
      x-codeSamples:
      - lang: cURL
        source: 'curl -v "https://developer.api.autodesk.com/oss/v2/buckets" -X POST -H "Content-Type: application/json" -H "Authorization: Bearer kgEJWMJitdYbhfxghap8SbZqXMoS" -d  ''{"bucketKey":"apptestbucket","policyKey":"transient"}'''
  /oss/v2/buckets/{bucketKey}:
    delete:
      tags:
      - Buckets
      summary: Delete Bucket
      description: '**WARNING:** This operation permanently deletes the specified bucket. It cannot be undone.


        Deletes the specified bucket. Only the application that owns the bucket can call this operation. All other applications that call this operation will receive a "403 Forbidden" error.


        The initial processing of a bucket deletion request can be time-consuming. So, we recommend only deleting buckets containing a few objects, like those typically used for acceptance testing and prototyping.


        **Note:** Bucket keys of deleted buckets will not be immediately available for reuse.


        **Tip:** You can use the Protect Bucket operation to prevent accidental deletion.'
      operationId: deleteBucket
      parameters:
      - name: bucketKey
        in: path
        description: The unique identifier of the bucket to delete.
        required: true
        schema:
          pattern: ^[-_.a-z0-9]{3,128}$
          type: string
      responses:
        '200':
          description: The bucket deletion request was accepted.
          content: {}
        '400':
          description: The request could not be processed due to malformed syntax or missing headers.
          content: {}
        '401':
          $ref: '#/components/responses/UNAUTHORIZED'
        '403':
          $ref: '#/components/responses/FORBIDDEN'
        '404':
          description: The specified ``bucketKey`` does not exist.
          content: {}
        '409':
          description: The specified bucket is already marked for deletion.
          content: {}
        '500':
          $ref: '#/components/responses/INTERNAL_SERVER_ERROR'
      security:
      - 2-legged:
        - bucket:delete
      x-codeSamples:
      - lang: cURL
        source: 'curl -v "https://developer.api.autodesk.com/oss/v2/buckets/bucketexamplekey" -X DELETE -H "Authorization: Bearer kuhodzPEHSCrWH3Pm1WuBMBnxw39"'
  /oss/v2/buckets/{bucketKey}/details:
    get:
      tags:
      - Buckets
      summary: Get Bucket Details
      description: 'Retrieves detailed information about the specified bucket.


        **Note:** Only the application that owns the bucket can call this operation. All other applications that call this operation will receive a "403 Forbidden" error.'
      operationId: getBucketDetails
      parameters:
      - name: bucketKey
        in: path
        description: The unique identifier of the bucket to retrieve details for.
        required: true
        schema:
          pattern: ^[-_.a-z0-9]{3,128}$
          type: string
      responses:
        '200':
          description: The bucket details were successfully retrieved.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Bucket'
            application/json:
              examples:
                success:
                  summary: Successful Bucket Details (200)
                  value:
                    bucketKey: apptestbucket
                    bucketOwner: RlKffonB1Ex52GlAbb7N8VJwLllOvpqG
                    createdDate: 1463785698600
                    permissions:
                    - authId: RlKffonB1Ex52GlAbb7N8VJwLllOvpqG
                      access: full
                    policyKey: transient
              schema:
                $ref: '#/components/schemas/Bucket'
        '400':
          $ref: '#/components/responses/BAD_REQUEST'
        '401':
          $ref: '#/components/responses/UNAUTHORIZED'
        '403':
          $ref: '#/components/responses/FORBIDDEN'
        '404':
          description: The specified ``bucketKey`` does not exist.
          content: {}
        '500':
          $ref: '#/components/responses/INTERNAL_SERVER_ERROR'
      security:
      - 2-legged:
        - bucket:read
        - viewables:read
      x-codeSamples:
      - lang: cURL
        source: 'curl -v "https://developer.api.autodesk.com/oss/v2/buckets/apptestbucket/details" -X GET -H "Authorization: Bearer efxXBK0aTv3MjSSQ6HbDsjnYRmCU" -H "Content-Type: application/json"'
  /oss/v2/buckets/{bucketKey}/transfer:
    post:
      tags:
      - Buckets
      summary: Transfer Bucket Ownership
      description: 'Transfers ownership of a bucket from one application to another.


        Ownership transfer is a two-step process:


        - The current owner initiates the transfer.

        - The target application accepts the transfer.


        Once a transfer is initiated, the bucket enters a transitional state in which both the current owner and the target application have full ownership privileges and can perform the same bucket operations. The only exception is the List Buckets operation, which lists the bucket only for the target application.


        The transfer is completed when the target application accepts the transfer. At that point, the target application becomes the sole owner of the bucket.


        **Note:**


        - Transferring a bucket changes only the bucket owner. Ownership of existing objects within the bucket is not changed.

        - Existing objects retain the ownership metadata of the application that originally uploaded them.

        - After the transfer is completed, the new bucket owner has full access to all objects in the bucket, regardless of the original object owner.

        - Transfer requests do not currently expire. A transfer may remain in the transitional state indefinitely until it is accepted by the target application. However, long-term reliance on this transitional state is not recommended.'
      operationId: transferBucketOwnership
      parameters:
      - name: bucketKey
        in: path
        description: The unique identifier of the bucket whose ownership is being transferred. The bucket key must be URL-encoded.
        required: true
        schema:
          pattern: ^[-_.a-z0-9]{3,128}$
          type: string
      requestBody:
        content:
          application/json:
            examples:
              initiate:
                summary: Transfer Bucket Ownership - Initiate Transfer (200). This example demonstrates successfully initiating the transfer of ownership of a bucket named bucket-to-transfer from one application to another application with the client ID RCLoDyASA82T41wpqYv5b2QrgHrcofVY.
                value:
                  operation: initiate
                  key: RCLoDyASA82T41wpqYv5b2QrgHrcofVY
              cancel:
                summary: Transfer Bucket Ownership - Cancel Transfer (200). This example demonstrates successfully canceling the transfer of ownership of the bucket named bucket-to-transfer.
                value:
                  operation: cancel
              complete:
                summary: Transfer Bucket Ownership - Complete Transfer (200). This example demonstrates successfully accepting the transfer of ownership of the bucket named bucket-to-transfer.
                value:
                  operation: complete
            schema:
              $ref: '#/components/schemas/TransferBucketOwnershipPayload'
        required: true
      responses:
        '200':
          description: The transfer request was successfully accepted by the service.
          content: {}
        '400':
          $ref: '#/components/responses/BAD_REQUEST'
        '401':
          $ref: '#/components/responses/UNAUTHORIZED'
        '403':
          $ref: '#/components/responses/FORBIDDEN'
        '404':
          $ref: '#/components/responses/NOT_FOUND'
        '500':
          $ref: '#/components/responses/INTERNAL_SERVER_ERROR'
      security:
      - 2-legged:
        - bucket:update
      x-codeSamples:
      - lang: cURL
        source: 'curl -v "https://developer.api.autodesk.com/oss/v2/buckets/bucket-to-transfer/transfer" -X POST -H "Authorization: Bearer eyJh..." -H "Content-Type: application/json" --data ''{"operation":"initiate","key":"RCLoDyASA82T41wpqYv5b2QrgHrcofVY"}'''
  /oss/v2/buckets/{bucketKey}/protect:
    post:
      tags:
      - Buckets
      summary: Protect Bucket
      description: 'Modifies the protection status of the specified bucket. When you protect a bucket, it cannot be deleted until you explicitly unprotect it. When you unprotect a bucket, it becomes eligible for deletion again.


        You must be the owner of the bucket or have appropriate permissions to modify bucket protection settings.


        This operation is idempotent. Protecting an already protected bucket or unprotecting an already unprotected bucket will not result in an error.


        The protection status change takes effect immediately upon successful completion of the operation.'
      operationId: protectBucket
      parameters:
      - name: bucketKey
        in: path
        description: The unique identifier of the bucket whose protection status is being modified. The bucket key must be URL-encoded.
        required: true
        schema:
          pattern: ^[-_.a-z0-9]{3,128}$
          type: string
      requestBody:
        content:
          application/json:
            examples:
              protect:
                summary: Basic Successful Protect Bucket (200)
                value:
                  protection: true
              unprotect:
                summary: Basic Successful Unprotect Bucket (200)
                value:
                  protection: false
            schema:
              $ref: '#/components/schemas/ProtectBucketPayload'
        required: true
      responses:
        '200':
          description: The bucket protection status was successfully updated. If protection was set to ``true``, bucket protection is now enabled; if set to ``false``, it is now disabled.
          content:
            text/plain:
              examples:
                protect:
                  summary: Basic Successful Protect Bucket (200)
                  value: Bucket prodbucket_03 protection set to true
                unprotect:
                  summary: Basic Successful Unprotect Bucket (200)
                  value: Bucket prodbucket_03 protection set to false
              schema:
                type: string
                description: Returns a string indicating protection status.
        '400':
          $ref: '#/components/responses/BAD_REQUEST'
        '401':
          $ref: '#/components/responses/UNAUTHORIZED'
        '403':
          $ref: '#/components/responses/FORBIDDEN'
        '404':
          $ref: '#/components/responses/NOT_FOUND'
        '500':
          $ref: '#/components/responses/INTERNAL_SERVER_ERROR'
      security:
      - 2-legged:
        - bucket:update
      x-codeSamples:
      - lang: cURL
        source: 'curl -v "https://developer.api.autodesk.com/oss/v2/buckets/prodbucket_03/protect" -X POST -H "Authorization: Bearer eyJh..." -H "Content-Type: application/json" -H "x-ads-region: US" --data ''{"protection":true}'''
components:
  schemas:
    BucketsPage:
      title: BucketsPage
      required:
      - items
      type: object
      description: An object that represents a collection of buckets.
      properties:
        items:
          type: array
          description: Array of objects, where each object represents a bucket.
          items:
            $ref: '#/components/schemas/BucketsItem'
        next:
          type: string
          description: The URL to be used to retrieve the next page of results, if available. It will be present only when there are more items to be retrieved after the current set.
    PermissionAccess:
      title: PermissionAccess
      x-stoplight:
        id: 5rtb0xo1tipoq
      type: string
      description: 'Specifies the level of permission the application has. Regardless of the permission level, an application can only read, modify, or delete objects it has created. Possible values are:


        - ``read`` - Permission to download objects from the bucket.

        - ``write`` - Permission to upload and replace objects in the bucket.

        - ``full`` - Permission to download, upload, replace, and delete objects in the bucket.

        '
      enum:
      - read
      - write
      - full
    PolicyKey:
      title: PolicyKey
      x-stoplight:
        id: 288f4f38318eb
      type: string
      default: transient
      description: "Specifies the retention policy for the objects stored in the bucket. Possible values are: \n            \n- ``transient`` - Objects are retained for 24 hours.\n- ``temporary`` - Objects are retained for 30 days.\n- ``persistent`` - Objects are retained until they are deleted."
      enum:
      - transient
      - temporary
      - persistent
    CreateBucketsPayloadAllow:
      type: object
      description: An object that represents the permissions allowed for a bucket.
      required:
      - authId
      - access
      properties:
        authId:
          type: string
          description: The Client ID of the application.
        access:
          $ref: '#/components/schemas/AllowAccess'
    Permission:
      type: object
      description: An object representing the permissions for accessing a bucket.
      properties:
        authId:
          type: string
          description: The Client ID of the application.
        access:
          $ref: '#/components/schemas/PermissionAccess'
    BucketsItem:
      required:
      - bucketKey
      - createdDate
      - policyKey
      type: object
      description: An object containing the properties of a bucket.
      properties:
        bucketKey:
          type: string
          description: 'Bucket key: An ID that uniquely identifies the bucket.'
        createdDate:
          type: integer
          description: The time the bucket was created, represented as a Unix timestamp.
          format: int64
        policyKey:
          $ref: '#/components/schemas/PolicyKey'
    ProtectBucketPayload:
      type: object
      description: The request payload for the Set Bucket Protection operation.
      properties:
        protection:
          type: boolean
          description: 'Sets the protection status of the bucket. Possible values:


            - ``true`` : Protects the bucket from accidental deletion.

            - ``false`` : Leaves the bucket unprotected or removes protection from a previously protected bucket.

            '
    Region:
      title: Region
      x-stoplight:
        id: yjjcwdkrxykkc
      type: string
      enum:
      - US
      - EMEA
      - AUS
      - CAN
      - DEU
      - IND
      - JPN
      - GBR
      description: 'Specifies where the bucket containing the object is stored. Possible values are:


        - ``US`` : (Default) Data center for the US region.

        - ``EMEA`` : Data center for the European Union, Middle East, and Africa.

        - ``AUS`` : Data center for Australia.

        - ``CAN`` : Data center for the Canada region.

        - ``DEU`` : Data center for the Germany region.

        - ``IND`` : Data center for the India region.

        - ``JPN`` : Data center for the Japan region.

        - ``GBR`` : Data center for the United Kingdom region.'
    TransferBucketOwnershipPayload:
      type: object
      description: The request payload for the Transfer Bucket Ownership operation.
      required:
      - operation
      properties:
        operation:
          type: string
          enum:
          - initiate
          - complete
          - cancel
          description: 'The transfer operation to perform. Possible values:


            - ``initiate`` : Initiates a bucket ownership transfer by specifying the target application that will become the new owner. This operation can only be performed by the current bucket owner.

            - ``complete`` : Accepts and completes a pending bucket ownership transfer. This operation can only be performed by the target application specified when the transfer was initiated.

            - ``cancel`` : Cancels a pending bucket ownership transfer before it is completed. This operation can be performed by either the current bucket owner or the target application.

            '
        key:
          type: string
          description: 'The client ID of the application that will become the new bucket owner. ``key`` must be specified only when ``operation`` is set to ``initiate``. It must not be specified when ``operation`` is ``complete`` or ``cancel``.


            **Important:** The service does not validate ``key``. If you specify an invalid client ID, the request still returns HTTP status 200. After a successful ``initiate`` request, the bucket enters a transitional state even when ``key`` is invalid.

            '
    Bucket:
      type: object
      description: An object representing a bucket.
      properties:
        bucketKey:
          type: string
          description: 'Bucket key: An ID that uniquely identifies the bucket.'
        bucketOwner:
          type: string
          description: The Client ID of the application that owns the bucket.
        createdDate:
          type: integer
          format: int64
          description: The time the bucket was created, represented as a Unix timestamp.
        permissions:
          type: array
          description: An array of objects, where each object represents an application that can access the bucket.
          items:
            $ref: '#/components/schemas/Permission'
        policyKey:
          $ref: '#/components/schemas/PolicyKey'
    CreateBucketsPayload:
      type: object
      description: The request payload for the Create Bucket operation.
      properties:
        bucketKey:
          type: string
          description: 'Bucket key: A unique name you assign to a bucket. Bucket keys must be globally unique across all applications and regions. They must consist of only lower case characters, numbers 0-9, and underscores (_).


            **Note:** You cannot change a bucket key once the bucket is created.

            '
        allow:
          type: array
          description: An array of objects, where each object represents an application that can access the bucket. A bucket can be accessed by 60 applications in total, including the owner. Because the creating application already counts as one, you can specify up to 59 additional applications.
          items:
            $ref: '#/components/schemas/CreateBucketsPayloadAllow'
        policyKey:
          $ref: '#/components/schemas/PolicyKey'
      required:
      - bucketKey
      - policyKey
    Reason:
      required:
      - reason
      type: object
      properties:
        reason:
          type: string
          description: reason for failure
      description: An object returned with an error describing the reason for failure.
    AllowAccess:
      title: AllowAccess
      x-stoplight:
        id: ljxm7uf2g5rib
      type: string
      enum:
      - read
      - write
      - full
      description: 'Specifies the level of permission the specified application will have. Required when ``allow`` is specified. Regardless of the permission level, an application can only read, modify, or delete objects it has created. Possible values are:


        - ``read`` - Permission to download objects from the bucket.

        - ``write`` - Permission to upload and replace objects in the bucket.

        - ``full`` - Permission to download, upload, replace, and delete objects in the bucket.'
  parameters:
    limit:
      name: limit
      in: query
      description: 'The maximum number of items to return per page. This parameter controls pagination by limiting the size of each response. Acceptable values: 1-100. Default value: 10.

        '
      schema:
        type: integer
        default: 10
        minimum: 1
        maximum: 100
    region:
      name: region
      in: query
      description: 'Specifies where the bucket containing the object is stored. Possible values are:


        - ``US`` : (Default) Data center for the US region.

        - ``EMEA`` : Data center for the European Union, Middle East, and Africa.

        - ``AUS`` : Data center for Australia.

        - ``CAN`` : Data center for the Canada region.

        - ``DEU`` : Data center for the Germany region.

        - ``IND`` : Data center for the India region.

        - ``JPN`` : Data center for the Japan region.

        - ``GBR`` : Data center for the United Kingdom region.'
      schema:
        $ref: '#/components/schemas/Region'
    region_header:
      name: x-ads-region
      in: header
      description: 'Specifies where the bucket must be stored. Possible values are:


        - ``US`` : (Default) Data center for the US region.

        - ``EMEA`` : Data center for the European Union, Middle East, and Africa.

        - ``AUS`` : Data center for Australia.

        - ``CAN`` : Data center for the Canada region.

        - ``DEU`` : Data center for the Germany region.

        - ``IND`` : Data center for the India region.

        - ``JPN`` : Data center for the Japan region.

        - ``GBR`` : Data center for the United Kingdom region.'
      schema:
        $ref: '#/components/schemas/Region'
    startAt:
      name: startAt
      in: query
      description: 'The ID of the last item from the previous result set. Use this parameter to retrieve the next page of results by starting from the item immediately following the specified ID.

        '
      schema:
        type: string
  responses:
    BAD_REQUEST:
      description: OSS was unable to process the request. The syntax of the request is malformed or the request is missing a required header. Do not repeat the request without fixing the issue. The response body may indicate what is wrong with the request
      content: {}
    INTERNAL_SERVER_ERROR:
      description: An unexpected error occurred on the server, preventing it from completing your request. Please try again later. If the issue persists, contact the support team for assistance.
      content: {}
    FORBIDDEN:
      description: The request was successfully validated but lacking the required permissions. Verify your credentials and permissions before you send this request again.
      content: {}
    NOT_FOUND:
      description: The requested resource could not be found. Verify the IDs of the resources you requested before you send this request again.
      content: {}
    UNAUTHORIZED:
      description: The supplied authorization header was not valid or the supplied token scope was not acceptable. Verify authentication and try again.
      content: {}
  securitySchemes:
    oauth2_application:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: /authentication/v1/authenticate
          scopes:
            data:read: The application will be able to read the end user’s data within the Autodesk ecosystem.
            data:write: The application will be able to create, update, and delete data on behalf of the end user within the Autodesk ecosystem.
            data:create: The application will be able to create data on behalf of the end user within the Autodesk ecosystem.
            bucket:delete: The application will be able to delete an OSS bucket it will own.
            bucket:create: The application will be able to create an OSS bucket it will own.
            bucket:read: The application will be able to read the metadata and list contents for OSS buckets that it has access to.
            bucket:update: The application will be able to set permissions and entitlements for OSS buckets that it has permission to modify.
      x-authentication_context: application context required
    3-legged:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://developer.api.autodesk.com/authentication/v2/authorize
          tokenUrl: https://developer.api.autodesk.com/authentication/v2/token
          refreshUrl: https://developer.api.autodesk.com/authentication/v2/token
          scopes:
            data:read: read your data
            data:write: modify your data
            data:create: create new data
      x-authentication_context: user context required
      description: User context required.
    2-legged:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://developer.api.autodesk.com/authentication/v2/token
          scopes:
            data:read: read application accessible data
            data:write: write application accessible data
            data:create: create application accessible data
            bucket:create: create an OSS bucket the application will own
            bucket:read: read the metadata and list contents for OSS buckets the application has access to
            bucket:update: set permissions and entitlements for OSS buckets the application has permission to modify
            bucket:delete: delete an OSS bucket the application owns
            viewables:read: read viewables of application accessible data
      x-authentication_context: application context required
      description: Application context required.
x-provenance:
  method: harvested
  publisher: Autodesk
  source: https://raw.githubusercontent.com/autodesk-platform-services/aps-sdk-openapi/main/oss/oss.yaml
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)