オーダーステータスを更新する

PUT

https://www.digicert.com/services/v2/order/certificate/{{order_id}}/status

Use this endpoint to cancel a pending certificate order or to mark a migrated certificate order as renewed or not renewed.

To cancel a pending order, the order status must be pending or waiting_pickup.
To mark a migrated certificate order* as renewed, the certificate must be within 90 days of its expiration date or be expired.
To mark a migrated certificate order* as not_renewed, you must have first marked the order as renewed

*Migrated certificate orders

When you migrate an order from your legacy console and then renew it in CertCentral, the original order may not automatically update to reflect the renewal. To prevent these "renewed" orders from appearing alongside orders that still need to be renewed, you can manually change the status of the original order to renewed.

To renew a migrated order that you've marked renewed, you must first set the status of that order to not_renewed.

Example requests and response

cURL

curl -X PUT \
  'https://www.digicert.com/services/v2/order/certificate/{{order_id}}/status' \
  -H 'Content-Type: application/json' \
  -H 'X-DC-DEVKEY: {{api_key}}' \
  -d '{
    "status": "canceled",
    "note": "Message about the cancellation."
}'

Python

import requests

url = "https://www.digicert.com/services/v2/order/certificate/{{order_id}}/status"

payload = "{\n    \"status\": \"canceled\",\n    \"note\": \"Message about the cancellation.\"\n}"
headers = {
    'X-DC-DEVKEY': "{{api_key}}",
    'Content-Type': "application/json"
    }

response = requests.request("PUT", url, data=payload, headers=headers)

print(response.text)

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://www.digicert.com/services/v2/order/certificate/{{order_id}}/status"

	payload := strings.NewReader("{\n    \"status\": \"canceled\",\n    \"note\": \"Message about the cancellation.\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("X-DC-DEVKEY", "{{api_key}}")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

NodeJS

var request = require("request");

var options = { method: 'PUT',
  url: 'https://www.digicert.com/services/v2/order/certificate/{{order_id}}/status',
  headers: 
   { 'Content-Type': 'application/json',
     'X-DC-DEVKEY': '{{api_key}}' },
  body: { status: 'canceled', note: 'Message about the cancellation.' },
  json: true };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

204 No Content

// empty

Request parameters

Name	Req/Opt	Type	Description
status	required	string	Updated status for the order. Allowed values (case sensitive): `canceled` `renewed` `not_renewed` Notes: To cancel a pending order, the order status must be `pending` or `waiting_pickup`. To mark a migrated certificate order as `renewed`, the certificate must be within 90 days of its expiration date or be expired. To mark a migrated certificate order as `not_renewed`, you must have first marked the order as `renewed`.
note	required*	string	Message about the cancellation or changing the status to `renewed` or `not_renewed`. *Note: Only required for order cancelations.

Example requests and response

Request parameters

案内