ExportDestination

Update ExportDestination

Update an Export Destination for the given UUID.

Currently, two options for setting up Data Export Destinations are available:

  • S3 buckets on your AWS account.
  • Buckets in your Google Cloud Storage account.

Request and Response schema:

  • Use the selector under the destinationType parameter to expose the relevant request and response schema for the type of Destination.

Request and Response samples:

  • Use the Example selector to show the relevant request and response samples for the type of Destination.
put/organizations/{orgId}/dataexports/destinations/{id}

Path parameters

orgIdstring required

UUID of the organization

idstring required

The UUID of the Export Destination to update.

Request body

OR

Response

Returns the updated Export Destination

OR

Changes

Changed in 3 of the 10 revisions of this API.5109

    • removed ExportDestinationS3Request from the request body oneOf list

      request-body-one-of-removed

    • added ExportDestinationS3Request ExportDestinationGoogleCloudStorageRequest to the request body anyOf list

      request-body-any-of-added

    • added request discriminator

      request-body-discriminator-added

    • added ExportDestinationS3Response ExportDestinationGoogleCloudStorageResponse to the response body anyOf list for the response status 200

      response-body-any-of-added

    • added response discriminator for the response status 200

      response-body-discriminator-added

    • removed ExportDestinationS3Response from the response body oneOf list for the response status 200

      response-body-one-of-removed

    This revision also has 53 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 6c3e1a3cfb8f4103See the full diff
    • added the new required request property oneOf[ExportDestinationS3Request -> subschema #1: ExportDestinationS3Request]/bucketName

      new-required-request-property

    • added the new required request property oneOf[ExportDestinationS3Request -> subschema #1: ExportDestinationS3Request]/iamRoleArn

      new-required-request-property

    • the request's body type/format changed from object/ to /

      request-body-type-changed

    • the response's body type/format changed from object/ to / for status 200

      response-body-type-changed

    • removed AbstractRequest from the request body allOf list

      request-body-all-of-removed

    • removed subschema #3 from the oneOf[ExportDestinationS3Request -> subschema #1: ExportDestinationS3Request]/ request property allOf list

      request-property-all-of-removed

    • removed the request property code

      request-property-removed

    • removed the request property name

      request-property-removed

    • removed the optional property code from the response with the 200 status

      response-optional-property-removed

    • removed the optional property createdBy from the response with the 200 status

      response-optional-property-removed

    • removed the optional property dtCreated from the response with the 200 status

      response-optional-property-removed

    • removed the optional property dtLastModified from the response with the 200 status

      response-optional-property-removed

    • removed the optional property lastModifiedBy from the response with the 200 status

      response-optional-property-removed

    • removed the optional property name from the response with the 200 status

      response-optional-property-removed

    • added the new optional request property oneOf[ExportDestinationS3Request -> subschema #1: ExportDestinationS3Request]/partitionOrder

      new-optional-request-property

    • added the new optional request property oneOf[ExportDestinationS3Request -> subschema #1: ExportDestinationS3Request]/prefix

      new-optional-request-property

    • removed AbstractResponse from the response body allOf list for the response status 200

      response-body-all-of-removed

    • endpoint added

      endpoint-added

    This revision also has 41 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog