Project properties ​

Use the following endpoints to manage project properties programmatically.

Rate limits ​

Project property resources have the following rate limits:

Quick reference ​

List project properties ​

Returns a list of project-level properties belonging to a specific project in a customer workspace that matches a project_id you specify. You must also include a prefix. For example, if you provide the prefix salesforce_sync., any project property with a name beginning with salesforce_sync., such as salesforce_sync.admin_email, with the project_id you provided is returned.

GET https://YOUR_DATA_CENTER/api/properties

Query parameters ​

Sample request ​

curl  -X GET 'https://YOUR_DATA_CENTER/api/properties?prefix=:prefix_value&project_id=:project_id_value' \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json'

Response ​

{
  "public_url": "https://www.example.com",
  "admin_email": "[email protected]"
}

Upsert project properties ​

Upserts project properties belonging to a specific project in a customer workspace that matches a project_id you specify. This endpoint maps to properties based on the names you provide in the request.

POST https://YOUR_DATA_CENTER/api/properties

Query parameters ​

Payload ​

Sample request ​

curl  -X POST 'https://YOUR_DATA_CENTER/api/properties?project_id=:project_id_value' \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \
      -d '{ "properties": { ":property_key_1": ":property_value_1", ":property_key_2": ":property_value_2" }}'

Response ​

{
  "success": true
}