API
Projects
Create roject

Create a Project

  • Name
    post
    Type
    /v1/projects
    Description

    Send a POST request to create project.

Request

Example

curl -X POST "https://api.simplystack.com/v1/projects" \
  -H "Content-Type: application/json" \
  -H "Authorization: Token d359ad9cc9422b5ff07aede0cd2707da4ff82be0" \
  -d '{"name": "MyProject", "environment": "Development", "is_default": true, "color": "#0061FF"}'

Attributes

Required

  • Name
    name
    Type
    string
    Description

    Human-readable name for the project.

  • Name
    color
    Type
    integer
    Description

    Unique color hex code for the project.

Optional

  • Name
    budget
    Type
    decimal
    Description

    Planned spend amount for the project in US$.

  • Name
    team_uuid
    Type
    string
    Description

    The UUID id of the team associated to this project.

  • Name
    is_default
    Type
    boolean
    Description

    If true, all resources will be added to this project if no project is specified.

  • Name
    description
    Type
    string
    Description

    The project description, maximum length for this attribute is 255 character.

  • Name
    environment
    Type
    boolean
    Description

    The environment of the project's resources.

Response

JSON object with a key named project which is an array of the following attributes for the standard project object:

Attributes

See project model.

Example

json
{
  "uuid": "7dc8b292-7b4a-4e99-a0ba-73b62055ab81",
  "budget": "0.00",
  "color": "#0061FF",
  "created_at": "2021-02-01T00:00:02.602000Z",
  "description": null,
  "environment": "Development",
  "is_default": true,
  "name": "MyProject",
  "owner_uuid": "3f80a877-3a80-4200-9e31-271b512cc726",
  "stacklets_count": 1,
  "team": null,
  "updated_at": "2021-02-01T00:00:02.602000Z"
}
Project modelUpdate project