Skip to main content

Projects Commands

See Projects module docs for permissions and data model.

soat list-projects​

List projects

  • Method: GET
  • Path: /api/v1/projects

Usage​

soat list-projects

Options​

This command has no options.

soat create-project​

Create a project

  • Method: POST
  • Path: /api/v1/projects

Usage​

soat create-project --name <string>

Options​

--name​

—

  • Source: body
  • Required: yes
  • Type: string
  • Example: My Project

soat get-project​

Get a project

  • Method: GET
  • Path: /api/v1/projects/{project_id}

Usage​

soat get-project --project-id <string>

Options​

--project-id​

Project public ID (proj_ prefix)

  • Source: path
  • Required: yes
  • Type: string
  • Example: proj_V1StGXR8Z5jdHi6B

soat update-project​

Rename a project

  • Method: PATCH
  • Path: /api/v1/projects/{project_id}

Usage​

soat update-project --project-id <string> --name <string>

Options​

--project-id​

Project public ID (proj_ prefix)

  • Source: path
  • Required: yes
  • Type: string
  • Example: proj_V1StGXR8Z5jdHi6B
--name​

—

  • Source: body
  • Required: yes
  • Type: string
  • Example: Renamed Project

soat delete-project​

Delete a project

  • Method: DELETE
  • Path: /api/v1/projects/{project_id}

Usage​

soat delete-project --project-id <string>

Options​

--project-id​

Project public ID (proj_ prefix)

  • Source: path
  • Required: yes
  • Type: string
  • Example: proj_V1StGXR8Z5jdHi6B
--force​

When true, deletes all of the project's dependent resources instead of returning 409 PROJECT_HAS_DEPENDENTS.

  • Source: query
  • Required: no
  • Type: boolean
  • Default: false

soat get-project-prices​

List a project's price rows

  • Method: GET
  • Path: /api/v1/projects/{project_id}/prices

Usage​

soat get-project-prices --project-id <string>

Options​

--project-id​

Project public ID (proj_ prefix)

  • Source: path
  • Required: yes
  • Type: string
  • Example: proj_V1StGXR8Z5jdHi6B

soat update-project-prices​

Upsert a project's price rows

  • Method: PUT
  • Path: /api/v1/projects/{project_id}/prices

Usage​

soat update-project-prices --project-id <string> --prices <array<object>>

Options​

--project-id​

Project public ID (proj_ prefix)

  • Source: path
  • Required: yes
  • Type: string
  • Example: proj_V1StGXR8Z5jdHi6B
--prices​

—

  • Source: body
  • Required: yes
  • Type: array<object>