The Provisioning API
The Provisioning API allows you to create and delete Tideways projects from automated systems such as deployment pipelines, internal control panels or infrastructure management tools.
Unlike the Hosting Partner API,
which is restricted to registered hosting partners, the Provisioning API
is available to any Tideways 8 organization that creates an API token with the provisioning scope.
Provision a Project
Requirements: You need an API access token with the provisioning scope for this endpoint.
Create a new project (or retrieve the configuration of an existing one) in an organization.
POST https://app.tideways.io/apps/api/organizations/{organization}/provisioning
Content-Type: application/json
Authorization: Bearer {AccessTokenWithProvisioningScope}
{
"project_name": "www.example.com"
}
The organization path parameter is the name of your Tideways organization.
The project_name parameter is required and must be a non-empty string.
If a project with the given name does not exist in the organization, it is created with a license that matches the organization’s Tideways 8 plan (Team, Business or Enterprise). If the project already exists and is not deleted, its configuration is returned without changes.
Response
{
"id": 26,
"name": "my-organization/www.example.com",
"config": {
"TIDEWAYS_APIKEY": "tw_AGuC...",
"TIDEWAYS_SAMPLERATE": "20"
},
"php.ini": {
"tideways.api_key": "tw_AGuC...",
"tideways.sample_rate": "20"
}
}Use the config or php.ini values to configure the Tideways PHP extension on your servers.
Delete a Project
Requirements: You need an API access token with the provisioning scope for this endpoint.
Delete a project from the organization. The project is marked as deleted and will no longer accept incoming traces.
DELETE https://app.tideways.io/apps/api/organizations/{organization}/provisioning
Content-Type: application/json
Authorization: Bearer {AccessTokenWithProvisioningScope}
{
"project_name": "www.example.com"
}