logo

Static Site Deployments

With the deployments endpoint, you can get deployment details like the deployment progress and more.

You can also send a POST request to the endpoint to manually or programmatically deploy a static site. This request can be done from your terminal or using an automated script or CI/CD pipeline (e.g. CircleCI, Jenkins, etc.).

You can obtain the deployment_id from the static_sites endpoint.

The deployment_id is also shown in the URL within the deployment in MyKinsta, for example in the URL https://my.kinsta.com/staticSite/hello-world-astro-7u8mu/deployment/6783883e-4af8-47ab-a03a-3db6177d4291?idCompany=bdd25d71-5706-4890-870f-1adda17c505d the deployment_id is 6783883e-4af8-47ab-a03a-3db6177d4291.

Get static site deployment details

SecuritybearerAuth
Request
path Parameters
deployment_id
required
string <uuid>
Example: 54fb80af-576c-4fdc-ba4f-b596c83f15a1
Responses
200

Response object of static site deployment by ID requests

401

No or invalid API key provided to the request

404

Could not find the static site deployment or the user does not have permissions to retrieve data

500

Error occurred while retrieving static site deployment

get/static-sites/deployments/{deployment_id}
Request samples 
Response samples 
static site/json
{
  • "deployment": {
    }
}
Manually deploy a static site
SecuritybearerAuth 
Request 
Request Body schema: application/json
required
static_site_id
required
string <uuid> 
 
branch
string
 
Responses 
200
Deployment created successfully


401
No or invalid API key provided to the request


500
Error occurred while creating the deployment


post/static-sites/deployments
Request samples 
application/json
{
  • "static_site_id": "54fb80af-576c-4fdc-ba4f-b596c83f15a1",
  • "branch": "main"
}
Response samples 
application/json
{
  • "deployment": {
    }
}
Redeploy a static site
SecuritybearerAuth 
Request 
Request Body schema: application/json
required
static_site_id
required
string <uuid> 
 
deployment_id
string <uuid> 
 
Responses 
200
Deployment created successfully


401
No or invalid API key provided to the request


500
Error occurred while creating the deployment


post/static-sites/deployments/redeploy
Request samples 
application/json
{
  • "static_site_id": "54fb80af-576c-4fdc-ba4f-b596c83f15a1",
  • "deployment_id": "12fb80af-576d-4fdc-ra4f-b596c83f86yv"
}
Response samples 
application/json
{
  • "deployment": {
    }
}
➔ Next to Applications