Autodesk Public Links API

Operations for generating and using OSS signed URLs to share objects across applications.

GitHub OpenAPI

Operations 5

POST /oss/v2/buckets/{bucketKey}/objects/{objectKey}/signed Generate Signed OSS URL #
GET /oss/v2/signedresources/{hash} Download Object Using Signed URL #
PUT /oss/v2/signedresources/{hash} Replace Object Using Signed URL #
DELETE /oss/v2/signedresources/{hash} Delete Object Using Signed URL #
PUT /oss/v2/signedresources/{hash}/resumable Upload Object Using Signed URL #

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-public-links-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-public-links-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: oss Public Links 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: Public Links
  description: Operations for generating and using OSS signed URLs to share objects across applications.
paths:
  /oss/v2/buckets/{bucketKey}/objects/{objectKey}/signed:
    post:
      tags:
      - Public Links
      summary: Generate Signed OSS URL
      description: 'Generates a signed URL for downloading or uploading an object within a specified time limit. If the target object is deleted or expires before the signed URL expires, the URL becomes invalid.


        OSS offers two types of signed URLs:


        - S3 Signed URLs: Enable direct S3 upload/download but are restricted to bucket owners only.

        - OSS Signed URLs (the type generated by this operation): Also support upload/download operations and can be configured for access by other applications, making them ideal for sharing objects across different systems.


        **Important:** Only the application that owns the bucket can generate a signed OSS URL. Once generated, any permitted application can use the signed URL to access the object.'
      operationId: createSignedResource
      parameters:
      - $ref: '#/components/parameters/bucketKey'
      - $ref: '#/components/parameters/objectKey'
      - $ref: '#/components/parameters/access'
      - name: useCdn
        in: query
        description: 'Determines whether the generated signed URL should use a CloudFront URL instead of an Autodesk URL. Possible values:


          - ``true`` : Returns a CloudFront URL to the object instead of an Autodesk URL (one that points to a location on https://developer.api.autodesk.com). Applications can interact with the CloudFront URL exactly like with any classic public resource in OSS. They can use GET requests to download objects or PUT requests to upload objects.

          - ``false`` : (Default) Returns an Autodesk URL (one that points to a location on https://developer.api.autodesk.com) to the object.

          '
        schema:
          type: boolean
      requestBody:
        content:
          application/json:
            examples:
              with-expiration:
                summary: Successful Creation of Signed URL with Expiration Time and Read Access (200)
                value:
                  minutesExpiration: 30
            schema:
              $ref: '#/components/schemas/CreateSignedResourcePayload'
      responses:
        '200':
          description: The signed URL was successfully generated.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/SignedResource'
            application/json:
              examples:
                basic:
                  summary: Successful Creation of Signed URL (200)
                  value:
                    signedUrl: https://developer.api.autodesk.com/oss/v2/apptestbucket/758955fa-58fa-46ba-a906-11fe2a3a1a08?region=US
                    expiration: 1462989939869
                    singleUse: false
                single-use-readwrite:
                  summary: Successful Creation of Signed, Single-Use URL with Expiration Time and Read-Write Access (200)
                  value:
                    signedUrl: https://developer.api.autodesk.com/oss/v2/apptestbucket/9d3be632-a4fc-457d-bc5d-9e75cefc54b7?region=US
                    expiration: 1464141609620
                    singleUse: true
                cloudfront:
                  summary: Successful Creation of Signed, Single-Use URL with Expiration Time using CloudFront (200)
                  value:
                    signedUrl: https://cdn.oss.api.autodesk.com/oss/v2/signedresources/42231c8b-0132-4218-86b2-30c68150697d?region=US
                    expiration: 1464141609620
                    singleUse: true
              schema:
                $ref: '#/components/schemas/SignedResource'
        '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:
        - data:write
      x-codeSamples:
      - lang: cURL
        source: 'curl -v "https://developer.api.autodesk.com/oss/v2/buckets/apptestbucket/objects/test.txt/signed?access=read" -X POST -H "Authorization: Bearer L1yVvPcJDWel0oV3xlYnq7AMZIQE" -H "Content-Type: application/json;charset=UTF-8" --data ''{"minutesExpiration":30}'''
  /oss/v2/signedresources/{hash}:
    parameters:
    - name: hash
      in: path
      description: 'The ID component of the signed URL.


        **Note:** The signed URL returned by [Generate Signed OSS URL](/en/docs/data/v2/reference/http/oss/buckets-:bucketKey-objects-:objectKey-signed-POST/) contains ``hash`` as a URI parameter.

        '
      required: true
      schema:
        type: string
    get:
      tags:
      - Public Links
      summary: Download Object Using Signed URL
      description: 'Downloads an object using an OSS signed URL.


        **Note:** The signed URL returned by Generate Signed OSS URL contains the ``hash`` URI parameter.'
      operationId: getSignedResource
      parameters:
      - name: Range
        in: header
        description: The byte range to download, specified in the form ``bytes=<START_BYTE>-<END_BYTE>``.
        schema:
          pattern: ^bytes=[0-9]+\-[0-9]*$
          type: string
      - $ref: '#/components/parameters/If-None-Match'
      - $ref: '#/components/parameters/If-Modified-Since'
      - name: Accept-Encoding
        in: header
        description: 'The compression format you prefer to receive the data. Possible values are:


          - ``gzip`` - Use the gzip format


          **Note:** You cannot use ``Accept-Encoding:gzip`` with a Range header containing an end byte range. OSS will not honor the End byte range if ``Accept-Encoding: gzip`` header is used.

          '
        schema:
          type: string
      - $ref: '#/components/parameters/region'
      - name: response-content-disposition
        in: query
        description: The value of the Content-Disposition header you want to receive when you download the object using the signed URL. If you do not specify a value, the Content-Disposition header defaults to the value stored with OSS.
        schema:
          type: string
      - name: response-content-type
        in: query
        description: The value of the Content-Type header you want to receive when you download the object using the signed URL. If you do not specify a value, the Content-Type header defaults to the value stored with OSS.
        schema:
          type: string
      responses:
        '200':
          description: The object content was successfully downloaded.
          content:
            application/octet-stream:
              schema:
                type: string
                format: binary
        '206':
          description: Partial content of the object was returned as requested.
          content: {}
        '400':
          $ref: '#/components/responses/BAD_REQUEST'
        '401':
          $ref: '#/components/responses/UNAUTHORIZED'
        '403':
          $ref: '#/components/responses/FORBIDDEN'
        '404':
          $ref: '#/components/responses/NOT_FOUND'
        '416':
          description: The requested range is not valid for this object.
          content: {}
        '500':
          $ref: '#/components/responses/INTERNAL_SERVER_ERROR'
      security:
      - 2-legged:
        - data:read
      x-codeSamples:
      - lang: cURL
        source: curl -v 'https://developer.api.autodesk.com/oss/v2/signedresources/7ffc5eef-1407-4c24-b3f3-3cbfe32a9232?region=US' -X GET
    put:
      tags:
      - Public Links
      summary: Replace Object Using Signed URL
      description: 'Replaces an object that already exists on OSS, using an OSS signed URL.


        The signed URL must fulfil the following conditions:


        - The signed URL is valid (it has not expired as yet).

        - It was generated with ``write`` or ``readwrite`` for the ``access`` parameter.'
      operationId: uploadSignedResource
      parameters:
      - name: Content-Type
        in: header
        description: Must be ``application/x-www-form-urlencoded``.
        required: true
        schema:
          type: string
      - name: Content-Length
        in: header
        description: The size of the data contained in the request body, in bytes.
        required: true
        schema:
          type: integer
          format: int32
      - name: Content-Disposition
        in: header
        description: The suggested file name to use when this object is downloaded as a file.
        schema:
          type: string
      - $ref: '#/components/parameters/x-ads-region'
      - name: If-Match
        in: header
        description: 'The current value of the ``sha1`` attribute of the object you want to replace. OSS checks the ``If-Match`` header against the ``sha1`` attribute of the object in OSS. If they match, OSS allows the object to be overwritten. Otherwise, it means that the object on OSS has been modified since you retrieved the ``sha1`` and the request fails.

          '
        schema:
          type: string
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              required:
              - body
              properties:
                body:
                  type: string
                  description: The object to upload.
                  format: binary
        required: true
      responses:
        '200':
          description: The object was successfully replaced.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ObjectDetails'
            application/json:
              examples:
                success:
                  summary: Successful Upload with Signed URL (200)
                  value:
                    bucketKey: bucketexamplekey
                    objectId: urn:adsk.objects:os.object:bucketexamplekey/testobject
                    objectKey: testobject
                    sha1: 4c33cac14fbb94bd467caa97902aa6550992f0b6
                    size: 31
                    contentType: text/plain; charset=UTF-8
                    location: https://developer.api.autodesk.com/oss/v2/buckets/bucketexamplekey/objects/testobject
              schema:
                $ref: '#/components/schemas/ObjectDetails'
        '400':
          $ref: '#/components/responses/BAD_REQUEST'
        '401':
          $ref: '#/components/responses/UNAUTHORIZED'
        '403':
          $ref: '#/components/responses/FORBIDDEN'
        '404':
          $ref: '#/components/responses/NOT_FOUND'
        '412':
          description: The precondition failed. The value sent for the ``If-Match`` header does not match the ``sha1`` value stored in OSS for this object.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Reason'
            application/json:
              schema:
                $ref: '#/components/schemas/Reason'
        '500':
          $ref: '#/components/responses/INTERNAL_SERVER_ERROR'
      security:
      - 2-legged:
        - data:write
      x-codeSamples:
      - lang: cURL
        source: 'curl -v "https://developer.api.autodesk.com/oss/v2/signedresources/e63f23e2-2486-4f32-a921-bcfe8fade5e3" -X PUT -H "Content-Type: text/plain; charset=UTF-8" --data ''BODY: new file content bytes...'''
    delete:
      tags:
      - Public Links
      summary: Delete Object Using Signed URL
      description: 'Deletes an object using an OSS signed URL.


        Only applications that own the bucket containing the object can call this operation.'
      operationId: deleteSignedResource
      parameters:
      - $ref: '#/components/parameters/x-ads-region'
      responses:
        '200':
          description: The object was deleted successfully.
          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:
        - data:write
      x-codeSamples:
      - lang: cURL
        source: 'curl -v "https://developer.api.autodesk.com/oss/v2/signedresources/322cca8f-4cbf-448f-b70b-55df2597b0d2" -X DELETE -H "Authorization: Bearer tQrZGiR0L1rYRAtEAsGyvA9ZF9Nj"'
  /oss/v2/signedresources/{hash}/resumable:
    put:
      tags:
      - Public Links
      summary: Upload Object Using Signed URL
      description: 'Uploads an object using an OSS signed URL with resumable upload capability. Use this operation to upload an object in chunks.


        **Note:** The signed URL returned by Generate Signed OSS URL contains the ``hash`` as a URI parameter.'
      operationId: uploadSignedResourcesChunk
      parameters:
      - name: hash
        in: path
        description: 'The ID component of the signed URL.


          **Note:** The signed URL returned by [Generate Signed OSS URL](/en/docs/data/v2/reference/http/oss/buckets-:bucketKey-objects-:objectKey-signed-POST/) contains ``hash`` as a URI parameter.

          '
        required: true
        schema:
          type: string
      - name: Content-Type
        in: header
        description: Must be ``application/x-www-form-urlencoded``.
        required: true
        schema:
          type: string
      - name: Content-Range
        in: header
        description: The byte range to upload, specified in the form ``bytes=<START_BYTE>-<END_BYTE>``.
        required: true
        schema:
          pattern: ^bytes [0-9]+\-[0-9]+\/[0-9]+$
          type: string
      - name: Content-Disposition
        in: header
        description: The suggested file name to use when this object is downloaded as a file.
        schema:
          type: string
      - $ref: '#/components/parameters/x-ads-region'
      - name: Session-Id
        in: header
        description: An ID to uniquely identify the file upload session.
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              required:
              - body
              properties:
                body:
                  type: string
                  description: The chunk to upload.
                  format: binary
        required: true
      responses:
        '200':
          description: The object was successfully uploaded.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ObjectDetails'
            application/json:
              examples:
                upload-complete:
                  summary: Upload Complete (200)
                  value:
                    bucketKey: bucketexamplekey
                    objectId: urn:adsk.objects:os.object:bucketexamplekey/testobject
                    objectKey: testobject
                    size: 10
                    contentType: text/plain; charset=UTF-8
                    location: https://developer.api.autodesk.com/oss/v2/buckets/bucketexamplekey/objects/testobject
              schema:
                $ref: '#/components/schemas/ObjectDetails'
        '202':
          description: The upload request was accepted but processing is not yet complete. Call this operation iteratively until a 200 is returned.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Result'
            application/json:
              schema:
                $ref: '#/components/schemas/Result'
        '400':
          $ref: '#/components/responses/BAD_REQUEST'
        '401':
          $ref: '#/components/responses/UNAUTHORIZED'
        '403':
          $ref: '#/components/responses/FORBIDDEN'
        '404':
          $ref: '#/components/responses/NOT_FOUND'
        '409':
          description: CONFLICT, The specified bucket key already exists.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Reason'
            application/json:
              schema:
                $ref: '#/components/schemas/Reason'
        '416':
          description: REQUEST RANGE NOT SATISFIABLE, Missing Content-Range header.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Reason'
            application/json:
              examples:
                overlapping-range:
                  summary: Overlapping Range (416)
                  value:
                    reason: Overlapping Ranges
              schema:
                $ref: '#/components/schemas/Reason'
        '500':
          $ref: '#/components/responses/INTERNAL_SERVER_ERROR'
      security:
      - 2-legged:
        - data:write
      x-codeSamples:
      - lang: cURL
        source: curl -v 'https://developer.api.autodesk.com/oss/v2/signedresources/4ff88e65-e7c0-4b10-bac8-750f48b37cf2/resumable' -X PUT -H 'Content-Type:text/plain; charset=UTF-8' -H 'Content-Range:bytes 0-0/10' -H 'Session-Id:1661831201' --data ' X '
components:
  schemas:
    SignedResource:
      required:
      - expiration
      - signedUrl
      type: object
      description: The response payload for a Generate Signed OSS URL operation.
      properties:
        signedUrl:
          type: string
          description: URL created for downloading the object
        expiration:
          type: integer
          description: Value for expiration in minutes
          format: int64
        allowedIpAddresses:
          type: array
          description: IP addresses that can make a request to this URL.
          items:
            type: string
        singleUse:
          type: boolean
          description: 'Whether the signed URL expires after a single use. Possible values:


            - ``true`` : The signed URL expires immediately after use. For example, when downloading an object, the URL expires once the download is complete.

            - ``false`` : (Default) The signed URL remains usable for the entire time window specified by ``minutesExpiration``.

            '
    ObjectDetails:
      type: object
      properties:
        bucketKey:
          type: string
          description: The bucket key of the bucket that contains the object.
        objectId:
          type: string
          description: An identifier (URN) that uniquely and persistently identifies the object.
        objectKey:
          type: string
          description: A URL-encoded human-friendly name that identifies the object.
        sha1:
          pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
          type: string
          description: A hash value computed from the data of the object.
          format: byte
        size:
          type: integer
          description: The total amount of storage space occupied by the object, in bytes.
          format: int64
        contentType:
          type: string
          description: The format of the data stored within the object, expressed as a MIME type.
        location:
          type: string
          description: A URL that points to the actual location of the object.
      description: Represents an object within a 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.'
    CreateSignedResourcePayload:
      type: object
      description: The request payload for a Generate Signed OSS URL operation.
      properties:
        minutesExpiration:
          type: integer
          description: 'The time window (in minutes) the signed URL will remain usable. Acceptable values = 1-60 minutes. Default = 2 minutes.


            **Tip:** Use the smallest possible time window to minimize exposure of the signed URL.

            '
        singleUse:
          type: boolean
          description: 'Sets whether the signed URL expires after a single use. Possible values:


            - ``true`` : The signed URL expires immediately after use. For example, when downloading an object, the URL expires once the download is complete.

            - ``false`` : (Default) The signed URL remains usable for the entire time window specified by ``minutesExpiration``.

            '
    Access:
      title: Access
      x-stoplight:
        id: e4sb0u69u0uo5
      type: string
      enum:
      - Read
      - Write
      - ReadWrite
      description: 'Possible values:


        - ``Read``

        - ``Write``

        - ``ReadWrite``

        '
    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.
    Result:
      type: object
      description: A response returned by an Upload Object Using Signed URL operation when processing is yet to be completed.
      properties:
        result:
          type: string
          description: A human friendly description of the state of processing.
      required:
      - result
  parameters:
    x-ads-region:
      name: x-ads-region
      in: header
      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:
      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'
    If-Modified-Since:
      name: If-Modified-Since
      in: header
      description: 'A timestamp in the HTTP date format (Mon, DD Month YYYY HH:MM:SS GMT). The requested data is returned only if the object has been modified since the specified timestamp. If not, a 304 (Not Modified) HTTP status is returned.

        '
      schema:
        type: string
        format: date
    bucketKey:
      name: bucketKey
      in: path
      description: The unique ID of the bucket that contains the objects you are operating on. ``bucketKey`` must be URL-encoded.
      required: true
      schema:
        pattern: ^[-_.a-z0-9]{3,128}$
        type: string
    If-None-Match:
      name: If-None-Match
      in: header
      description: The last known ``sha1`` value of the object. OSS returns the requested data only if the ``If-None-Match`` header differs from the ``sha1`` value of the object on OSS, which indicates that the object on OSS is newer. If not, it returns a 304 "Not Modified" HTTP status.
      schema:
        type: string
    access:
      name: access
      in: query
      required: false
      schema:
        $ref: '#/components/schemas/Access'
    objectKey:
      name: objectKey
      in: path
      description: The URL-encoded human friendly name of the object.
      required: true
      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)