Harness

costs

Costs Service handles the API related with the costs attached to workspaces. This API is read only as all the cost are generated in the plugin side

list-costs costs

List the monthly cost per each workspace

Securityx-api-key
Request
path Parameters
org
required
string [ 1 .. 128 ] characters

Org is the organisation identifier.

Example: ad
project
required
string [ 1 .. 128 ] characters

Project is the project identifier.

Example: 1
query Parameters
start_time
integer <int64>

Specify the start time for the query

Example: start_time=1691150743950
end_time
integer <int64>

Specify the end time limit for the query

Example: end_time=1691150743950
page
integer <int64> >= 1
Default: 1

Page is the page number to return relative to the page 'limit'.

Example: page=1
limit
integer <int64> [ 1 .. 1000 ]
Default: 30

Limit is the number of records to return for a page.

Example: limit=30
workspaces
Array of strings

Filter the workspaces to retrieve the cost

Example: workspaces=Iure similique est.&workspaces=Cumque veniam.&workspaces=Repellat libero expedita non nemo veritatis.
header Parameters
Harness-Account
required
string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: bh4
Responses
200

OK response.

400

BadRequestError: Bad Request response.

401

UnauthorizedError: Unauthorized response.

403

ForbiddenError: Forbidden response.

404

NotFoundError: Not Found response.

408

TimeoutError: Request Timeout response.

409

ConflictError: Conflict response.

423

LockedError: Locked response.

499

ContextCancelledError: response.

500

InternalServerError: Internal Server Error response.

502

BadGatewayError: Bad Gateway response.

get/iacm/api/orgs/{org}/projects/{project}/costs
Request samples 
Response samples 
application/json
{
  • "pageSize": 50,
  • "totalItems": 1800,
  • "totalPages": 36,
  • "workspaces": [
    ]
}
list-costs-per-workspace costs
List the cost of the workspace and correlate it with the executions


Securityx-api-key 
Request 
path Parameters
org
required
string  [ 1 .. 128 ] characters 
Org is the organisation identifier.


 
 Example:  b
project
required
string  [ 1 .. 128 ] characters 
Project is the project identifier.


 
 Example:  b
workspace
required
string
Workspace id to retrieve the cost and the metadata associated with it


 
 Example:  Praesentium ex inventore numquam.
query Parameters
limit
integer <int64>   [ 1 .. 1000 ] 
 Default:  30
Limit is the number of records to return for a page.


 
 Example:  limit=30
page
integer <int64>   >= 1 
 Default:  1
Page is the page number to return relative to the page 'limit'.


 
 Example:  page=1
start_time
integer <int64> 
Specify the start time for the query


 
 Example:  start_time=1691150743950
end_time
integer <int64> 
Specify the end time limit for the query


 
 Example:  end_time=1691150743950
header Parameters
Harness-Account
required
string  [ 1 .. 128 ] characters 
Account is the internal customer account ID.


 
 Example:  fsz
Responses 
200
OK response.


400
BadRequestError: Bad Request response.


401
UnauthorizedError: Unauthorized response.


403
ForbiddenError: Forbidden response.


404
NotFoundError: Not Found response.


408
TimeoutError: Request Timeout response.


409
ConflictError: Conflict response.


423
LockedError: Locked response.


499
ContextCancelledError:  response.


500
InternalServerError: Internal Server Error response.


502
BadGatewayError: Bad Gateway response.


get/iacm/api/orgs/{org}/projects/{project}/costs/{workspace}
Request samples 
Response samples 
application/json
[
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]
➔ Next to executions