{"owner":"google","repo":"cadvisor","hasSkills":true,"totalSkillsCount":1,"totalTokensCount":1083,"categories":["project-spec"],"hasMcp":false,"mcpConfig":null,"found":["docs/api.md"],"skills":{"docs/api.md":"# cAdvisor Remote REST API\n\ncAdvisor exposes its raw and processed stats via a versioned remote REST API:\n\n`http://<hostname>:<port>/api/<version>/<request>`\n\nThe current version of the API is `v1.3`.\n\nThere is a beta release of the `v2.0` API [available](api_v2.md).\n\n## Version 1.3\n\nThis version exposes the same endpoints as `v1.2` with one additional read-only endpoint.\n\n### Events\n\nThe resource name for Docker container information is as follows:\n\n`/api/v1.3/events/<absolute container name>`\n\nQuerying the endpoint receives a list of events which are a serialized `Event` JSON objects (found in [info/v1/container.go](../info/v1/container.go)).\n\nThe endpoint accepts a certain number of query parameters:\n\n| Parameter         | Description                                                                    | Default           |\n|-------------------|--------------------------------------------------------------------------------|-------------------|\n| `start_time`      | Start time of events to query (for stream=false)                               | Beginning of time |\n| `end_time`        | End time of events to query (for stream=false)                                 | Now               |\n| `stream`          | Whether to stream new events as they occur. If false returns historical events | false             |\n| `subcontainers`   | Whether to also return events for all subcontainers                            | false             |\n| `max_events`      | The max number of events to return (for stream=false)                          | 10                |\n| `all_events`      | Whether to include all supported event types                                   | false             |\n| `oom_events`      | Whether to include OOM events                                                  | false             |\n| `oom_kill_events` | Whether to include OOM kill events                                             | false             |\n| `creation_events` | Whether to include container creation events                                   | false             |\n| `deletion_events` | Whether to include container deletion events                                   | false             |\n\n## Version 1.2\n\nThis version exposes the same endpoints as `v1.1` with one additional read-only endpoint.\n\n### Docker Container Information\n\nThe resource name for Docker container information is as follows:\n\n`/api/v1.2/docker/<Docker container name or blank for all Docker containers>`\n\nThe Docker name can be either the UUID or the short name of the container. It returns the information of the specified container(s). The information is returned as a list of serialized `ContainerInfo` JSON objects (found in [info/v1/container.go](../info/v1/container.go)).\n\n## Version 1.1\n\nThis version exposes the same endpoints as `v1.0` with one additional read-only endpoint.\n\n### Subcontainer Information\n\nThe resource name for subcontainer information is as follows:\n\n`/api/v1.1/subcontainers/<absolute container name>`\n\nWhere the absolute container name follows the lmctfy naming convention (described bellow). It returns the information of the specified container and all subcontainers (recursively). The information is returned as a list of serialized `ContainerInfo` JSON objects (found in [info/v1/container.go](../info/v1/container.go)).\n\n## Version 1.0\n\nThis version exposes two main endpoints, one for container information and the other for machine information. Both endpoints are read-only in v1.0.\n\n### Container Information\n\nThe resource name for container information is as follows:\n\n`/api/v1.0/containers/<absolute container name>`\n\nWhere the absolute container name follows the lmctfy naming convention. For example:\n\n| Container Name       | Resource Name                             |\n|----------------------|-------------------------------------------|\n| /                    | /api/v1.0/containers/                     |\n| /foo                 | /api/v1.0/containers/foo                  |\n| /docker/2c4dee605d22 | /api/v1.0/containers/docker/2c4dee605d22  |\n\nNote that the root container (`/`) contains usage for the entire machine. All Docker containers are listed under `/docker`.\n\nThe container information is returned as a JSON object containing:\n\n- Absolute container name\n- List of subcontainers\n- ContainerSpec which describes the resource isolation enabled in the container\n- Detailed resource usage statistics of the container for the last `N` seconds (`N` is globally configurable in cAdvisor)\n- Histogram of resource usage from the creation of the container\n\nThe actual object is the marshalled JSON of the `ContainerInfo` struct found in [info/v1/container.go](../info/v1/container.go)\n\n### Machine Information\n\nThe resource name for machine information is as follows:\n\n`/api/vX.Y/machine`\n\nThis resource is read-only. The machine information is returned as a JSON object containing:\n\n- Number of schedulable logical CPU cores\n- Memory capacity (in bytes)\n- Maximum supported CPU frequency (in kHz)\n- Available filesystems: major, minor numbers and capacity (in bytes)\n- Network devices: mac addresses, MTU, and speed (if available)\n- Machine topology: Nodes, cores, threads, per-node memory, and caches\n\nThe actual object is the marshalled JSON of the `MachineInfo` struct found in [info/v1/machine.go](../info/v1/machine.go)\n"},"files":{"docs/api.md":"# cAdvisor Remote REST API\n\ncAdvisor exposes its raw and processed stats via a versioned remote REST API:\n\n`http://<hostname>:<port>/api/<version>/<request>`\n\nThe current version of the API is `v1.3`.\n\nThere is a beta release of the `v2.0` API [available](api_v2.md).\n\n## Version 1.3\n\nThis version exposes the same endpoints as `v1.2` with one additional read-only endpoint.\n\n### Events\n\nThe resource name for Docker container information is as follows:\n\n`/api/v1.3/events/<absolute container name>`\n\nQuerying the endpoint receives a list of events which are a serialized `Event` JSON objects (found in [info/v1/container.go](../info/v1/container.go)).\n\nThe endpoint accepts a certain number of query parameters:\n\n| Parameter         | Description                                                                    | Default           |\n|-------------------|--------------------------------------------------------------------------------|-------------------|\n| `start_time`      | Start time of events to query (for stream=false)                               | Beginning of time |\n| `end_time`        | End time of events to query (for stream=false)                                 | Now               |\n| `stream`          | Whether to stream new events as they occur. If false returns historical events | false             |\n| `subcontainers`   | Whether to also return events for all subcontainers                            | false             |\n| `max_events`      | The max number of events to return (for stream=false)                          | 10                |\n| `all_events`      | Whether to include all supported event types                                   | false             |\n| `oom_events`      | Whether to include OOM events                                                  | false             |\n| `oom_kill_events` | Whether to include OOM kill events                                             | false             |\n| `creation_events` | Whether to include container creation events                                   | false             |\n| `deletion_events` | Whether to include container deletion events                                   | false             |\n\n## Version 1.2\n\nThis version exposes the same endpoints as `v1.1` with one additional read-only endpoint.\n\n### Docker Container Information\n\nThe resource name for Docker container information is as follows:\n\n`/api/v1.2/docker/<Docker container name or blank for all Docker containers>`\n\nThe Docker name can be either the UUID or the short name of the container. It returns the information of the specified container(s). The information is returned as a list of serialized `ContainerInfo` JSON objects (found in [info/v1/container.go](../info/v1/container.go)).\n\n## Version 1.1\n\nThis version exposes the same endpoints as `v1.0` with one additional read-only endpoint.\n\n### Subcontainer Information\n\nThe resource name for subcontainer information is as follows:\n\n`/api/v1.1/subcontainers/<absolute container name>`\n\nWhere the absolute container name follows the lmctfy naming convention (described bellow). It returns the information of the specified container and all subcontainers (recursively). The information is returned as a list of serialized `ContainerInfo` JSON objects (found in [info/v1/container.go](../info/v1/container.go)).\n\n## Version 1.0\n\nThis version exposes two main endpoints, one for container information and the other for machine information. Both endpoints are read-only in v1.0.\n\n### Container Information\n\nThe resource name for container information is as follows:\n\n`/api/v1.0/containers/<absolute container name>`\n\nWhere the absolute container name follows the lmctfy naming convention. For example:\n\n| Container Name       | Resource Name                             |\n|----------------------|-------------------------------------------|\n| /                    | /api/v1.0/containers/                     |\n| /foo                 | /api/v1.0/containers/foo                  |\n| /docker/2c4dee605d22 | /api/v1.0/containers/docker/2c4dee605d22  |\n\nNote that the root container (`/`) contains usage for the entire machine. All Docker containers are listed under `/docker`.\n\nThe container information is returned as a JSON object containing:\n\n- Absolute container name\n- List of subcontainers\n- ContainerSpec which describes the resource isolation enabled in the container\n- Detailed resource usage statistics of the container for the last `N` seconds (`N` is globally configurable in cAdvisor)\n- Histogram of resource usage from the creation of the container\n\nThe actual object is the marshalled JSON of the `ContainerInfo` struct found in [info/v1/container.go](../info/v1/container.go)\n\n### Machine Information\n\nThe resource name for machine information is as follows:\n\n`/api/vX.Y/machine`\n\nThis resource is read-only. The machine information is returned as a JSON object containing:\n\n- Number of schedulable logical CPU cores\n- Memory capacity (in bytes)\n- Maximum supported CPU frequency (in kHz)\n- Available filesystems: major, minor numbers and capacity (in bytes)\n- Network devices: mac addresses, MTU, and speed (if available)\n- Machine topology: Nodes, cores, threads, per-node memory, and caches\n\nThe actual object is the marshalled JSON of the `MachineInfo` struct found in [info/v1/machine.go](../info/v1/machine.go)\n"},"items":[{"name":"api.md","path":"docs/api.md","rawUrl":"https://raw.githubusercontent.com/google/cadvisor/HEAD/docs/api.md","title":"docs - API Interface Contract & Specifications","category":"project-spec","format":"markdown","content":"# cAdvisor Remote REST API\n\ncAdvisor exposes its raw and processed stats via a versioned remote REST API:\n\n`http://<hostname>:<port>/api/<version>/<request>`\n\nThe current version of the API is `v1.3`.\n\nThere is a beta release of the `v2.0` API [available](api_v2.md).\n\n## Version 1.3\n\nThis version exposes the same endpoints as `v1.2` with one additional read-only endpoint.\n\n### Events\n\nThe resource name for Docker container information is as follows:\n\n`/api/v1.3/events/<absolute container name>`\n\nQuerying the endpoint receives a list of events which are a serialized `Event` JSON objects (found in [info/v1/container.go](../info/v1/container.go)).\n\nThe endpoint accepts a certain number of query parameters:\n\n| Parameter         | Description                                                                    | Default           |\n|-------------------|--------------------------------------------------------------------------------|-------------------|\n| `start_time`      | Start time of events to query (for stream=false)                               | Beginning of time |\n| `end_time`        | End time of events to query (for stream=false)                                 | Now               |\n| `stream`          | Whether to stream new events as they occur. If false returns historical events | false             |\n| `subcontainers`   | Whether to also return events for all subcontainers                            | false             |\n| `max_events`      | The max number of events to return (for stream=false)                          | 10                |\n| `all_events`      | Whether to include all supported event types                                   | false             |\n| `oom_events`      | Whether to include OOM events                                                  | false             |\n| `oom_kill_events` | Whether to include OOM kill events                                             | false             |\n| `creation_events` | Whether to include container creation events                                   | false             |\n| `deletion_events` | Whether to include container deletion events                                   | false             |\n\n## Version 1.2\n\nThis version exposes the same endpoints as `v1.1` with one additional read-only endpoint.\n\n### Docker Container Information\n\nThe resource name for Docker container information is as follows:\n\n`/api/v1.2/docker/<Docker container name or blank for all Docker containers>`\n\nThe Docker name can be either the UUID or the short name of the container. It returns the information of the specified container(s). The information is returned as a list of serialized `ContainerInfo` JSON objects (found in [info/v1/container.go](../info/v1/container.go)).\n\n## Version 1.1\n\nThis version exposes the same endpoints as `v1.0` with one additional read-only endpoint.\n\n### Subcontainer Information\n\nThe resource name for subcontainer information is as follows:\n\n`/api/v1.1/subcontainers/<absolute container name>`\n\nWhere the absolute container name follows the lmctfy naming convention (described bellow). It returns the information of the specified container and all subcontainers (recursively). The information is returned as a list of serialized `ContainerInfo` JSON objects (found in [info/v1/container.go](../info/v1/container.go)).\n\n## Version 1.0\n\nThis version exposes two main endpoints, one for container information and the other for machine information. Both endpoints are read-only in v1.0.\n\n### Container Information\n\nThe resource name for container information is as follows:\n\n`/api/v1.0/containers/<absolute container name>`\n\nWhere the absolute container name follows the lmctfy naming convention. For example:\n\n| Container Name       | Resource Name                             |\n|----------------------|-------------------------------------------|\n| /                    | /api/v1.0/containers/                     |\n| /foo                 | /api/v1.0/containers/foo                  |\n| /docker/2c4dee605d22 | /api/v1.0/containers/docker/2c4dee605d22  |\n\nNote that the root container (`/`) contains usage for the entire machine. All Docker containers are listed under `/docker`.\n\nThe container information is returned as a JSON object containing:\n\n- Absolute container name\n- List of subcontainers\n- ContainerSpec which describes the resource isolation enabled in the container\n- Detailed resource usage statistics of the container for the last `N` seconds (`N` is globally configurable in cAdvisor)\n- Histogram of resource usage from the creation of the container\n\nThe actual object is the marshalled JSON of the `ContainerInfo` struct found in [info/v1/container.go](../info/v1/container.go)\n\n### Machine Information\n\nThe resource name for machine information is as follows:\n\n`/api/vX.Y/machine`\n\nThis resource is read-only. The machine information is returned as a JSON object containing:\n\n- Number of schedulable logical CPU cores\n- Memory capacity (in bytes)\n- Maximum supported CPU frequency (in kHz)\n- Available filesystems: major, minor numbers and capacity (in bytes)\n- Network devices: mac addresses, MTU, and speed (if available)\n- Machine topology: Nodes, cores, threads, per-node memory, and caches\n\nThe actual object is the marshalled JSON of the `MachineInfo` struct found in [info/v1/machine.go](../info/v1/machine.go)\n","isInternal":false,"tokens":1083,"sizeBytes":5344}],"systemPromptSnippet":"<yakaai_skills repo=\"google/cadvisor\">\n<!-- File: docs/api.md (Tokens: ~1083 | Category: project-spec) -->\n# cAdvisor Remote REST API\n\ncAdvisor exposes its raw and processed stats via a versioned remote REST API:\n\n`http://<hostname>:<port>/api/<version>/<request>`\n\nThe current version of the API is `v1.3`.\n\nThere is a beta release of the `v2.0` API [available](api_v2.md).\n\n## Version 1.3\n\nThis version exposes the same endpoints as `v1.2` with one additional read-only endpoint.\n\n### Events\n\nThe resource name for Docker container information is as follows:\n\n`/api/v1.3/events/<absolute container name>`\n\nQuerying the endpoint receives a list of events which are a serialized `Event` JSON objects (found in [info/v1/container.go](../info/v1/container.go)).\n\nThe endpoint accepts a certain number of query parameters:\n\n| Parameter         | Description                                                                    | Default           |\n|-------------------|--------------------------------------------------------------------------------|-------------------|\n| `start_time`      | Start time of events to query (for stream=false)                               | Beginning of time |\n| `end_time`        | End time of events to query (for stream=false)                                 | Now               |\n| `stream`          | Whether to stream new events as they occur. If false returns historical events | false             |\n| `subcontainers`   | Whether to also return events for all subcontainers                            | false             |\n| `max_events`      | The max number of events to return (for stream=false)                          | 10                |\n| `all_events`      | Whether to include all supported event types                                   | false             |\n| `oom_events`      | Whether to include OOM events                                                  | false             |\n| `oom_kill_events` | Whether to include OOM kill events                                             | false             |\n| `creation_events` | Whether to include container creation events                                   | false             |\n| `deletion_events` | Whether to include container deletion events                                   | false             |\n\n## Version 1.2\n\nThis version exposes the same endpoints as `v1.1` with one additional read-only endpoint.\n\n### Docker Container Information\n\nThe resource name for Docker container information is as follows:\n\n`/api/v1.2/docker/<Docker container name or blank for all Docker containers>`\n\nThe Docker name can be either the UUID or the short name of the container. It returns the information of the specified container(s). The information is returned as a list of serialized `ContainerInfo` JSON objects (found in [info/v1/container.go](../info/v1/container.go)).\n\n## Version 1.1\n\nThis version exposes the same endpoints as `v1.0` with one additional read-only endpoint.\n\n### Subcontainer Information\n\nThe resource name for subcontainer information is as follows:\n\n`/api/v1.1/subcontainers/<absolute container name>`\n\nWhere the absolute container name follows the lmctfy naming convention (described bellow). It returns the information of the specified container and all subcontainers (recursively). The information is returned as a list of serialized `ContainerInfo` JSON objects (found in [info/v1/container.go](../info/v1/container.go)).\n\n## Version 1.0\n\nThis version exposes two main endpoints, one for container information and the other for machine information. Both endpoints are read-only in v1.0.\n\n### Container Information\n\nThe resource name for container information is as follows:\n\n`/api/v1.0/containers/<absolute container name>`\n\nWhere the absolute container name follows the lmctfy naming convention. For example:\n\n| Container Name       | Resource Name                             |\n|----------------------|-------------------------------------------|\n| /                    | /api/v1.0/containers/                     |\n| /foo                 | /api/v1.0/containers/foo                  |\n| /docker/2c4dee605d22 | /api/v1.0/containers/docker/2c4dee605d22  |\n\nNote that the root container (`/`) contains usage for the entire machine. All Docker containers are listed under `/docker`.\n\nThe container information is returned as a JSON object containing:\n\n- Absolute container name\n- List of subcontainers\n- ContainerSpec which describes the resource isolation enabled in the container\n- Detailed resource usage statistics of the container for the last `N` seconds (`N` is globally configurable in cAdvisor)\n- Histogram of resource usage from the creation of the container\n\nThe actual object is the marshalled JSON of the `ContainerInfo` struct found in [info/v1/container.go](../info/v1/container.go)\n\n### Machine Information\n\nThe resource name for machine information is as follows:\n\n`/api/vX.Y/machine`\n\nThis resource is read-only. The machine information is returned as a JSON object containing:\n\n- Number of schedulable logical CPU cores\n- Memory capacity (in bytes)\n- Maximum supported CPU frequency (in kHz)\n- Available filesystems: major, minor numbers and capacity (in bytes)\n- Network devices: mac addresses, MTU, and speed (if available)\n- Machine topology: Nodes, cores, threads, per-node memory, and caches\n\nThe actual object is the marshalled JSON of the `MachineInfo` struct found in [info/v1/machine.go](../info/v1/machine.go)\n</yakaai_skills>"}