The Harness Software Delivery Platform uses OpenAPI Specification v3.0. Harness constantly improves these APIs. Please be aware that some improvements could cause breaking changes.
The Harness API allows you to integrate and use all the services and modules we provide on the Harness Platform. If you use client-side SDKs, Harness functionality can be integrated with your client-side automation, helping you reduce manual efforts and deploy code faster.
The Harness API is a RESTful API that uses standard HTTP verbs. You can send requests in JSON, YAML, or form-data format. The format of the response matches the format of your request. You must send a single request at a time and ensure that you include your authentication key. For more information about this, go to Authentication.
Get started
Before you start integrating, get to know our API better by reading the following topics:
The methods you need to integrate with depend on the functionality you want to use. Work with your Harness Solutions Engineer to determine which methods you need.
Authentication
To authenticate with the Harness API, you need to:
Generate an API token on the Harness Platform.
Send the API token you generate in the x-api-key header in each request.
Generate an API token
To generate an API token, complete the following steps:
Click +API Key, enter a name for your key and then click Save.
Within the API Key tile, click +Token.
Enter a name for your token and click Generate Token. Important: Make sure to save your token securely. Harness does not store the API token for future reference, so make sure to save your token securely before you leave the page.
Send the API token in your requests
Send the token you created in the Harness Platform in the x-api-key header. For example: x-api-key: YOUR_API_KEY_HERE
Requests and Responses
The structure for each request and response is outlined in the API documentation. We have examples in JSON and YAML for every request and response. You can use our online editor to test the examples.
Common Parameters [Beta]
Field Name
Type
Default
Description
identifier
string
none
URL-friendly version of the name, used to identify a resource within it's scope and so needs to be unique within the scope.
name
string
none
Human-friendly name for the resource.
org
string
none
Limit to provided org identifiers.
project
string
none
Limit to provided project identifiers.
description
string
none
More information about the specific resource.
tags
map[string]string
none
List of labels applied to the resource.
order
string
desc
Order to use when sorting the specified fields. Type: enum(asc,desc).
sort
string
none
Fields on which to sort. Note: Specify the fields that you want to use for sorting. When doing so, consider the operational overhead of sorting fields.
limit
int
30
Pagination: Number of items to return.
page
int
1
Pagination page number strategy: Specify the page number within the paginated collection related to the number of items in each page.
created
int64
none
Unix timestamp that shows when the resource was created (in milliseconds).
updated
int64
none
Unix timestamp that shows when the resource was last edited (in milliseconds).
Status Codes
Harness uses conventional HTTP status codes to indicate the status of an API request. Generally, 2xx responses are reserved for success and 4xx status codes are reserved for failures. A 5xx response code indicates an error on the Harness server.
The current version of our Beta APIs is yet to be announced. The version number will use the date-header format and will be valid only for our Beta APIs.
Generation
All our beta APIs are versioned as a Generation, and this version is included in the path to every API resource. For example, v1 beta APIs begin with app.harness.io/v1/, where v1 is the API Generation.
The version number represents the core API and does not change frequently. The version number changes only if there is a significant departure from the basic underpinnings of the existing API. For example, when Harness performs a system-wide refactoring of core concepts or resources.
Pagination [Beta]
We use pagination to place limits on the number of responses associated with list endpoints. Pagination is achieved by the use of limit query parameters. The limit defaults to 30. Its maximum value is 100.
Following are the pagination headers supported in the response bodies of paginated APIs:
X-Total-Elements : Indicates the total number of entries in a paginated response.
X-Page-Number : Indicates the page number currently returned for a paginated response.
X-Page-Size : Indicates the number of entries per page for a paginated response.
Create and manage organizations in your account. You use organizations to group together related projects. For example, you can use an organization to group together projects within a business unit or division.
APIs for managing catalog Entities which represent the core components of your system. Entities can represent services, APIs, user groups, resources, and more. These endpoints allow you to create, retrieve, update, delete, and query entities across different scopes.
curl -i -X GET \ https://app.harness.io/iacm/api/orgs/7/projects/if/executions/v/cost-changes-all-stages \ -H 'Harness-Account: l' \ -H 'x-api-key: YOUR_API_KEY_HERE'
Responses
OK response.
Bodyapplication/jsonArray [
currencystringrequired
Currency of the costs
Example: "Totam maxime quis debitis nulla ad."
diffobjectrequired
Map of the type of resources and their costs.
Example: {"Autem voluptatem.":{"current_monthly_cost":"Voluptatum atque cumque quas non atque quis.","diff":[{"current_monthly_cost":"Ullam et tempore autem.","diff_monthly_cost":"Sint enim.","name":"Nihil in est.","percentage_change_monthly_cost":1269200476744766700,"previous_monthly_cost":"Totam ab qui.","subresources":{"Aut suscipit et voluptatem qui sit iste.":{"current_monthly_cost":"Ad cupiditate tempore voluptas occaecati ut assumenda.","diff_monthly_cost":"Fuga earum et qui exercitationem accusantium porro.","percentage_change_monthly_cost":3777858026042693600,"previous_monthly_cost":"Minima magnam repellat error."}}},{"current_monthly_cost":"Ullam et tempore autem.","diff_monthly_cost":"Sint enim.","name":"Nihil in est.","percentage_change_monthly_cost":1269200476744766700,"previous_monthly_cost":"Totam ab qui.","subresources":{"Aut suscipit et voluptatem qui sit iste.":{"current_monthly_cost":"Ad cupiditate tempore voluptas occaecati ut assumenda.","diff_monthly_cost":"Fuga earum et qui exercitationem accusantium porro.","percentage_change_monthly_cost":3777858026042693600,"previous_monthly_cost":"Minima magnam repellat error."}}},{"current_monthly_cost":"Ullam et tempore autem.","diff_monthly_cost":"Sint enim.","name":"Nihil in est.","percentage_change_monthly_cost":1269200476744766700,"previous_monthly_cost":"Totam ab qui.","subresources":{"Aut suscipit et voluptatem qui sit iste.":{"current_monthly_cost":"Ad cupiditate tempore voluptas occaecati ut assumenda.","diff_monthly_cost":"Fuga earum et qui exercitationem accusantium porro.","percentage_change_monthly_cost":3777858026042693600,"previous_monthly_cost":"Minima magnam repellat error."}}},{"current_monthly_cost":"Ullam et tempore autem.","diff_monthly_cost":"Sint enim.","name":"Nihil in est.","percentage_change_monthly_cost":1269200476744766700,"previous_monthly_cost":"Totam ab qui.","subresources":{"Aut suscipit et voluptatem qui sit iste.":{"current_monthly_cost":"Ad cupiditate tempore voluptas occaecati ut assumenda.","diff_monthly_cost":"Fuga earum et qui exercitationem accusantium porro.","percentage_change_monthly_cost":3777858026042693600,"previous_monthly_cost":"Minima magnam repellat error."}}}],"diff_monthly_cost":"Sequi enim tempore et.","percentage_change_monthly_cost":2935345335961017000,"previous_monthly_cost":"Hic qui eum reiciendis iusto."}}
Example: {"current_monthly_cost":"Saepe non dolorem dicta expedita asperiores.","diff":[{"current_monthly_cost":"Ullam et tempore autem.","diff_monthly_cost":"Sint enim.","name":"Nihil in est.","percentage_change_monthly_cost":1269200476744766700,"previous_monthly_cost":"Totam ab qui.","subresources":{"Aut suscipit et voluptatem qui sit iste.":{"current_monthly_cost":"Ad cupiditate tempore voluptas occaecati ut assumenda.","diff_monthly_cost":"Fuga earum et qui exercitationem accusantium porro.","percentage_change_monthly_cost":3777858026042693600,"previous_monthly_cost":"Minima magnam repellat error."}}},{"current_monthly_cost":"Ullam et tempore autem.","diff_monthly_cost":"Sint enim.","name":"Nihil in est.","percentage_change_monthly_cost":1269200476744766700,"previous_monthly_cost":"Totam ab qui.","subresources":{"Aut suscipit et voluptatem qui sit iste.":{"current_monthly_cost":"Ad cupiditate tempore voluptas occaecati ut assumenda.","diff_monthly_cost":"Fuga earum et qui exercitationem accusantium porro.","percentage_change_monthly_cost":3777858026042693600,"previous_monthly_cost":"Minima magnam repellat error."}}},{"current_monthly_cost":"Ullam et tempore autem.","diff_monthly_cost":"Sint enim.","name":"Nihil in est.","percentage_change_monthly_cost":1269200476744766700,"previous_monthly_cost":"Totam ab qui.","subresources":{"Aut suscipit et voluptatem qui sit iste.":{"current_monthly_cost":"Ad cupiditate tempore voluptas occaecati ut assumenda.","diff_monthly_cost":"Fuga earum et qui exercitationem accusantium porro.","percentage_change_monthly_cost":3777858026042693600,"previous_monthly_cost":"Minima magnam repellat error."}}},{"current_monthly_cost":"Ullam et tempore autem.","diff_monthly_cost":"Sint enim.","name":"Nihil in est.","percentage_change_monthly_cost":1269200476744766700,"previous_monthly_cost":"Totam ab qui.","subresources":{"Aut suscipit et voluptatem qui sit iste.":{"current_monthly_cost":"Ad cupiditate tempore voluptas occaecati ut assumenda.","diff_monthly_cost":"Fuga earum et qui exercitationem accusantium porro.","percentage_change_monthly_cost":3777858026042693600,"previous_monthly_cost":"Minima magnam repellat error."}}}],"diff_monthly_cost":"Impedit ipsam qui quod expedita consectetur.","percentage_change_monthly_cost":1664291418724379100,"previous_monthly_cost":"Exercitationem sequi vitae corrupti rerum in iste."}
diff_total_monthly_coststringrequired
Difference of cost between workspaces per month
Example: "Quisquam ab."
past_total_monthly_coststringrequired
Total cost of the resources per month for the last workspace
The change between the costs per month represented as a percentage
Example: 4429101276270360600
stage_execution_idstringrequired
The stage execution ID
Example: "Voluptatem eius."
stage_idstringrequired
The stage ID
Example: "Dolor repellendus."
total_monthly_coststringrequired
Total cost of the resources per month
Example: "Fugit praesentium quia."
workspace_idstringrequired
The workspace identifier
Example: "Maiores voluptas."
]
Response
application/json
[
{
"currency": "Nostrum provident aliquam.",
"diff": { … },
"diff_total_monthly_cost": "Officiis praesentium et distinctio magni voluptas magni.",
"past_total_monthly_cost": "Consequuntur vel nam et.",
"percentage_change_total_monthly_cost": 3061502594466213000,
"stage_execution_id": "Repudiandae maiores magnam tenetur.",
"stage_id": "At vitae reprehenderit dolorem voluptates.",
"total_monthly_cost": "Odio ea dolores perferendis eos esse ut.",
"workspace_id": "Atque omnis ut voluptatem qui commodi eos."
},
{
"currency": "Nostrum provident aliquam.",
"diff": { … },
"diff_total_monthly_cost": "Officiis praesentium et distinctio magni voluptas magni.",
"past_total_monthly_cost": "Consequuntur vel nam et.",
"percentage_change_total_monthly_cost": 3061502594466213000,
"stage_execution_id": "Repudiandae maiores magnam tenetur.",
"stage_id": "At vitae reprehenderit dolorem voluptates.",
"total_monthly_cost": "Odio ea dolores perferendis eos esse ut.",
"workspace_id": "Atque omnis ut voluptatem qui commodi eos."
},
{
"currency": "Nostrum provident aliquam.",
"diff": { … },
"diff_total_monthly_cost": "Officiis praesentium et distinctio magni voluptas magni.",
"past_total_monthly_cost": "Consequuntur vel nam et.",
"percentage_change_total_monthly_cost": 3061502594466213000,
"stage_execution_id": "Repudiandae maiores magnam tenetur.",
"stage_id": "At vitae reprehenderit dolorem voluptates.",
"total_monthly_cost": "Odio ea dolores perferendis eos esse ut.",
"workspace_id": "Atque omnis ut voluptatem qui commodi eos."
}
]
Example: {"Hic nisi aliquam eum cupiditate voluptates sed.":{"currency":"Nostrum provident aliquam.","diff":{"Corporis architecto beatae ea quis quo sint.":{"current_monthly_cost":"Voluptatum atque cumque quas non atque quis.","diff":[{"current_monthly_cost":"Ullam et tempore autem.","diff_monthly_cost":"Sint enim.","name":"Nihil in est.","percentage_change_monthly_cost":1269200476744766700,"previous_monthly_cost":"Totam ab qui.","subresources":{"Aut suscipit et voluptatem qui sit iste.":{"current_monthly_cost":"Ad cupiditate tempore voluptas occaecati ut assumenda.","diff_monthly_cost":"Fuga earum et qui exercitationem accusantium porro.","percentage_change_monthly_cost":3777858026042693600,"previous_monthly_cost":"Minima magnam repellat error."}}},{"current_monthly_cost":"Ullam et tempore autem.","diff_monthly_cost":"Sint enim.","name":"Nihil in est.","percentage_change_monthly_cost":1269200476744766700,"previous_monthly_cost":"Totam ab qui.","subresources":{"Aut suscipit et voluptatem qui sit iste.":{"current_monthly_cost":"Ad cupiditate tempore voluptas occaecati ut assumenda.","diff_monthly_cost":"Fuga earum et qui exercitationem accusantium porro.","percentage_change_monthly_cost":3777858026042693600,"previous_monthly_cost":"Minima magnam repellat error."}}},{"current_monthly_cost":"Ullam et tempore autem.","diff_monthly_cost":"Sint enim.","name":"Nihil in est.","percentage_change_monthly_cost":1269200476744766700,"previous_monthly_cost":"Totam ab qui.","subresources":{"Aut suscipit et voluptatem qui sit iste.":{"current_monthly_cost":"Ad cupiditate tempore voluptas occaecati ut assumenda.","diff_monthly_cost":"Fuga earum et qui exercitationem accusantium porro.","percentage_change_monthly_cost":3777858026042693600,"previous_monthly_cost":"Minima magnam repellat error."}}},{"current_monthly_cost":"Ullam et tempore autem.","diff_monthly_cost":"Sint enim.","name":"Nihil in est.","percentage_change_monthly_cost":1269200476744766700,"previous_monthly_cost":"Totam ab qui.","subresources":{"Aut suscipit et voluptatem qui sit iste.":{"current_monthly_cost":"Ad cupiditate tempore voluptas occaecati ut assumenda.","diff_monthly_cost":"Fuga earum et qui exercitationem accusantium porro.","percentage_change_monthly_cost":3777858026042693600,"previous_monthly_cost":"Minima magnam repellat error."}}}],"diff_monthly_cost":"Sequi enim tempore et.","percentage_change_monthly_cost":2935345335961017000,"previous_monthly_cost":"Hic qui eum reiciendis iusto."},"Non voluptatem.":{"current_monthly_cost":"Voluptatum atque cumque quas non atque quis.","diff":[{"current_monthly_cost":"Ullam et tempore autem.","diff_monthly_cost":"Sint enim.","name":"Nihil in est.","percentage_change_monthly_cost":1269200476744766700,"previous_monthly_cost":"Totam ab qui.","subresources":{"Aut suscipit et voluptatem qui sit iste.":{"current_monthly_cost":"Ad cupiditate tempore voluptas occaecati ut assumenda.","diff_monthly_cost":"Fuga earum et qui exercitationem accusantium porro.","percentage_change_monthly_cost":3777858026042693600,"previous_monthly_cost":"Minima magnam repellat error."}}},{"current_monthly_cost":"Ullam et tempore autem.","diff_monthly_cost":"Sint enim.","name":"Nihil in est.","percentage_change_monthly_cost":1269200476744766700,"previous_monthly_cost":"Totam ab qui.","subresources":{"Aut suscipit et voluptatem qui sit iste.":{"current_monthly_cost":"Ad cupiditate tempore voluptas occaecati ut assumenda.","diff_monthly_cost":"Fuga earum et qui exercitationem accusantium porro.","percentage_change_monthly_cost":3777858026042693600,"previous_monthly_cost":"Minima magnam repellat error."}}},{"current_monthly_cost":"Ullam et tempore autem.","diff_monthly_cost":"Sint enim.","name":"Nihil in est.","percentage_change_monthly_cost":1269200476744766700,"previous_monthly_cost":"Totam ab qui.","subresources":{"Aut suscipit et voluptatem qui sit iste.":{"current_monthly_cost":"Ad cupiditate tempore voluptas occaecati ut assumenda.","diff_monthly_cost":"Fuga earum et qui exercitationem accusantium porro.","percentage_change_monthly_cost":3777858026042693600,"previous_monthly_cost":"Minima magnam repellat error."}}},{"current_monthly_cost":"Ullam et tempore autem.","diff_monthly_cost":"Sint enim.","name":"Nihil in est.","percentage_change_monthly_cost":1269200476744766700,"previous_monthly_cost":"Totam ab qui.","subresources":{"Aut suscipit et voluptatem qui sit iste.":{"current_monthly_cost":"Ad cupiditate tempore voluptas occaecati ut assumenda.","diff_monthly_cost":"Fuga earum et qui exercitationem accusantium porro.","percentage_change_monthly_cost":3777858026042693600,"previous_monthly_cost":"Minima magnam repellat error."}}}],"diff_monthly_cost":"Sequi enim tempore et.","percentage_change_monthly_cost":2935345335961017000,"previous_monthly_cost":"Hic qui eum reiciendis iusto."},"Omnis deserunt error nobis in corrupti.":{"current_monthly_cost":"Voluptatum atque cumque quas non atque quis.","diff":[{"current_monthly_cost":"Ullam et tempore autem.","diff_monthly_cost":"Sint enim.","name":"Nihil in est.","percentage_change_monthly_cost":1269200476744766700,"previous_monthly_cost":"Totam ab qui.","subresources":{"Aut suscipit et voluptatem qui sit iste.":{"current_monthly_cost":"Ad cupiditate tempore voluptas occaecati ut assumenda.","diff_monthly_cost":"Fuga earum et qui exercitationem accusantium porro.","percentage_change_monthly_cost":3777858026042693600,"previous_monthly_cost":"Minima magnam repellat error."}}},{"current_monthly_cost":"Ullam et tempore autem.","diff_monthly_cost":"Sint enim.","name":"Nihil in est.","percentage_change_monthly_cost":1269200476744766700,"previous_monthly_cost":"Totam ab qui.","subresources":{"Aut suscipit et voluptatem qui sit iste.":{"current_monthly_cost":"Ad cupiditate tempore voluptas occaecati ut assumenda.","diff_monthly_cost":"Fuga earum et qui exercitationem accusantium porro.","percentage_change_monthly_cost":3777858026042693600,"previous_monthly_cost":"Minima magnam repellat error."}}},{"current_monthly_cost":"Ullam et tempore autem.","diff_monthly_cost":"Sint enim.","name":"Nihil in est.","percentage_change_monthly_cost":1269200476744766700,"previous_monthly_cost":"Totam ab qui.","subresources":{"Aut suscipit et voluptatem qui sit iste.":{"current_monthly_cost":"Ad cupiditate tempore voluptas occaecati ut assumenda.","diff_monthly_cost":"Fuga earum et qui exercitationem accusantium porro.","percentage_change_monthly_cost":3777858026042693600,"previous_monthly_cost":"Minima magnam repellat error."}}},{"current_monthly_cost":"Ullam et tempore autem.","diff_monthly_cost":"Sint enim.","name":"Nihil in est.","percentage_change_monthly_cost":1269200476744766700,"previous_monthly_cost":"Totam ab qui.","subresources":{"Aut suscipit et voluptatem qui sit iste.":{"current_monthly_cost":"Ad cupiditate tempore voluptas occaecati ut assumenda.","diff_monthly_cost":"Fuga earum et qui exercitationem accusantium porro.","percentage_change_monthly_cost":3777858026042693600,"previous_monthly_cost":"Minima magnam repellat error."}}}],"diff_monthly_cost":"Sequi enim tempore et.","percentage_change_monthly_cost":2935345335961017000,"previous_monthly_cost":"Hic qui eum reiciendis iusto."}},"diff_total_monthly_cost":"Officiis praesentium et distinctio magni voluptas magni.","past_total_monthly_cost":"Consequuntur vel nam et.","percentage_change_total_monthly_cost":3061502594466213000,"stage_execution_id":"Repudiandae maiores magnam tenetur.","stage_id":"At vitae reprehenderit dolorem voluptates.","total_monthly_cost":"Odio ea dolores perferendis eos esse ut.","workspace_id":"Atque omnis ut voluptatem qui commodi eos."},"Molestiae sequi veniam qui delectus aut.":{"currency":"Nostrum provident aliquam.","diff":{"Corporis architecto beatae ea quis quo sint.":{"current_monthly_cost":"Voluptatum atque cumque quas non atque quis.","diff":[{"current_monthly_cost":"Ullam et tempore autem.","diff_monthly_cost":"Sint enim.","name":"Nihil in est.","percentage_change_monthly_cost":1269200476744766700,"previous_monthly_cost":"Totam ab qui.","subresources":{"Aut suscipit et voluptatem qui sit iste.":{"current_monthly_cost":"Ad cupiditate tempore voluptas occaecati ut assumenda.","diff_monthly_cost":"Fuga earum et qui exercitationem accusantium porro.","percentage_change_monthly_cost":3777858026042693600,"previous_monthly_cost":"Minima magnam repellat error."}}},{"current_monthly_cost":"Ullam et tempore autem.","diff_monthly_cost":"Sint enim.","name":"Nihil in est.","percentage_change_monthly_cost":1269200476744766700,"previous_monthly_cost":"Totam ab qui.","subresources":{"Aut suscipit et voluptatem qui sit iste.":{"current_monthly_cost":"Ad cupiditate tempore voluptas occaecati ut assumenda.","diff_monthly_cost":"Fuga earum et qui exercitationem accusantium porro.","percentage_change_monthly_cost":3777858026042693600,"previous_monthly_cost":"Minima magnam repellat error."}}},{"current_monthly_cost":"Ullam et tempore autem.","diff_monthly_cost":"Sint enim.","name":"Nihil in est.","percentage_change_monthly_cost":1269200476744766700,"previous_monthly_cost":"Totam ab qui.","subresources":{"Aut suscipit et voluptatem qui sit iste.":{"current_monthly_cost":"Ad cupiditate tempore voluptas occaecati ut assumenda.","diff_monthly_cost":"Fuga earum et qui exercitationem accusantium porro.","percentage_change_monthly_cost":3777858026042693600,"previous_monthly_cost":"Minima magnam repellat error."}}},{"current_monthly_cost":"Ullam et tempore autem.","diff_monthly_cost":"Sint enim.","name":"Nihil in est.","percentage_change_monthly_cost":1269200476744766700,"previous_monthly_cost":"Totam ab qui.","subresources":{"Aut suscipit et voluptatem qui sit iste.":{"current_monthly_cost":"Ad cupiditate tempore voluptas occaecati ut assumenda.","diff_monthly_cost":"Fuga earum et qui exercitationem accusantium porro.","percentage_change_monthly_cost":3777858026042693600,"previous_monthly_cost":"Minima magnam repellat error."}}}],"diff_monthly_cost":"Sequi enim tempore et.","percentage_change_monthly_cost":2935345335961017000,"previous_monthly_cost":"Hic qui eum reiciendis iusto."},"Non voluptatem.":{"current_monthly_cost":"Voluptatum atque cumque quas non atque quis.","diff":[{"current_monthly_cost":"Ullam et tempore autem.","diff_monthly_cost":"Sint enim.","name":"Nihil in est.","percentage_change_monthly_cost":1269200476744766700,"previous_monthly_cost":"Totam ab qui.","subresources":{"Aut suscipit et voluptatem qui sit iste.":{"current_monthly_cost":"Ad cupiditate tempore voluptas occaecati ut assumenda.","diff_monthly_cost":"Fuga earum et qui exercitationem accusantium porro.","percentage_change_monthly_cost":3777858026042693600,"previous_monthly_cost":"Minima magnam repellat error."}}},{"current_monthly_cost":"Ullam et tempore autem.","diff_monthly_cost":"Sint enim.","name":"Nihil in est.","percentage_change_monthly_cost":1269200476744766700,"previous_monthly_cost":"Totam ab qui.","subresources":{"Aut suscipit et voluptatem qui sit iste.":{"current_monthly_cost":"Ad cupiditate tempore voluptas occaecati ut assumenda.","diff_monthly_cost":"Fuga earum et qui exercitationem accusantium porro.","percentage_change_monthly_cost":3777858026042693600,"previous_monthly_cost":"Minima magnam repellat error."}}},{"current_monthly_cost":"Ullam et tempore autem.","diff_monthly_cost":"Sint enim.","name":"Nihil in est.","percentage_change_monthly_cost":1269200476744766700,"previous_monthly_cost":"Totam ab qui.","subresources":{"Aut suscipit et voluptatem qui sit iste.":{"current_monthly_cost":"Ad cupiditate tempore voluptas occaecati ut assumenda.","diff_monthly_cost":"Fuga earum et qui exercitationem accusantium porro.","percentage_change_monthly_cost":3777858026042693600,"previous_monthly_cost":"Minima magnam repellat error."}}},{"current_monthly_cost":"Ullam et tempore autem.","diff_monthly_cost":"Sint enim.","name":"Nihil in est.","percentage_change_monthly_cost":1269200476744766700,"previous_monthly_cost":"Totam ab qui.","subresources":{"Aut suscipit et voluptatem qui sit iste.":{"current_monthly_cost":"Ad cupiditate tempore voluptas occaecati ut assumenda.","diff_monthly_cost":"Fuga earum et qui exercitationem accusantium porro.","percentage_change_monthly_cost":3777858026042693600,"previous_monthly_cost":"Minima magnam repellat error."}}}],"diff_monthly_cost":"Sequi enim tempore et.","percentage_change_monthly_cost":2935345335961017000,"previous_monthly_cost":"Hic qui eum reiciendis iusto."},"Omnis deserunt error nobis in corrupti.":{"current_monthly_cost":"Voluptatum atque cumque quas non atque quis.","diff":[{"current_monthly_cost":"Ullam et tempore autem.","diff_monthly_cost":"Sint enim.","name":"Nihil in est.","percentage_change_monthly_cost":1269200476744766700,"previous_monthly_cost":"Totam ab qui.","subresources":{"Aut suscipit et voluptatem qui sit iste.":{"current_monthly_cost":"Ad cupiditate tempore voluptas occaecati ut assumenda.","diff_monthly_cost":"Fuga earum et qui exercitationem accusantium porro.","percentage_change_monthly_cost":3777858026042693600,"previous_monthly_cost":"Minima magnam repellat error."}}},{"current_monthly_cost":"Ullam et tempore autem.","diff_monthly_cost":"Sint enim.","name":"Nihil in est.","percentage_change_monthly_cost":1269200476744766700,"previous_monthly_cost":"Totam ab qui.","subresources":{"Aut suscipit et voluptatem qui sit iste.":{"current_monthly_cost":"Ad cupiditate tempore voluptas occaecati ut assumenda.","diff_monthly_cost":"Fuga earum et qui exercitationem accusantium porro.","percentage_change_monthly_cost":3777858026042693600,"previous_monthly_cost":"Minima magnam repellat error."}}},{"current_monthly_cost":"Ullam et tempore autem.","diff_monthly_cost":"Sint enim.","name":"Nihil in est.","percentage_change_monthly_cost":1269200476744766700,"previous_monthly_cost":"Totam ab qui.","subresources":{"Aut suscipit et voluptatem qui sit iste.":{"current_monthly_cost":"Ad cupiditate tempore voluptas occaecati ut assumenda.","diff_monthly_cost":"Fuga earum et qui exercitationem accusantium porro.","percentage_change_monthly_cost":3777858026042693600,"previous_monthly_cost":"Minima magnam repellat error."}}},{"current_monthly_cost":"Ullam et tempore autem.","diff_monthly_cost":"Sint enim.","name":"Nihil in est.","percentage_change_monthly_cost":1269200476744766700,"previous_monthly_cost":"Totam ab qui.","subresources":{"Aut suscipit et voluptatem qui sit iste.":{"current_monthly_cost":"Ad cupiditate tempore voluptas occaecati ut assumenda.","diff_monthly_cost":"Fuga earum et qui exercitationem accusantium porro.","percentage_change_monthly_cost":3777858026042693600,"previous_monthly_cost":"Minima magnam repellat error."}}}],"diff_monthly_cost":"Sequi enim tempore et.","percentage_change_monthly_cost":2935345335961017000,"previous_monthly_cost":"Hic qui eum reiciendis iusto."}},"diff_total_monthly_cost":"Officiis praesentium et distinctio magni voluptas magni.","past_total_monthly_cost":"Consequuntur vel nam et.","percentage_change_total_monthly_cost":3061502594466213000,"stage_execution_id":"Repudiandae maiores magnam tenetur.","stage_id":"At vitae reprehenderit dolorem voluptates.","total_monthly_cost":"Odio ea dolores perferendis eos esse ut.","workspace_id":"Atque omnis ut voluptatem qui commodi eos."},"Nam eaque tenetur.":{"currency":"Nostrum provident aliquam.","diff":{"Corporis architecto beatae ea quis quo sint.":{"current_monthly_cost":"Voluptatum atque cumque quas non atque quis.","diff":[{"current_monthly_cost":"Ullam et tempore autem.","diff_monthly_cost":"Sint enim.","name":"Nihil in est.","percentage_change_monthly_cost":1269200476744766700,"previous_monthly_cost":"Totam ab qui.","subresources":{"Aut suscipit et voluptatem qui sit iste.":{"current_monthly_cost":"Ad cupiditate tempore voluptas occaecati ut assumenda.","diff_monthly_cost":"Fuga earum et qui exercitationem accusantium porro.","percentage_change_monthly_cost":3777858026042693600,"previous_monthly_cost":"Minima magnam repellat error."}}},{"current_monthly_cost":"Ullam et tempore autem.","diff_monthly_cost":"Sint enim.","name":"Nihil in est.","percentage_change_monthly_cost":1269200476744766700,"previous_monthly_cost":"Totam ab qui.","subresources":{"Aut suscipit et voluptatem qui sit iste.":{"current_monthly_cost":"Ad cupiditate tempore voluptas occaecati ut assumenda.","diff_monthly_cost":"Fuga earum et qui exercitationem accusantium porro.","percentage_change_monthly_cost":3777858026042693600,"previous_monthly_cost":"Minima magnam repellat error."}}},{"current_monthly_cost":"Ullam et tempore autem.","diff_monthly_cost":"Sint enim.","name":"Nihil in est.","percentage_change_monthly_cost":1269200476744766700,"previous_monthly_cost":"Totam ab qui.","subresources":{"Aut suscipit et voluptatem qui sit iste.":{"current_monthly_cost":"Ad cupiditate tempore voluptas occaecati ut assumenda.","diff_monthly_cost":"Fuga earum et qui exercitationem accusantium porro.","percentage_change_monthly_cost":3777858026042693600,"previous_monthly_cost":"Minima magnam repellat error."}}},{"current_monthly_cost":"Ullam et tempore autem.","diff_monthly_cost":"Sint enim.","name":"Nihil in est.","percentage_change_monthly_cost":1269200476744766700,"previous_monthly_cost":"Totam ab qui.","subresources":{"Aut suscipit et voluptatem qui sit iste.":{"current_monthly_cost":"Ad cupiditate tempore voluptas occaecati ut assumenda.","diff_monthly_cost":"Fuga earum et qui exercitationem accusantium porro.","percentage_change_monthly_cost":3777858026042693600,"previous_monthly_cost":"Minima magnam repellat error."}}}],"diff_monthly_cost":"Sequi enim tempore et.","percentage_change_monthly_cost":2935345335961017000,"previous_monthly_cost":"Hic qui eum reiciendis iusto."},"Non voluptatem.":{"current_monthly_cost":"Voluptatum atque cumque quas non atque quis.","diff":[{"current_monthly_cost":"Ullam et tempore autem.","diff_monthly_cost":"Sint enim.","name":"Nihil in est.","percentage_change_monthly_cost":1269200476744766700,"previous_monthly_cost":"Totam ab qui.","subresources":{"Aut suscipit et voluptatem qui sit iste.":{"current_monthly_cost":"Ad cupiditate tempore voluptas occaecati ut assumenda.","diff_monthly_cost":"Fuga earum et qui exercitationem accusantium porro.","percentage_change_monthly_cost":3777858026042693600,"previous_monthly_cost":"Minima magnam repellat error."}}},{"current_monthly_cost":"Ullam et tempore autem.","diff_monthly_cost":"Sint enim.","name":"Nihil in est.","percentage_change_monthly_cost":1269200476744766700,"previous_monthly_cost":"Totam ab qui.","subresources":{"Aut suscipit et voluptatem qui sit iste.":{"current_monthly_cost":"Ad cupiditate tempore voluptas occaecati ut assumenda.","diff_monthly_cost":"Fuga earum et qui exercitationem accusantium porro.","percentage_change_monthly_cost":3777858026042693600,"previous_monthly_cost":"Minima magnam repellat error."}}},{"current_monthly_cost":"Ullam et tempore autem.","diff_monthly_cost":"Sint enim.","name":"Nihil in est.","percentage_change_monthly_cost":1269200476744766700,"previous_monthly_cost":"Totam ab qui.","subresources":{"Aut suscipit et voluptatem qui sit iste.":{"current_monthly_cost":"Ad cupiditate tempore voluptas occaecati ut assumenda.","diff_monthly_cost":"Fuga earum et qui exercitationem accusantium porro.","percentage_change_monthly_cost":3777858026042693600,"previous_monthly_cost":"Minima magnam repellat error."}}},{"current_monthly_cost":"Ullam et tempore autem.","diff_monthly_cost":"Sint enim.","name":"Nihil in est.","percentage_change_monthly_cost":1269200476744766700,"previous_monthly_cost":"Totam ab qui.","subresources":{"Aut suscipit et voluptatem qui sit iste.":{"current_monthly_cost":"Ad cupiditate tempore voluptas occaecati ut assumenda.","diff_monthly_cost":"Fuga earum et qui exercitationem accusantium porro.","percentage_change_monthly_cost":3777858026042693600,"previous_monthly_cost":"Minima magnam repellat error."}}}],"diff_monthly_cost":"Sequi enim tempore et.","percentage_change_monthly_cost":2935345335961017000,"previous_monthly_cost":"Hic qui eum reiciendis iusto."},"Omnis deserunt error nobis in corrupti.":{"current_monthly_cost":"Voluptatum atque cumque quas non atque quis.","diff":[{"current_monthly_cost":"Ullam et tempore autem.","diff_monthly_cost":"Sint enim.","name":"Nihil in est.","percentage_change_monthly_cost":1269200476744766700,"previous_monthly_cost":"Totam ab qui.","subresources":{"Aut suscipit et voluptatem qui sit iste.":{"current_monthly_cost":"Ad cupiditate tempore voluptas occaecati ut assumenda.","diff_monthly_cost":"Fuga earum et qui exercitationem accusantium porro.","percentage_change_monthly_cost":3777858026042693600,"previous_monthly_cost":"Minima magnam repellat error."}}},{"current_monthly_cost":"Ullam et tempore autem.","diff_monthly_cost":"Sint enim.","name":"Nihil in est.","percentage_change_monthly_cost":1269200476744766700,"previous_monthly_cost":"Totam ab qui.","subresources":{"Aut suscipit et voluptatem qui sit iste.":{"current_monthly_cost":"Ad cupiditate tempore voluptas occaecati ut assumenda.","diff_monthly_cost":"Fuga earum et qui exercitationem accusantium porro.","percentage_change_monthly_cost":3777858026042693600,"previous_monthly_cost":"Minima magnam repellat error."}}},{"current_monthly_cost":"Ullam et tempore autem.","diff_monthly_cost":"Sint enim.","name":"Nihil in est.","percentage_change_monthly_cost":1269200476744766700,"previous_monthly_cost":"Totam ab qui.","subresources":{"Aut suscipit et voluptatem qui sit iste.":{"current_monthly_cost":"Ad cupiditate tempore voluptas occaecati ut assumenda.","diff_monthly_cost":"Fuga earum et qui exercitationem accusantium porro.","percentage_change_monthly_cost":3777858026042693600,"previous_monthly_cost":"Minima magnam repellat error."}}},{"current_monthly_cost":"Ullam et tempore autem.","diff_monthly_cost":"Sint enim.","name":"Nihil in est.","percentage_change_monthly_cost":1269200476744766700,"previous_monthly_cost":"Totam ab qui.","subresources":{"Aut suscipit et voluptatem qui sit iste.":{"current_monthly_cost":"Ad cupiditate tempore voluptas occaecati ut assumenda.","diff_monthly_cost":"Fuga earum et qui exercitationem accusantium porro.","percentage_change_monthly_cost":3777858026042693600,"previous_monthly_cost":"Minima magnam repellat error."}}}],"diff_monthly_cost":"Sequi enim tempore et.","percentage_change_monthly_cost":2935345335961017000,"previous_monthly_cost":"Hic qui eum reiciendis iusto."}},"diff_total_monthly_cost":"Officiis praesentium et distinctio magni voluptas magni.","past_total_monthly_cost":"Consequuntur vel nam et.","percentage_change_total_monthly_cost":3061502594466213000,"stage_execution_id":"Repudiandae maiores magnam tenetur.","stage_id":"At vitae reprehenderit dolorem voluptates.","total_monthly_cost":"Odio ea dolores perferendis eos esse ut.","workspace_id":"Atque omnis ut voluptatem qui commodi eos."}}
Contains the difference in cost of the resources that are changing
Example: {"currency":"Totam maxime quis debitis nulla ad.","diff":{"Autem voluptatem.":{"current_monthly_cost":"Voluptatum atque cumque quas non atque quis.","diff":[{"current_monthly_cost":"Ullam et tempore autem.","diff_monthly_cost":"Sint enim.","name":"Nihil in est.","percentage_change_monthly_cost":1269200476744766700,"previous_monthly_cost":"Totam ab qui.","subresources":{"Aut suscipit et voluptatem qui sit iste.":{"current_monthly_cost":"Ad cupiditate tempore voluptas occaecati ut assumenda.","diff_monthly_cost":"Fuga earum et qui exercitationem accusantium porro.","percentage_change_monthly_cost":3777858026042693600,"previous_monthly_cost":"Minima magnam repellat error."}}},{"current_monthly_cost":"Ullam et tempore autem.","diff_monthly_cost":"Sint enim.","name":"Nihil in est.","percentage_change_monthly_cost":1269200476744766700,"previous_monthly_cost":"Totam ab qui.","subresources":{"Aut suscipit et voluptatem qui sit iste.":{"current_monthly_cost":"Ad cupiditate tempore voluptas occaecati ut assumenda.","diff_monthly_cost":"Fuga earum et qui exercitationem accusantium porro.","percentage_change_monthly_cost":3777858026042693600,"previous_monthly_cost":"Minima magnam repellat error."}}},{"current_monthly_cost":"Ullam et tempore autem.","diff_monthly_cost":"Sint enim.","name":"Nihil in est.","percentage_change_monthly_cost":1269200476744766700,"previous_monthly_cost":"Totam ab qui.","subresources":{"Aut suscipit et voluptatem qui sit iste.":{"current_monthly_cost":"Ad cupiditate tempore voluptas occaecati ut assumenda.","diff_monthly_cost":"Fuga earum et qui exercitationem accusantium porro.","percentage_change_monthly_cost":3777858026042693600,"previous_monthly_cost":"Minima magnam repellat error."}}},{"current_monthly_cost":"Ullam et tempore autem.","diff_monthly_cost":"Sint enim.","name":"Nihil in est.","percentage_change_monthly_cost":1269200476744766700,"previous_monthly_cost":"Totam ab qui.","subresources":{"Aut suscipit et voluptatem qui sit iste.":{"current_monthly_cost":"Ad cupiditate tempore voluptas occaecati ut assumenda.","diff_monthly_cost":"Fuga earum et qui exercitationem accusantium porro.","percentage_change_monthly_cost":3777858026042693600,"previous_monthly_cost":"Minima magnam repellat error."}}}],"diff_monthly_cost":"Sequi enim tempore et.","percentage_change_monthly_cost":2935345335961017000,"previous_monthly_cost":"Hic qui eum reiciendis iusto."}},"diff_total_monthly_cost":"Quisquam ab.","past_total_monthly_cost":"Laudantium neque incidunt quasi.","percentage_change_total_monthly_cost":4429101276270360600,"stage_execution_id":"Voluptatem eius.","stage_id":"Dolor repellendus.","total_monthly_cost":"Fugit praesentium quia.","workspace_id":"Maiores voluptas."}
stage_execution_idstring
Example: "Ut sed consequatur reprehenderit optio."
stage_idstring
Example: "Commodi accusamus molestiae occaecati."
workspace_idstring
Example: "Doloremque est nulla aut aut quas."
]
Response
application/json
[
{
"modules": { … },
"stage_execution_id": "Corrupti veritatis vero qui id.",
"stage_id": "Occaecati laborum vel placeat odio ipsum.",
"workspace_id": "Qui ipsum ipsum."
},
{
"modules": { … },
"stage_execution_id": "Corrupti veritatis vero qui id.",
"stage_id": "Occaecati laborum vel placeat odio ipsum.",
"workspace_id": "Qui ipsum ipsum."
},
{
"modules": { … },
"stage_execution_id": "Corrupti veritatis vero qui id.",
"stage_id": "Occaecati laborum vel placeat odio ipsum.",
"workspace_id": "Qui ipsum ipsum."
}
]
Path associated with the resource. Could be namespace, environment or stack id.
Example: "namespace"
data_sources[].​providerstringrequired
Cloud provider associated with the resource.
Example: "AWS"
data_sources[].​resource_idstringrequired
Unique identifier for the resource from the cloud provider.
Example: "arn:aws:s3:::my-bucket"
data_sources[].​sensitive_attributesArray of anyrequired
A list of the sensitive attribute keys
Example: ["instance_type"]
data_sources[].​typestringrequired
Type of the provisioned resource.
Example: "S3 Bucket"
drift_changesArray of objects(ChangedResourceCollection)required
Example: [{"change":"added","change_count":10,"changes":{"Eveniet esse et quia.":{"change":"added","drift":false,"new":"new value","old":"old value","sensitive":true},"Quae culpa at est dolores facilis tempore.":{"change":"added","drift":false,"new":"new value","old":"old value","sensitive":true}},"drift":true,"module":"full_stack","name":"app_server","provider":"AWS","type":"S3 Bucket"},{"change":"added","change_count":10,"changes":{"Eveniet esse et quia.":{"change":"added","drift":false,"new":"new value","old":"old value","sensitive":true},"Quae culpa at est dolores facilis tempore.":{"change":"added","drift":false,"new":"new value","old":"old value","sensitive":true}},"drift":true,"module":"full_stack","name":"app_server","provider":"AWS","type":"S3 Bucket"}]
the identifier of the pipeline execution changes were made from.
Example: "Necessitatibus voluptatem corrupti dolorem ipsa omnis."
pipeline_stagestring
the identifier of the pipeline stage execution changes were made from.
Example: "Earum optio."
planned_changesArray of objects(ChangedResourceCollection)required
Example: [{"change":"added","change_count":10,"changes":{"Eveniet esse et quia.":{"change":"added","drift":false,"new":"new value","old":"old value","sensitive":true},"Quae culpa at est dolores facilis tempore.":{"change":"added","drift":false,"new":"new value","old":"old value","sensitive":true}},"drift":true,"module":"full_stack","name":"app_server","provider":"AWS","type":"S3 Bucket"},{"change":"added","change_count":10,"changes":{"Eveniet esse et quia.":{"change":"added","drift":false,"new":"new value","old":"old value","sensitive":true},"Quae culpa at est dolores facilis tempore.":{"change":"added","drift":false,"new":"new value","old":"old value","sensitive":true}},"drift":true,"module":"full_stack","name":"app_server","provider":"AWS","type":"S3 Bucket"}]