NitroPack Cloud API (1.2.0)

Download OpenAPI specification:Download

NitroPack Cloud API Documentation

AdditionalDomains

Enable

Enables additional domains for a given Site ID

Authorizations:
X-Nitro-Signature
path Parameters
siteId
required
string

Site ID

Responses

Response samples

Content type
application/json
{
  • "error": "Invalid request"
}

Disable

Disables additional domains for a given Site ID

Authorizations:
X-Nitro-Signature
path Parameters
siteId
required
string

Site ID

Responses

Response samples

Content type
application/json
{
  • "error": "Invalid request"
}

Add

Adds an additional domain

Authorizations:
X-Nitro-Signature
path Parameters
siteId
required
string

Site ID

Request Body schema: application/json
domain
string

The domain that should be added. For ex. example.com

Responses

Request samples

Content type
application/json
{
  • "domain": "example.com"
}

Response samples

Content type
application/json
{
  • "message": "Domain: example.com was added."
}

Remove

Remove a domain from the additional domains list

Authorizations:
X-Nitro-Signature
path Parameters
siteId
required
string

Site ID

Request Body schema: application/json
domain
string

The domain that should be removed. For ex. example.com

Responses

Request samples

Content type
application/json
{
  • "domain": "example.com"
}

Response samples

Content type
application/json
{
  • "message": "Domain: example.com was removed."
}

Get

Get a list of currently added additional domains

Authorizations:
X-Nitro-Signature
path Parameters
siteId
required
string

Site ID

Responses

Response samples

Content type
application/json
[
  • "example1.com",
  • "example2.com"
]

Cache

Get

Authorizations:
X-Nitro-Signature
path Parameters
siteId
required
string

Site ID

layout
required
string

A (design) layout identifier. Critical CSS is generated only once per layout. Use this parameter to create separate critical CSS for the different page layouts on your site. For example your home page would be typically layed out in a different way compared to your product pages for example. You can use a "home" layout string for the home page and "product" for all your product pages. Avoid using unique layout identifiers for each URL though, as this will increase the time needed to prepare an optimized cache file for the requested URL.

header Parameters
X-Nitro-Url
required
string

The URL that you are requesting cache for

X-Nitro-Visitor-Addr
string

The IP of the visitor that triggered this call to /cache/get. We will forward this IP through X-Forwarded-For header when fetching the requested URL

X-Nitro-Cache-Prefix
string

A custom cache prefix. Use this when you need to divide the cache based on custom rules for your platform. For example, if you serve different content based on the visitor's location, you can add the country, continent, language, etc. as a prefix.

X-Nitro-Ajax
string

Indicate whether we should request this URL via AJAX

X-Nitro-Priority
string

Use this to schedule an optimization with low priority. The only possible value for this parameter is "LOW".

X-Nitro-Loopback
string

If this header is present NitroPack will bypass DNS records and connect directly to the IP calling this method.

Responses

Purge

Deletes the cache files stored on our servers and removes tag associations. If a URL is specified only cache files for this URL are deleted and only the tag associations with this URL are removed. This operation frees disk space.

Authorizations:
X-Nitro-Signature
path Parameters
siteId
required
string

Site ID

Request Body schema: application/json
url
string

A specific URL that you would like to purge cache for.

tag
string

A specific tag that you would like to purge cache for. If this is provided it takes precedence over the url parameter and the API will return a list of the purged URLs. The returned list contains up to 250 purged URLs, so you may need to keep repeating this request until the returned list contains no items.

pagecache_only
boolean

If true only page cache files will be purged. Otherwise, the entire cache is deleted included stored assets.

light_purge
boolean

If true it will preserve images from being deleted. If pagecache_only is true this will be ignored.

reason
string

The purge reason, in human-readable form.

Responses

Request samples

Content type
application/json
{
  • "url": "string",
  • "tag": "string",
  • "pagecache_only": true,
  • "light_purge": true,
  • "reason": "string"
}

Response samples

Content type
application/json
Example
""

Get Last Purge

Returns information about the last /cache/purge request for the site identified by siteId

Authorizations:
X-Nitro-Signature
path Parameters
siteId
required
string

Site ID

Responses

Response samples

Content type
application/json
{}

Enable Cart Cache

Enables cart cache option in the config file for the site identified by siteId

Authorizations:
X-Nitro-Signature
path Parameters
siteId
required
string

Site ID

Responses

Response samples

Content type
application/json
{
  • "error": "Invalid request"
}

Disable Cart Cache

Disables cart cache option in the config file for the site identified by siteId

Authorizations:
X-Nitro-Signature
path Parameters
siteId
required
string

Site ID

Responses

Response samples

Content type
application/json
{
  • "error": "Invalid request"
}

Config

Get Challenge

Returns a challenge to be solved on your end. You need to get and solve one of these challenges, then provide the result in the request to /config/get. This is needed in order to verify that we serve your config to your applications only. Any request to /config/get that does not provide a challnegeId and a valid solution will be rejected.

Fetching the config from the server:

The API offers a way to retrieve the configuration file, which contains the settings edited through the administrative dashboard. In order to obtain the configuration, the API client must prove that it holds the site secret. To do this the client must provide a response to a challenge issued by the API server. The API server would never ask for the client to send the plaintext site secret over the network, nor would it ever send the secret to the client.

Challenges are 128 random bytes encoded as lowercase hex digits resulting in a 256 character string. The response to a challenge is calculated using the following formula: sha512(sha512(sha512(sha512(sha512(secret + challenge))))) Or in other words, first concatenate the site secret and challenge strings (in that order), then apply the sha512 hashing algorithm to the combined string 5 times. The result of the last hashing is the challenge response.

Below are the steps that must be carried out to receive and answer a challenge:

First the API client makes an HTTP GET request to https://api.getnitropack.com/config/getchallenge/:site_id

The API will return a JSON structure as follows:

{
"cid":  "...", // Challenge ID (64 character string)
"sc0":  "...", // Server challenge 0 (256 character string)
"sc1":  "...", // Server challenge 1 (256 character string)
"resp": "..."  // Response to server challenge 0 (128 character string)
}

The challenge ID is to be submitted along with the challenge response. Server challenge 0 is used for the client to verify that the challenge came from the API server. The client should calculate the expected response for server challenge 0 using the site secret and the formula above and compare the result with the "resp" key using a cryptographically secure string comparison algorithm (ex. PHP's hash_equals function).

If this comparison fails, the client should terminate its attempt to fetch the configuration and notify the administrator managing the site running the client.

Once the client has established that the challenge came from the API server, it can proceed with calculating the response to server challenge 1, again using the site secret and the formula above.

Then the client should make a second HTTP GET request, this time to https://api.getnitropack.com/config/get/:site_id where :site_id matches the :site_id from the first request. This request should include two additional headers: X-Challenge-ID: The challenge ID from the JSON response of the previous request X-Challenge-Response: The challenge response calculated from Server challenge 1

The response to this request will always be JSON formatted. If the challenge response was correct, then the response will have an HTTP status 200 and the body will contain the configuration for the given :site_id. If something went wrong, then the response will have an HTTP status 403 and the body will be {"error":"Invalid request"} Note that by design the API will return the same error with no specific explanation for all issues, including wrong a site_id, wrong or expired challenge id, or incorrect challenge response.

Challenges expire 30 seconds after they are created, after which even a correct challenge response will not be accepted.

path Parameters
siteId
required
string

Site ID

Responses

Response samples

Content type
application/json
{
  • "cid": "...",
  • "sc0": "...",
  • "sc1": "...",
  • "resp": "..."
}

Get Config

Returns the config, for the site identified by siteId, as a JSON encoded string

path Parameters
siteId
required
string

Site ID

header Parameters
X-Challenge-Id
required
string

The challenge ID that was provided to you by /config/getchallenge

X-Challenge-Response
required
string

The challenge response calculated from Server Challenge 1 provided to you by /config/getchallenge

Responses

Response samples

Content type
application/json
{ }

ExcludedUrls

Enable

Enable excluded urls for the given website

Authorizations:
X-Nitro-Signature
path Parameters
siteId
required
string

Site ID

Responses

Response samples

Content type
application/json
{
  • "error": "Invalid request"
}

Disable

Disable excluded urls for the given website

Authorizations:
X-Nitro-Signature
path Parameters
siteId
required
string

Site ID

Responses

Response samples

Content type
application/json
{
  • "error": "Invalid request"
}

Add

Add excluded url for the given website

Authorizations:
X-Nitro-Signature
path Parameters
siteId
required
string

Site ID

Request Body schema: application/json
url_pattern
string

Responses

Request samples

Content type
application/json
{
  • "url_pattern": "*excluded-pattern*"
}

Response samples

Content type
application/json
{
  • "error": "Invalid request"
}

Remove

Remove excluded url for the given website

Authorizations:
X-Nitro-Signature
path Parameters
siteId
required
string

Site ID

Request Body schema: application/json
url_pattern
string

Responses

Request samples

Content type
application/json
{
  • "url_pattern": "*excluded-pattern*"
}

Response samples

Content type
application/json
{
  • "error": "Invalid request"
}

Excludes

Enable

Enable excludes for the given website

Authorizations:
X-Nitro-Signature
path Parameters
siteId
required
string

Site ID

Responses

Response samples

Content type
application/json
{
  • "error": "Invalid request"
}

Disable

Disaboe excludes for the given website

Authorizations:
X-Nitro-Signature
path Parameters
siteId
required
string

Site ID

Responses

Response samples

Content type
application/json
{
  • "error": "Invalid request"
}

Get

Get excludes for the given website

Authorizations:
X-Nitro-Signature
path Parameters
siteId
required
string

Site ID

Responses

Response samples

Content type
application/json
{
  • "error": "Invalid request"
}

Set

Set excludes for the given website

Authorizations:
X-Nitro-Signature
path Parameters
siteId
required
string

Site ID

Request Body schema: application/x-www-form-urlencoded
required
Array of objects

Excludes

Responses

Response samples

Content type
application/json
{
  • "error": "Invalid request"
}

FontSubsetting

Get

Get a subsetted version of fonts for a given URL

path Parameters
siteId
required
string

Site ID

header Parameters
X-Nitro-Url
required
string

The URL that you want fonts subsetted for

X-Nitro-Device
required
string

The device type to use when loading the URL. Should be one of the following: desktop, mobile, tablet

Responses

Response samples

Content type
application/json
{
  • "fonts": {
    },
  • "glyphs": [
    ]
}

Health

Status

Check the server status for a given Site ID

path Parameters
siteId
required
string

Site ID

Responses

Response samples

Content type
application/json
{
  • "error": "Invalid request"
}

SafeMode

Status

Gives the status of safe mode for a given Site ID

Authorizations:
X-Nitro-Signature
path Parameters
siteId
required
string

Site ID

Responses

Response samples

Content type
application/json
Example
{
  • "isEnabled": 1
}

Enable

Enables safe mode for a given Site ID

Authorizations:
X-Nitro-Signature
path Parameters
siteId
required
string

Site ID

Responses

Response samples

Content type
application/json
{
  • "error": "Invalid request"
}

Disable

Disables safe mode for a given Site ID

Authorizations:
X-Nitro-Signature
path Parameters
siteId
required
string

Site ID

Responses

Response samples

Content type
application/json
{
  • "error": "Invalid request"
}

Stats

Savings

Returns an array with the Html, CSS, JS and Image savings in bytes along with a total.

Authorizations:
X-Nitro-Signature
path Parameters
siteId
required
string

Site ID

Responses

Response samples

Content type
application/json
{
  • "html": 0,
  • "css": 11245243,
  • "js": 88234014,
  • "image": 234702347,
  • "total": 334181604
}

Reset

Resets the Html, CSS, JS and Image savings stats.

Authorizations:
X-Nitro-Signature
path Parameters
siteId
required
string

Site ID

Responses

Response samples

Content type
application/json
{
  • "error": "Invalid request"
}

Disk Usage

Returns the disk usage on our storage servers in bytes

Authorizations:
X-Nitro-Signature
path Parameters
siteId
required
string

Site ID

Responses

Response samples

Content type
application/json
{
  • "diskUsage": 334181604,
  • "freeSpace": 983240,
  • "diskUsageHtml": 4181604,
  • "diskUsageCss": 34181604,
  • "diskUsageJs": 181604,
  • "diskUsageFont": 81604,
  • "diskUsageImage": 330181604
}

Request Usage

Returns the number of optimization requests that have been made and the maximum number of requests included in your billing plan.

Authorizations:
X-Nitro-Signature
path Parameters
siteId
required
string

Site ID

Responses

Response samples

Content type
application/json
{
  • "count": 250,
  • "maxCount": 5000
}

Tags

Add

Assigns the provided tags to the provided URL. You can later use tags to performs operations like purging the cache for all URLs tagged by a certain tag name.

Authorizations:
X-Nitro-Signature
path Parameters
siteId
required
string

Site ID

Request Body schema: application/json
required
url
required
string

A URL that you would like to tag

tag
required
string

A tag name that you wish to assign to the URL. Multiple tag names can be separated with a comma(,). Tag names must match the following pattern: /^[a-zA-Z0-9:]+$/ and be no longer than 128 chars

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
Example
{
  • "success": true
}

Remove

Unassigned the provided tags from the provided URL

Authorizations:
X-Nitro-Signature
path Parameters
siteId
required
string

Site ID

Request Body schema: application/json
required
url
string

A URL that you would like to remove a tag from. If not provided the tag will be removed from all URLs

tag
required
string

A tag name that you wish to unassigned from the URL. You can use wildcards (*) to remove more than one tags in one go.

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "removed": 3
}

Get URLs

Returns a list of URLs that have been tagged with the provided tag name. The responses are paginated including up to 250 results per page. The response code will be 404 if no matches have been found.

Status codes definition

  • 5000: Unknown error
  • 5001: Connecting to the server timed out
  • 5002: Reading response timed out
  • 5003: Optimization is skipped because the service is disabled for this site
  • 5004: URL does not match any of the rules for enabled/disabled optimized_urls
  • 5005: Generating critical CSS can fail if there is invalid CSS on the page
  • 5006: Cloudflare's Rocket Loader was detected. This option conflicts with NitroPack. Please disable it.
  • 5007: Optimization skipped because 'X-Nitro-Expires' header pointing to a moment in the past has been detected
  • 5008: Imunify360 was detected. NitroPack's IPs must be whitelisted in order to avoid this error
  • 5009: Not an HTML page
  • 5010: Optimization skipped because removing the unused CSS did not succeed. Purge this cache to try again.
  • 5011: The page source file is too big
  • 5012: The page TTL is too low (<5min)
  • 3001: Optimization skipped because a redirect via "Location" header has been detected
  • 2000: Optimization skipped because "X-Nitro-Disabled" header has been detected
  • 2001: Optimization skipped because "X-Nitro-Cache:Hit" header has been detected
  • 2002: Optimization skipped because the response was empty
  • 2003: Optimization skipped because an 'Old Browser' screen has been detected
  • 2004: Optimization skipped because the page was detected as AMP document
  • 2005: Optimization skipped because the page is already optimized by NitroPack
  • 2006: Optimization skipped because a third party caching system has been detected
Authorizations:
X-Nitro-Signature
path Parameters
siteId
required
string

Site ID

tagName
required
string

A tag name that you wish to get URLs for. You can use wildcards (*) to match multiple tags. For example "apple:*" will match both "apple:iphone" and "apple:macbook".

page
required
string

The page number that you need results for. The first page number is 1.

limit
required
string

Change the default limit of 250 to a custom value. Max value is still 250 though.

Responses

Response samples

Content type
application/json
[]

Get URLs Count

Returns a count of URLs that have been tagged with the provided tag name.

Authorizations:
X-Nitro-Signature
path Parameters
siteId
required
string

Site ID

tagName
required
string

A tag name that you wish to get URLs for. You can use wildcards (*) to match multiple tags. For example "apple:*" will match both "apple:iphone" and "apple:macbook".

Responses

Response samples

Content type
application/json
{
  • "count": 12
}

Get

Returns a list of all tags assigned to the queried url.

Authorizations:
X-Nitro-Signature
path Parameters
siteId
required
string

Site ID

page
required
integer

The page number that you need results for. The first page number is 1.

limit
required
integer

Change the default limit of 250 to a custom value. Max value is still 250 though.

query Parameters
url
integer

The url for which you wish to get tags for. This parameter should be encoded as url.

Responses

Response samples

Content type
application/json
"[\"apple\"]"

Urls

Get

Returns a paginated list of urls assigned to the site. Each page can contain up to 250 result entries |

Status codes definition

  • 5000: Unknown error
  • 5001: Connecting to the server timed out
  • 5002: Reading response timed out
  • 5003: Optimization is skipped because the service is disabled for this site
  • 5004: URL does not match any of the rules for enabled/disabled optimized_urls
  • 5005: Generating critical CSS can fail if there is invalid CSS on the page
  • 5006: Cloudflare's Rocket Loader was detected. This option conflicts with NitroPack. Please disable it.
  • 5007: Optimization skipped because 'X-Nitro-Expires' header pointing to a moment in the past has been detected
  • 5008: Imunify360 was detected. NitroPack's IPs must be whitelisted in order to avoid this error
  • 5009: Not an HTML page
  • 5010: Optimization skipped because removing the unused CSS did not succeed. Purge this cache to try again.
  • 5011: The page source file is too big
  • 5012: The page TTL is too low (<5min)
  • 3001: Optimization skipped because a redirect via "Location" header has been detected
  • 2000: Optimization skipped because "X-Nitro-Disabled" header has been detected
  • 2001: Optimization skipped because "X-Nitro-Cache:Hit" header has been detected
  • 2002: Optimization skipped because the response was empty
  • 2003: Optimization skipped because an 'Old Browser' screen has been detected
  • 2004: Optimization skipped because the page was detected as AMP document
  • 2005: Optimization skipped because the page is already optimized by NitroPack
  • 2006: Optimization skipped because a third party caching system has been detected
Authorizations:
X-Nitro-Signature
path Parameters
siteId
required
string

Site ID

page
required
integer

The page number that you need results for. The first page number is 1.

limit
required
integer

The page number that you need results for. The first page number is 1.

query Parameters
search
string

Use this to filter URLs matching a pattern. Wildcards (*) are allowed.

deviceType
string

Use this to filter URLs by device type. Accepted values are "desktop", "tablet", "mobile" and "none". If "none" is used, the results will include URLs that have only been tagged, but not optimized.

status
string

Use this to filter URLs by status. Accepted values are all statuses described at the end of this document. To get URLs which are still pending for optimization use status -1.

Responses

Response samples

Content type
application/json
[]

Count

Returns the number of optimized URLs. Does not take cache expiration into account, it simply returns the number of unique URLs that we have logged due to optimization requests or tagging.

Authorizations:
X-Nitro-Signature
path Parameters
siteId
required
string

Site ID

query Parameters
search
string

Use this to filter URLs matching a pattern. Wildcards (*) are allowed.

deviceType
string

Use this to filter URLs by device type. Accepted values are "desktop", "tablet", "mobile" and "none". If "none" is used, the results will include URLs that have only been tagged, but not optimized.

status
string

Use this to filter URLs by status. Accepted values are all statuses described at the end of this document. To get URLs which are still pending for optimization use status -1.

Responses

Response samples

Content type
application/json
{
  • "count": 256
}

Get Pending URLs

Returns a paginated list of urls waiting to be optimized. Each page can contain up to 250 result entries.

Authorizations:
X-Nitro-Signature
path Parameters
siteId
required
string

Site ID

page
required
string

The page number that you need results for. The first page number is 1.

limit
required
string

Change the default limit of 250 to a custom value. Max value is still 250 though.

query Parameters
priority
string

If present, information about the specified priority queue will be used. Possible values are: "low"

Responses

Response samples

Content type
application/json
[]

Get Pending Count URLs

Returns the number of cache variations that are pending (can be more than the number of URLs).

Authorizations:
X-Nitro-Signature
path Parameters
siteId
required
string

Site ID

query Parameters
priority
string

If present, information about the specified priority queue will be used. Possible values are: "low"

Responses

Response samples

Content type
application/json
{
  • "count": 256
}

VariationCookie

Get

Get a list of all variation cookies

Authorizations:
X-Nitro-Signature
path Parameters
siteId
required
string

Site ID

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Delete

Unset a variation cookie by providing its name.

Authorizations:
X-Nitro-Signature
path Parameters
siteId
required
string

Site ID

Request Body schema: application/json
name
string

The name of the variation cookie.

Responses

Request samples

Content type
application/json
{
  • "name": "notification_popup"
}

Response samples

Content type
application/json
{
  • "error": "Invalid request"
}

Set

Set a variation cookie by providing its name and, optionally, appropriate values. Variation cookies are used for generating unique cached pages for a different combination of cookies. The optional values are used by the Cache Warmup service.

Authorizations:
X-Nitro-Signature
path Parameters
siteId
required
string

Site ID

Request Body schema: application/json
name
string

The name of the variation cookie.

value
string

Optional possible values for this cookie (comma-separated).

group
integer

Optional group of this cookie. Must be a positive integer. This attribute is used to group different cookies for the purposes of Cache Warmup. If group is not provided, the cookie will be accepted, and will not belong to any group.

Responses

Request samples

Content type
application/json
{
  • "name": "language",
  • "value": "en,de,es"
}

Response samples

Content type
application/json
{
  • "error": "Invalid request"
}

Varnish

Enable

Authorizations:
X-Nitro-Signature
path Parameters
siteId
required
string

Site ID

Responses

Response samples

Content type
application/json
{
  • "error": "Invalid request"
}

Disable

Authorizations:
X-Nitro-Signature
path Parameters
siteId
required
string

Site ID

Responses

Response samples

Content type
application/json
{
  • "error": "Invalid request"
}

Configure

Authorizations:
X-Nitro-Signature
path Parameters
siteId
required
string

Site ID

Responses

Response samples

Content type
application/json
{
  • "error": "Invalid request"
}

Get

Authorizations:
X-Nitro-Signature
path Parameters
siteId
required
string

Site ID

Responses

Response samples

Content type
application/json
{
  • "error": "Invalid request"
}

Set

Authorizations:
X-Nitro-Signature
path Parameters
siteId
required
string

Site ID

Request Body schema: application/x-www-form-urlencoded
required
Array of objects

Purge Configs Set

Responses

Response samples

Content type
application/json
{
  • "error": "Invalid request"
}

Warmup

Enable

Enable cache warmup for the given website

Authorizations:
X-Nitro-Signature
path Parameters
siteId
required
string

Site ID

Responses

Response samples

Content type
application/json
{
  • "error": "Invalid request"
}

Disable

Disable cache warmup for the given website

Authorizations:
X-Nitro-Signature
path Parameters
siteId
required
string

Site ID

Responses

Response samples

Content type
application/json
{
  • "error": "Invalid request"
}

Reset

Reset the cache warmup queue and stats for the given website.

Authorizations:
X-Nitro-Signature
path Parameters
siteId
required
string

Site ID

Responses

Response samples

Content type
application/json
{
  • "error": "Invalid request"
}

Get Stats

Get cache warmup stats for the given website.

Authorizations:
X-Nitro-Signature
path Parameters
siteId
required
string

Site ID

Responses

Response samples

Content type
application/json
{}

Set Homepage

Set a home page URL for the given webite. The links found in the home page will be crawled on events like cache purge. (If SiteMap XML is configured it takes precedence over this setting)

Authorizations:
X-Nitro-Signature
path Parameters
siteId
required
string

Site ID

Request Body schema: application/json
url
string

Your home page URL. If this parameter is not present in the request, the call to this endpoint works as unset.

Responses

Request samples

Content type
application/json

Response samples

Content type
application/json
{
  • "error": "Invalid request"
}

Set Sitemap

Set a sitemap URL for the given website. The sitemap URL must be publicly accessible and formatted in the SiteMap XML format. The links found in this sitemap will be crawled on events like cache purge.

Authorizations:
X-Nitro-Signature
path Parameters
siteId
required
string

Site ID

Request Body schema: application/json
url
string

Your publicly accessible sitemap URL. If not present the call to this endpoint works as unset.

Responses

Request samples

Content type
application/json

Response samples

Content type
application/json
{
  • "error": "Invalid request"
}

Estimate

Estimate how many optimizations will be used for cache warmup using the current settings.

Authorizations:
X-Nitro-Signature
path Parameters
siteId
required
string

Site ID

id
required
string

Leaving this parameter empty will start a new estimation process. Passing an ID will return the result of the estimation. If NitroPack is still estimating the returned number will be -1. Estimation results expire in 1h.

Request Body schema: application/json
urls
string

A list of URLs to be warmed up. If empty or not set the home page links or the entire sitemap list (if configured) will be warmed up.

Responses

Request samples

Content type
application/json

Response samples

Content type
application/json
{
  • "count": 1432
}

Run

Run cache warmup for the given website.

Authorizations:
X-Nitro-Signature
path Parameters
siteId
required
string

Site ID

Request Body schema: application/json
urls
string

A list of URLs to be warmed up. If empty or not set the home page links or the entire sitemap list (if configured) will be warmed up.

Responses

Request samples

Content type
application/json

Response samples

Content type
application/json
{
  • "error": "Invalid request"
}

Webhook

Set

Set a webhook URL for the given website. The webhook URL must be publically accessible, as the API will call it on specific events:

  • config : Whenever you edit your store settings from the NitroPack.io Dashboard.
  • cache_clear : Whenever you purge your cache or clear the cache for a specific page.
  • cache_ready : Whenever an optimized page version is ready, NitroPack will call this webhook providing the URL to the optimized page. (Information that defines a page variation like cookies, user-agent, etc. is provided within the request)
  • sitemap : An endpoint of your Sitemap XML, used by the NitroPack Cache Warmup service to re-generate cache for your pages.
Authorizations:
X-Nitro-Signature
path Parameters
siteId
required
string

Site ID

Request Body schema: application/json
required
type
required
string

The type of the webhook. Allowed values: "config", "cache_clear", "cache_ready", "sitemap"

url
string

Your publically accessible webhook URL.

Responses

Request samples

Content type
application/json
Example
{}

Response samples

Content type
application/json
{
  • "error": "Invalid request"
}

Get

Get a webhook URL for the given webite.

Authorizations:
X-Nitro-Signature
path Parameters
siteId
required
string

Site ID

type
required
string

The type of the webhook. Allowed values: "config", "cache_clear", "cache_ready", "sitemap"

Responses

Response samples

Content type
application/json
{
  • "error": "Invalid request"
}