Get Available Protocols - BETA

This endpoint is currently available as a BETA. Business-critical processes should not depend on this functionality.

Lists the available protocols that you may assign to an origin entry.

Use the cdn.origins scope to authenticate and authorize requests for the Origins API.

Request

A request to retrieve a list of protocols is described below.

HTTP Method Request URI

GET

https://api.vdms.io/cdn/origins/v0.5/protocol-types

Request Headers

This endpoint only takes advantage of common request headers.

Request Body

Request body parameters are not required by this endpoint.

Response

The response to the above request includes an HTTP status code, response headers, and a response body.

Status Code

A status code indicates whether the request was successfully performed.

Response Headers

The response for this endpoint only includes standard HTTP response headers.

View common response headers.

Response Body

The response body for a successful request returns the following object for each protocol: 

Name Data Type Description

id

Integer

Indicates the protocol's system-defined ID.

name

String

Identifies a protocol by name.

Errors

The response body for an unsuccessful request may contain an error element that provides additional information.

View common error messages.

Sample Request and Response (JSON)

A sample JSON request is shown below.

A sample JSON response is shown below.

HTTP/1.1 200 OK

Cache-Control: private

Content-Type: application/json; charset=utf-8

Date: Thu, 15 Apr 2021 12:00:00 GMT

Content-Length: 132

[{
		"id": 1,
		"name": "HTTP Only"
	}, {
		"id": 2,
		"name": "HTTPS Only"
	}, {
		"id": 3,
		"name": "Match Client"
	}
]