Sign in
latestOpenAPI 3.1.02026-08-23100133183.1 KB

0d66c7340876

Journal

Get activity journal for a volume

Get all events for a volume. Does not include compute-related events.

get/v1/journal/volume/{volumeId}

Path parameters

volumeIdstring required

Query parameters

pagenumber

Page number, starting from 1

pageSizenumber

Number of items per page, default 10 maximum 100

compute_idstring

Specify either compute_id or volume_id

volume_idstring

Specify either volume_id or compute_id

action_code'create' | 'start' | 'start:complete' | 'shutdown:complete' | 'shutdown' | 'delete' | 'delete:complete' | 'attach' | 'attach:complete' | 'detach' | 'detach:complete' | 'clone' | 'resize' | 'rename' | 'restore' | 'transfer' | 'trash' | 'trash:complete' | 'configure_spot' | 'cancel' | 'provisioning' | 'running' | 'installation:failed' | 'validating' | 'deleting' | 'error'

Filter by action code

object_type'compute' | 'volume'

Filter by object type

hydrateboolean

Hydrate every event with user, instance and volume objects

Response

idstring required

Event ID, unique within the project. Please note that it is not UUID but a combined string to identify the event.

object_idstring required

ID of the object that the event is related to.

object_type'compute' | 'volume' required

Object type that the event is related to.

action_code'create' | 'start' | 'start:complete' | 'shutdown:complete' | 'shutdown' | 'delete' | 'delete:complete' | 'attach' | 'attach:complete' | 'detach' | 'detach:complete' | 'clone' | 'resize' | 'rename' | 'restore' | 'transfer' | 'trash' | 'trash:complete' | 'configure_spot' | 'cancel' | 'provisioning' | 'running' | 'installation:failed' | 'validating' | 'deleting' | 'error' required

Action that was performed on the object.

actor_idstring nullable

ID of the actor that performed the action. For some actions, such as spot discontinue, the actor is not available and assumed to be system.

actor_emailstring nullable

Email of the actor that performed the action.

project_idstring required

ID of the project that the event is related to.

timestampstring required

When the event happened.

location_codestring required

Datacenter location code where the event happened or this object is located.

request_originstring

Origin of the request that caused the event. For example, public API, Console UI, or undefined for the internal system.

request_ipstring

IP address of the request that caused the event.

error_messagestring

For error events, the error message

parent_idstring

For some events, for example attach volume during instance provisioning, the ID of the parent event.

servicestring

For some events, the internal service that caused the event.

target_location_codestring

For cross-datacenter events, the location code of the target location.

target_volume_idstring

For some events, the ID of the target volume.

target_compute_idstring

For some events, the ID of the target compute.

source_volume_idstring

For some events, the ID of the source volume.

source_compute_idstring

For some events, the ID of the source compute.

propertiesobject

Additional properties of the event.

Example response

[
  {
    "id": "instance-log-123",
    "object_id": "0787ea3e-d419-4b82-9a24-c2480d4322a8",
    "object_type": "compute",
    "action_code": "start",
    "actor_id": "17493190-0420-44b8-b67e-08f0c2fd1a3c",
    "actor_email": "user@datacrunch.io",
    "project_id": "04b673a5-fbab-4831-ada9-c83673dc277e",
    "timestamp": "2026-03-17T14:15:52.872Z",
    "location_code": "FIN-01",
    "request_origin": "public-api-v1",
    "request_ip": "127.0.0.1",
    "error_message": "GPU_QUOTA_EXCEEDED",
    "parent_id": "compute-log-123",
    "service": "VolumeProvider",
    "target_location_code": "ICE-01",
    "volume": {
      "id": "d73790f6-5ca1-4baa-bbba-8649180d1e7e",
      "name": "volume-1",
      "created_at": "2026-03-17T14:15:52.872Z",
      "gb": 100,
      "template_type": "NVMe",
      "location_code": "FIN-01"
    },
    "compute": {
      "id": "bcfa2823-926a-46c3-98cf-590d7b64e50f",
      "hostname": "example-fin-01",
      "compute_type": "4A100.88V",
      "ip": "1.2.3.4",
      "os_volume_id": "9b6d1480-0267-4235-9925-b21c6aa479c4",
      "location_code": "FIN-01"
    },
    "target_volume_id": "19e30c52-afbf-4908-bda0-28668e4b6c4d",
    "target_volume": {
      "id": "d73790f6-5ca1-4baa-bbba-8649180d1e7e",
      "name": "volume-1",
      "created_at": "2026-03-17T14:15:52.872Z",
      "gb": 100,
      "template_type": "NVMe",
      "location_code": "FIN-01"
    },
    "target_compute_id": "0e79171c-41c6-4d47-b09b-fadb125b79c2",
    "target_compute": {
      "id": "bcfa2823-926a-46c3-98cf-590d7b64e50f",
      "hostname": "example-fin-01",
      "compute_type": "4A100.88V",
      "ip": "1.2.3.4",
      "os_volume_id": "9b6d1480-0267-4235-9925-b21c6aa479c4",
      "location_code": "FIN-01"
    },
    "source_volume_id": "dc46f329-8d93-4183-81f2-cc600b0614f7",
    "source_volume": {
      "id": "d73790f6-5ca1-4baa-bbba-8649180d1e7e",
      "name": "volume-1",
      "created_at": "2026-03-17T14:15:52.872Z",
      "gb": 100,
      "template_type": "NVMe",
      "location_code": "FIN-01"
    },
    "source_compute_id": "d7c19b03-2393-4b98-821a-5b2efdf31e73",
    "source_compute": {
      "id": "bcfa2823-926a-46c3-98cf-590d7b64e50f",
      "hostname": "example-fin-01",
      "compute_type": "4A100.88V",
      "ip": "1.2.3.4",
      "os_volume_id": "9b6d1480-0267-4235-9925-b21c6aa479c4",
      "location_code": "FIN-01"
    },
    "properties": {
      "delete_reason": "evicted_by_on_demand"
    }
  }
]