REST Resource: projects.locations.cdnKeys

Resource: CdnKey

Configuration for a CDN key. Used by the Video Stitcher to sign URIs for fetching video manifests and signing media segments for playback.

JSON representation
{
  "name": string,
  "hostname": string,

  // Union field cdn_key_config can be only one of the following:
  "googleCdnKey": {
    object (GoogleCdnKey)
  },
  "akamaiCdnKey": {
    object (AkamaiCdnKey)
  },
  "mediaCdnKey": {
    object (MediaCdnKey)
  }
  // End of list of possible types for union field cdn_key_config.
}
Fields
name

string

The resource name of the CDN key, in the form of projects/{project}/locations/{location}/cdnKeys/{id}. The name is ignored when creating a CDN key.

hostname

string

The hostname this key applies to.

Union field cdn_key_config. Configuration associated with the CDN key. cdn_key_config can be only one of the following:
googleCdnKey

object (GoogleCdnKey)

The configuration for a Google Cloud CDN key.

akamaiCdnKey

object (AkamaiCdnKey)

The configuration for an Akamai CDN key.

mediaCdnKey

object (MediaCdnKey)

The configuration for a Media CDN key.

GoogleCdnKey

Configuration for a Google Cloud CDN key.

JSON representation
{
  "privateKey": string,
  "keyName": string
}
Fields
privateKey

string (bytes format)

Input only. Secret for this Google Cloud CDN key.

A base64-encoded string.

keyName

string

The public name of the Google Cloud CDN key.

AkamaiCdnKey

Configuration for an Akamai CDN key.

JSON representation
{
  "tokenKey": string
}
Fields
tokenKey

string (bytes format)

Input only. Token key for the Akamai CDN edge configuration.

A base64-encoded string.

MediaCdnKey

Configuration for a Media CDN key.

JSON representation
{
  "privateKey": string,
  "keyName": string,
  "tokenConfig": {
    object (TokenConfig)
  }
}
Fields
privateKey

string (bytes format)

Input only. 64-byte ed25519 private key for this Media CDN key.

A base64-encoded string.

keyName

string

The keyset name of the Media CDN key.

tokenConfig

object (TokenConfig)

Optional. If set, the URL will be signed using the Media CDN token. Otherwise, the URL would be signed using the standard Media CDN signature.

TokenConfig

Configuration for a Media CDN token.

JSON representation
{
  "queryParameter": string
}
Fields
queryParameter

string

Optional. The query parameter in which to find the token.

The name must be 1-64 characters long and match the regular expression [a-zA-Z]([a-zA-Z0-9_-])* which means the first character must be a letter, and all following characters must be a dash, underscore, letter or digit.

Defaults to edge-cache-token.

Methods

create

Creates a new CDN key.

delete

Deletes the specified CDN key.

get

Returns the specified CDN key.

list

Lists all CDN keys in the specified project and location.

patch

Updates the specified CDN key.