Get purges history list - Gcore Docs

Overview

IAM

CDN

Managed DNS

Cloud

DDoS Protection

FastEdge

WAAP

Streaming

Object Storage

Resellers

Python

import os
from gcore import Gcore

client = Gcore(
    api_key=os.environ.get("GCORE_API_KEY"),  # This is the default and can be omitted
)
page = client.cdn.list_purge_statuses()
page = page.results[0]
print(page.purge_id)

package main

import (
	"context"
	"fmt"

	"github.com/G-Core/gcore-go"
	"github.com/G-Core/gcore-go/cdn"
	"github.com/G-Core/gcore-go/option"
)

func main() {
	client := gcore.NewClient(
		option.WithAPIKey("My API Key"),
	)
	page, err := client.CDN.ListPurgeStatuses(context.TODO(), cdn.CDNListPurgeStatusesParams{})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", page)
}

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.gcore.com/cdn/purge_statuses', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.gcore.com/cdn/purge_statuses",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

require 'uri'
require 'net/http'

url = URI("https://api.gcore.com/cdn/purge_statuses")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

[
  {
    "purge_id": 1,
    "status": "Successful",
    "resource": {
      "id": 1,
      "cname": "cdn.site.com"
    },
    "payload": {
      "urls": [
        "http://example.com/path1/file1.jpg",
        "http://site.example.com/path-18/file2.jpg"
      ]
    },
    "created": "2021-10-29T13:21:01.550849Z",
    "purge_type": "purge_by_url"
  }
]

GET

/

cdn

/

purge_statuses

Python

import os
from gcore import Gcore

client = Gcore(
    api_key=os.environ.get("GCORE_API_KEY"),  # This is the default and can be omitted
)
page = client.cdn.list_purge_statuses()
page = page.results[0]
print(page.purge_id)

package main

import (
	"context"
	"fmt"

	"github.com/G-Core/gcore-go"
	"github.com/G-Core/gcore-go/cdn"
	"github.com/G-Core/gcore-go/option"
)

func main() {
	client := gcore.NewClient(
		option.WithAPIKey("My API Key"),
	)
	page, err := client.CDN.ListPurgeStatuses(context.TODO(), cdn.CDNListPurgeStatusesParams{})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", page)
}

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.gcore.com/cdn/purge_statuses', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.gcore.com/cdn/purge_statuses",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

require 'uri'
require 'net/http'

url = URI("https://api.gcore.com/cdn/purge_statuses")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

[
  {
    "purge_id": 1,
    "status": "Successful",
    "resource": {
      "id": 1,
      "cname": "cdn.site.com"
    },
    "payload": {
      "urls": [
        "http://example.com/path1/file1.jpg",
        "http://site.example.com/path-18/file2.jpg"
      ]
    },
    "created": "2021-10-29T13:21:01.550849Z",
    "purge_type": "purge_by_url"
  }
]

Authorizations

Authorization

string

header

required

API key for authentication. Make sure to include the word apikey, followed by a single space and then your token. Example: apikey 1234_abcdef

Query Parameters

cname

string

Purges associated with a specific resource CNAME.

Example:

&cname=example.com

status

string

Purge with a certain status.

Possible values:

In progress
Successful
Failed
Status report disabled

purge_type

string

Purge requests with a certain purge type.

Possible values:

purge_by_pattern - Purge by Pattern.
purge_by_url - Purge by URL.
purge_all - Purge All.

from_created

string

Start date and time of the requested time period (ISO 8601/RFC 3339 format, UTC.)

Examples:

&from_created=2021-06-14T00:00:00Z
&from_created=2021-06-14T00:00:00.000Z

to_created

string

End date and time of the requested time period (ISO 8601/RFC 3339 format, UTC.)

Examples:

&to_created=2021-06-15T00:00:00Z
&to_created=2021-06-15T00:00:00.000Z

offset

integer

default:0

Number of purge requests in the response to skip starting from the beginning of the requested period.

limit

integer

default:100

Maximum number of purges in the response.

Required range: x <= 100

Response

200 - application/json

Successful.

Plain list · object[]
Paginated list · object

purge_id

integer

Purge ID.

Example:

1

status

enum<string>

Purge status.

Possible values:

In progress - Purge is in progress.
Successful - Purge was successful.
Failed - Purge failed.

Available options:

In progress,

Successful,

Failed

resource

object

Show child attributes

payload

object

Purge payload depends on purge type.

Possible values:

urls - Purge by URL.
paths - Purge by Pattern and purge All.

Example:

{
  "urls": [
    "http://example.com/path1/file1.jpg",
    "http://site.example.com/path-18/file2.jpg"
  ]
}

created

string

Date and time when the purge was created (ISO 8601/RFC 3339 format, UTC).

Example:

"2021-10-29T13:21:01.550849Z"

purge_type

string

Contains the name of the purge request type.

Possible values:

purge_by_pattern - Purge by Pattern.
purge_by_url - Purge by URL.
purge_all - Purge All.

Example:

"purge_by_url"

Get rule applied preset fields Get SSL certificates list

⌘I