Help Center> API Gateway> API Reference> Dedicated Gateway APIs (V1) (To Be Deprecated)> Signature Key Management> Modifying a Signature Key
View PDF

Modifying a Signature Key

Function

This API is used to modify the information about a signature key.

URI

The following table lists the HTTP/HTTPS request method and URI of the API.

Table 1 HTTP/HTTPS request method and URI

Request Method

URI

PUT

/v1/{project_id}/apigw/instances/{instance_id}/signs/{id}

The following table lists the parameters in the URI.

Table 2 Parameter description

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID, which can be obtained by the administrator on the My Credentials page.

instance_id

Yes

String

Instance ID, which can be obtained from the dedicated gateway information on the API Gateway console.

id

Yes

String

Signature key ID

Request

Table 3 Parameter description

Parameter

Mandatory

Type

Description

name

Yes

String

Signature key name

The name of a signature key consists of 3–64 characters, starting with a letter. Only letters, digits, and underscores (_) are allowed.

sign_key

No

String

Signature key

A signature key consists of 8–32 characters, starting with a letter or digit. Only letters, digits, hyphens (-), and underscores (_) are allowed.

A key is automatically generated by the backend if no key is specified.

sign_secret

No

String

Signature secret

A signature secret consists of 16–64 characters, starting with a letter or digit. Only letters, digits, and special characters (-_!@#$%) are allowed.

A value is automatically generated by the backend if no value is specified.

Example request:

{
	"name": "signature01",
	"sign_key": "abcd_1234",
	"sign_secret": "******"
}

Response

Table 4 Parameter description

Parameter

Type

Description

id

String

Signature key ID

name

String

Signature key name

sign_key

String

Signature key

sign_secret

String

Signature secret

create_time

Timestamp

Time when the signature key is created

update_time

Timestamp

Time when the signature key was last updated

Example response:

{
  "name": "signature01",
  "sign_key": "abcd_123",
  "sign_secret": "******",
  "id": "3a793b65a9034bdfae08924f149bfb4a",
  "create_time": "2018-02-06T12:17:36.039953112Z",
  "update_time": "2018-02-06T12:17:36.039954198Z"
}

Status Codes

Table 5 Status codes

Status Code

Description

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Server Internal Error
Parent topic: Signature Key Management