Projects

PreviousAPI reference NextCreate

Was this helpful?

Delete Project

delete

Delete existing project

Authorizations

Path parameters

app_idintegerRequired

project_idintegerRequired

Responses

Responseany

delete

DELETE /api/v2/{app_id}/projects/{project_id} HTTP/1.1
Host: 
Accept: */*

No content

Get Project

get

Retrieve existing project

Authorizations

Path parameters

app_idintegerRequired

project_idintegerRequired

Responses

get

GET /api/v2/{app_id}/projects/{project_id} HTTP/1.1
Host: 
Accept: */*

{
  "area_of_interest": {
    "geometry": {
      "coordinates": [
        -78.84779139647071,
        -4.0988921451725275
      ],
      "type": "Point"
    },
    "properties": {
      "radius": 0.133
    }
  },
  "description": "Project description",
  "id": 123,
  "name": "Project name"
}

Update Project

put

Update existing project

Authorizations

Path parameters

app_idintegerRequired

project_idintegerRequired

Body

nameany ofOptional

Project name

stringOptional

nullOptional

descriptionany ofOptional

Project description

stringOptional

nullOptional

publicany ofOptional

Project publication setting

booleanOptional

nullOptional

Responses

put

PUT /api/v2/{app_id}/projects/{project_id} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 59

{
  "description": "Project description",
  "name": "Project name"
}

{
  "area_of_interest": {
    "geometry": {
      "coordinates": [
        -78.84779139647071,
        -4.0988921451725275
      ],
      "type": "Point"
    },
    "properties": {
      "radius": 0.133
    }
  },
  "description": "Project description",
  "id": 123,
  "name": "Project name"
}