Get a single workload-profile by id

GET

/workload-profiles/{id}

• Current canonical versioned path (F3.API.01)

Authorizations

• bearerAuth
• apiTokenAuth

Parameters

Path Parameters

id

required

string

DocumentId

Responses

200

OK

object

data

object

instance_id

DocumentId of the source cloud-instance record

string

instance_name

string

profile_type

required

string

Allowed values: cpu_bound memory_bound io_bound idle mixed

peak_hours

Array of hour integers (0-23) when CPU/memory is high

idle_hours

Array of hour integers (0-23) when instance is underutilised

avg_cpu_pct

number

avg_memory_pct

number

current_instance_type

Current instance type e.g. m5.2xlarge

string

migration_target

Recommended target instance type e.g. m5.xlarge

string

estimated_monthly_savings_usd

number

confidence

number

analysis_model

string

recommendation_summary

string

status

string

Allowed values: pending_review accepted implemented dismissed

organisation

One of:

string

DocumentId reference to api::organisation.organisation

string

object

object

key

additional properties

any

profiled_at

string format: date-time

documentId

string

id

integer

createdAt

string format: date-time

updatedAt

string format: date-time

publishedAt

string format: date-time

nullable

401

Missing or invalid authentication

403

Not authorized (tenant scope or capability)

404

Not found