Project

This endpoint is used to create, update, search or delete project information inside a Terrakube organization. Projects allow you to group workspaces and manage team access at the project level.

To use this endpoint you should have "manageWorkspace" access at team level and a Terrakube organization

Entity fields:

Path	Type	Description
data.type	string	Should be "project"
data.attributes.name	string	Unique project name for a Terrakube organization
data.attributes.description	string	Project description (OPTIONAL)

Example:

{
    "data": {
        "type": "project",
        "attributes": {
            "name": "My Project",
            "description": "A sample project for grouping workspaces"
        }
    }
}

Supported Operations

get

Returns the relationship project

Path parameters

organizationIdstringRequired

organization Identifier

Query parameters

filter[project]stringOptional

Filters the collection of project using a 'disjoint' RSQL expression

page[number]integerOptional

Number of pages to return. Can be used with page[size]

page[size]integerOptional

Number of elements per page. Can be used with page[number]

page[offset]integerOptional

Offset from 0 to start paginating. Can be used with page[limit]

page[limit]integerOptional

Maximum number of items to return. Can be used with page[offset]

page[totals]stringOptional

For requesting total pages/records be included in the response page meta data

Responses

200

Successful response

application/vnd.api+json

get/organization/{organizationId}/project

GET /api/v1/organization/{organizationId}/project HTTP/1.1
Accept: */*

200

Successful response

{
  "data": [],
  "included": [
    {
      "attributes": {},
      "id": "text",
      "relationships": {},
      "type": "text"
    }
  ]
}

post

Creates an item of type project and adds it to project

Path parameters

organizationIdstringRequired

organization Identifier

Body

Responses

201

Successful response

application/vnd.api+json

post/organization/{organizationId}/project

POST /api/v1/organization/{organizationId}/project HTTP/1.1
Content-Type: application/vnd.api+json
Accept: */*
Content-Length: 209

{
  "data": {
    "type": "text",
    "id": "text",
    "attributes": {
      "name": "text",
      "description": "text"
    },
    "relationships": {
      "organization": {
        "id": "text",
        "type": "organization"
      },
      "projectAccess": {
        "id": "text",
        "type": "project_access"
      }
    }
  }
}

201

Successful response

{
  "data": {
    "type": "text",
    "id": "text",
    "attributes": {
      "name": "text",
      "description": "text"
    },
    "relationships": {
      "organization": {
        "id": "text",
        "type": "organization"
      },
      "projectAccess": {
        "id": "text",
        "type": "project_access"
      }
    }
  }
}

get

Returns an instance of type project

Path parameters

organizationIdstringRequired

organization Identifier

projectIdstringRequired

project Identifier

Query parameters

Responses

200

Successful response

application/vnd.api+json

get/organization/{organizationId}/project/{projectId}

GET /api/v1/organization/{organizationId}/project/{projectId} HTTP/1.1
Accept: */*

200

Successful response

{
  "data": {
    "type": "text",
    "id": "text",
    "attributes": {
      "name": "text",
      "description": "text"
    },
    "relationships": {
      "organization": {
        "id": "text",
        "type": "organization"
      },
      "projectAccess": {
        "id": "text",
        "type": "project_access"
      }
    }
  },
  "included": [
    {
      "attributes": {},
      "id": "text",
      "relationships": {},
      "type": "text"
    }
  ]
}

patch

Modifies an instance of type project

Path parameters

organizationIdstringRequired

organization Identifier

projectIdstringRequired

project Identifier

Body

Responses

204

Successful response

No content

patch/organization/{organizationId}/project/{projectId}

PATCH /api/v1/organization/{organizationId}/project/{projectId} HTTP/1.1
Content-Type: application/vnd.api+json
Accept: */*
Content-Length: 209

{
  "data": {
    "type": "text",
    "id": "text",
    "attributes": {
      "name": "text",
      "description": "text"
    },
    "relationships": {
      "organization": {
        "id": "text",
        "type": "organization"
      },
      "projectAccess": {
        "id": "text",
        "type": "project_access"
      }
    }
  }
}

204

Successful response

No content

delete

Deletes an instance of type project

Path parameters

organizationIdstringRequired

organization Identifier

projectIdstringRequired

project Identifier

Responses

204

Successful response

No content

delete/organization/{organizationId}/project/{projectId}

DELETE /api/v1/organization/{organizationId}/project/{projectId} HTTP/1.1
Accept: */*

204

Successful response

No content

Workspace Assignment

To assign a workspace to a project, use the workspace relationships endpoint. Set data to null to unassign.

Assign workspace to project:

{
    "data": {
        "type": "project",
        "id": "{{projectId}}"
    }
}

Unassign workspace from project:

{
    "data": null
}

patch

Assigns or unassigns a workspace to a project

Path parameters

organizationIdstringRequired

organization Identifier

workspaceIdstringRequired

workspace Identifier

Body

Responses

204

Successful response

No content

patch/organization/{organizationId}/workspace/{workspaceId}/relationships/project

PATCH /api/v1/organization/{organizationId}/workspace/{workspaceId}/relationships/project HTTP/1.1
Content-Type: application/vnd.api+json
Accept: */*
Content-Length: 39

{
  "data": {
    "type": "project",
    "id": "text"
  }
}

204

Successful response

No content

For a complete list of organization operation please visit the OpenAPI specification