Projects

List projects#

GET /api/organizations/{organization_id}/projects

Your projects, with how many tasks each has and what they save.

Parameters

NameInTypeDescription
organization_idpathstring (uuid)The organization's ID, from the organizations list. Required.

Response

  • projects (array of objects): The matching projects.

    • id (string (uuid)): The project's ID.
    • status (string): Whether the project is upcoming, open, or completed. One of upcoming, open, completed.
    • display_name (string): The project's name, like Project #3.
    • tasks_count (integer): How many tasks the project has.
    • open_tasks_count (integer): How many of its tasks are still open.
    • monthly_savings (number): The monthly savings of the project's cost tasks, in USD.

Errors: 401, 403, 404, 429. See errors.

Get a project#

GET /api/organizations/{organization_id}/projects/{project_id}

One project with its tasks. A project that is locked, or hasn't started yet, returns 403.

Parameters

NameInTypeDescription
organization_idpathstring (uuid)The organization's ID, from the organizations list. Required.
project_idpathstring (uuid)The project's ID. Required.

Response

  • project (object): The project.

    • id (string (uuid)): The project's ID.
    • status (string): Whether the project is upcoming, open, or completed. One of upcoming, open, completed.
    • display_name (string): The project's name, like Project #3.
    • tasks_count (integer): How many tasks the project has.
    • open_tasks_count (integer): How many of its tasks are still open.
    • monthly_savings (number): The monthly savings of the project's cost tasks, in USD.

    • tasks (array of objects): The project's tasks, by number.

      • id (string (uuid)): The task's ID.
      • number (integer): The task's number within the organization.
      • status (string): Where the task is on its project's board. One of todo, in_progress, solved, discarded, archived.
      • resource_uid (string): The AWS resource the task is about, like an instance ID.
      • title (string): What to do, like Upgrade db-1 to Graviton.
      • categories (array of strings): What the task improves. One of cost, security, hygiene, modernization.
      • risk (string): How risky the change is. One of low, medium, high, critical.
      • last_detected_at (string (date-time) or null): When MilkStraw AI last found the issue.
      • confidence (string): How sure MilkStraw AI is that the change applies. One of low, medium, high.
      • reversible (boolean): Whether the change can be undone.
      • source (string): What found the issue. One of aws, milkstraw.
      • project (object): The project the task belongs to.
      • monthly_savings (number or null): What the task saves a month, in USD, when it saves money.

Errors: 401, 403, 404, 429. See errors.

Get a task#

GET /api/organizations/{organization_id}/projects/{project_id}/tasks/{task_id}

One task with its resource details, instructions, and activity.

Parameters

NameInTypeDescription
organization_idpathstring (uuid)The organization's ID, from the organizations list. Required.
project_idpathstring (uuid)The project's ID. Required.
task_idpathstring (uuid)The task's ID. Required.

Response

  • task (object): The task.

    • id (string (uuid)): The task's ID.
    • number (integer): The task's number within the organization.
    • status (string): Where the task is on its project's board. One of todo, in_progress, solved, discarded, archived.
    • resource_uid (string): The AWS resource the task is about, like an instance ID.
    • title (string): What to do, like Upgrade db-1 to Graviton.
    • categories (array of strings): What the task improves. One of cost, security, hygiene, modernization.
    • risk (string): How risky the change is. One of low, medium, high, critical.
    • last_detected_at (string (date-time) or null): When MilkStraw AI last found the issue.
    • confidence (string): How sure MilkStraw AI is that the change applies. One of low, medium, high.
    • reversible (boolean): Whether the change can be undone.
    • source (string): What found the issue. One of aws, milkstraw.
    • project (object): The project the task belongs to.
    • monthly_savings (number or null): What the task saves a month, in USD, when it saves money.
    • details (object): Facts about the resource, like its type and region.

    • templates (object): The instructions for doing the task.

      • content (string): The instructions, in Markdown.

    • activities (array of objects): What happened to the task, newest first.

      • action (string): What happened. One of 10 values, like opened.
      • created_at (string (date-time)): When it happened.
      • actor (string or null): The member who did it, or null when MilkStraw AI did.

Errors: 401, 403, 404, 429. See errors.