Projects API Reference
API Reference/Projects

Projects

For authentication instructions, see API overview.

Endpoints

get/api/v2/projects
post/api/v2/projects
get/api/v2/projects/:id
put/api/v2/projects/:id
patch/api/v2/projects/:id
delete/api/v2/projects/:id
get

List all projects

Returns a list of projects. The projects are returned in sorted order, with the most recent appearing first.

Query parameters

  • limitinteger

    The number of records to return

  • pageinteger

    The page number

  • orderstring

    The order of the records

  • sortBystring

    The sort of the records

  • fieldsstring

    The filter of the records

  • pstring

    policyFilters

  • qstring

    search query

Request

cURL
export ICLOUDREADY_API_KEY=[your api key]
curl \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://api.icloud-ready.com/api/v2/projects

Response

No response schema
post

Create project

Create project. You need to pass through any required fields, and you can optionally pass through other fields.

Request body

  • namestring
  • subprojectsarray
  • addressobject
  • citystring
  • countrystring
  • regionstring
  • typestring
  • usagestring

Request

cURL
export ICLOUDREADY_API_KEY=[your api key]
curl -X POST -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://api.icloud-ready.com/api/v2/projects \
	-d 'name="UX-Venuesds sdXX0"' \
	-d 'subprojects="array"' \
	-d 'address="object"' \
	-d 'city="Cairo"' \
	-d 'country="Cairo"' \
	-d 'region="Cairo"' \
	-d 'type="towers"' \
	-d 'usage="commercial"'

Response

No response schema
get

Retrieve project

Returns a single projec, which you can request by passing through an id in the url.

Path parameters

  • idstring

    ID of the project

Request

cURL
export ICLOUDREADY_API_KEY=[your api key]
curl \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://api.icloud-ready.com/api/v2/projects/:id

Response

No response schema
put

Update project

Path parameters

  • idstring

    ID of the project

Request body

  • namestring
  • subprojectsarray
  • addressobject
  • citystring
  • countrystring
  • regionstring
  • typestring
  • usagestring

Request

cURL
export ICLOUDREADY_API_KEY=[your api key]
curl -X PUT \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://api.icloud-ready.com/api/v2/projects/:id \
	-d 'name="UX-Venuesds sdXX0"' \
	-d 'subprojects="array"' \
	-d 'address="object"' \
	-d 'city="Cairo"' \
	-d 'country="Cairo"' \
	-d 'region="Cairo"' \
	-d 'type="towers"' \
	-d 'usage="commercial"'

Response

No response schema
patch

Update project soft

Update project soft by setting the values of the parameters passed. Any parameters not set will be unchanged.

Path parameters

  • idstring

    ID of the project

Request

cURL
export ICLOUDREADY_API_KEY=[your api key]
curl \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://api.icloud-ready.com/api/v2/projects/:id

Response

No response schema
delete

Delete project

Path parameters

  • idstring

    ID of the project

Request

cURL
export ICLOUDREADY_API_KEY=[your api key]
curl -X DELETE \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://api.icloud-ready.com/api/v2/projects/:id

Response

No response schema