Skip to content

Projects

Please see the end-user api for more details.

List All Projects

Description Endpoint
Find All Projects GET /api/admin/projects
Filter By User GET /api/admin/users/{user_id})/projects
Schema
  • projects: Array
    • id: Integer
    • name: String
    • current_state: String
    • container_image_ids: Array
    • user: Object
      • id: Integer
      • email: String
      • external_id: String
      • labels: Object
    • links: Object
      • services: String
      • container_images: String
      • bastions: String
    • metadata: Object
      • icons: Array
      • image_names: Array
    • created_at: DateTime
    • updated_at: DateTime

View Project

GET /api/admin/projects/{id}

Schema
  • project: Object
    • id: Integer
    • name: String
    • current_state: String
    • container_image_ids: Array
    • user: Object
      • id: Integer
      • email: String
      • external_id: String
      • labels: Object
    • links: Object
      • services: String
      • container_images: String
      • bastions: String
    • metadata: Object
      • icons: Array
      • image_names: Array
    • created_at: DateTime
    • updated_at: DateTime

Update Project

PATCH /api/admin/projects/{id}

Params: * project: Object * name: String - project name * user_id: Integer – Only supply this if you want to change the project owner!


Last update: 2021-03-12