Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Docs
  2. Pulumi Cloud
  3. Pulumi Cloud REST API
  4. Data Export

Data Export

    Data Export allows you to download resource data from Pulumi Cloud for offline analysis or integration with other systems. The Data Export API provides endpoints for exporting resource data in various formats.

    The Data Export API is only available to organizations using the Enterprise and Business Critical editions.

    The Data Export API is currently in preview and subject to change.

    Data Export Operations

    The API provides endpoints for the following operations:

    • Exporting resources in CSV format to download and analyze

    Export Resources

    Export resources matching a given query in CSV format.

    GET /api/orgs/{org}/search/resources/export

    Parameters

    NameInTypeRequiredDescription
    orgpathstringtrueName of the organization to search.
    queryquerystringfalseThe search query to execute. If omitted all resources are returned.
    sortqueryarray[string]falseResults are returned sorted by this field value.
    ascquerybooleanfalseWhether to return results in ascending or descending sort order.
    propertiesquerybooleanfalseWhether to return properties with results.

    Example

    curl \
  -H "Accept: application/vnd.pulumi+6" \
  -H "Content-Type: application/json" \
  -H "Authorization: token $PULUMI_ACCESS_TOKEN" \
  --output resources.csv \
  https://api.pulumi.com/api/orgs/{org}/search/resources/export?query=type:aws:s3/bucket:Bucket

    Example response

    The response is a CSV file with resource information:

    created,custom,delete,id,modified,module,name,package,parent_urn,pending,project,protected,provider_urn,stack,type,urn
2025-02-10T19:34:09.406814916Z,false,false,s3-12345xyz67890pq,2025-02-10T19:34:09.406814916Z,aws,fizzbuzz-s3-bucket,aws,urn:fizzbuzz::example-stack::pulumi:pulumi:Stack::example-stack-fizzbuzz,false,example-stack,false,urn:fizzbuzz::example-stack::pulumi:providers:aws::default_4_16_7::s3-xyzabc-1d2e-3f4g-5h6i7jklm8n9,fizzbuzz,aws:s3/bucket:Bucket,urn:fizzbuzz::example-stack::aws:s3/bucket:Bucket::fizzbuzz-s3-bucket

    Response status codes

    StatusDescription
    200Successful export.
    400Bad request. Not safe to retry.
    402You attempted to use functionality not included in your Pulumi subscription. Not safe to retry.
    422Unprocessable query. Not safe to retry.
    500Server error. Safe to retry.
      OSZAR »