Invoke a capability-advertised Objects action

POST

/v1/projects/{project_id}/services/{service_id}/actions/{action}

curl --request POST \
  --url https://api-dev.impulsehosting.com/v1/projects/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/services/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/actions/service_health \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

• Impulse Platform development

Use x-impulse-objects-actions for request schemas and service capabilities.actions as the runtime source of truth.

Authorizations

• bearerAuth

Parameters

Path Parameters

project_id

required

string format: uuid

service_id

required

string format: uuid

action

required

string

Allowed values: service_health list_buckets create_bucket delete_bucket set_bucket_versioning list_access_keys create_access_key delete_access_key reset_primary_credential list_objects prepare_object_download prepare_object_upload delete_object create_folder usage_history

Request Body^required

Media typeapplication/json

object

key

additional properties

any

Example^generated

{}

Responses

200

Customer-safe action result

Media typeapplication/json

object

action

required

string

Allowed values: service_health list_buckets create_bucket delete_bucket set_bucket_versioning list_access_keys create_access_key delete_access_key reset_primary_credential list_objects prepare_object_download prepare_object_upload delete_object create_folder usage_history

status

required

string

Allowed values: ok healthy degraded unknown error

message

string

result

object

key

additional properties

any

Example

{
  "action": "service_health",
  "status": "ok"
}

400

Invalid action body

Media typeapplication/json

object

error

required

string

Example^generated

{
  "error": "example"
}

403

Scope or project binding denied

Media typeapplication/json

object

error

required

string

Example^generated

{
  "error": "example"
}

404

Resource not found

Media typeapplication/json

object

error

required

string

Example^generated

{
  "error": "example"
}

409

Action unavailable for current service state

Media typeapplication/json

object

error

required

string

Example^generated

{
  "error": "example"
}