Method update

Written by

HTTP request
Path parameters
Body parameters
Response

Updates origin from origin group.

HTTP request

PATCH https://cdn.api.cloud.yandex.net/cdn/v1/origins/{originId}

Path parameters

Parameter	Description
originId	ID of the origin. Value must be greater than 0.

Body parameters

{
  "folderId": "string",
  "source": "string",
  "enabled": true,
  "backup": true,
  "meta": {

    // `meta` includes only one of the fields `common`, `bucket`, `website`, `balancer`
    "common": {
      "name": "string"
    },
    "bucket": {
      "name": "string"
    },
    "website": {
      "name": "string"
    },
    "balancer": {
      "id": "string"
    },
    // end of the list of possible fields`meta`

  }
}

Field	Description
folderId	string Required. ID of the folder that the origin belongs to. The maximum string length in characters is 50.
source	string IP address or Domain name of your origin and the port (if custom). Used if meta variant is `common`. Required.
enabled	boolean (boolean) The setting allows to enable or disable an Origin source in the Origins group. It has two possible values: True - The origin is enabled and used as a source for the CDN. An origins group must contain at least one enabled origin. Default value. False - The origin is disabled and the CDN is not using it to pull content. Required.
backup	boolean (boolean) Specifies whether the origin is used in its origin group as backup. A backup origin is used when one of active origins becomes unavailable. Required.
meta	object Set up type of the origin. Origin type. For details about the concept, see documentation.
meta. common	object A Yandex Object Storage bucket configured as a static site hosting. `meta` includes only one of the fields `common`, `bucket`, `website`, `balancer` Origin info. For details about the concept, see documentation.
meta. common. name	string Name of the origin.
meta. bucket	object A server with a domain name linked to it `meta` includes only one of the fields `common`, `bucket`, `website`, `balancer` Origin info. For details about the concept, see documentation.
meta. bucket. name	string Name of the origin.
meta. website	object A Yandex Object Storage bucket not configured as a static site hosting. `meta` includes only one of the fields `common`, `bucket`, `website`, `balancer` Origin info. For details about the concept, see documentation.
meta. website. name	string Name of the origin.
meta. balancer	object An L7 load balancer from Yandex Application Load Balancer. CDN servers will access the load balancer at one of its IP addresses that must be selected in the origin settings. `meta` includes only one of the fields `common`, `bucket`, `website`, `balancer` Yandex Application Load Balancer origin info. For details about the concept, see documentation.
meta. balancer. id	string ID of the origin.

Response

HTTP Code: 200 - OK

{
  "id": "string",
  "description": "string",
  "createdAt": "string",
  "createdBy": "string",
  "modifiedAt": "string",
  "done": true,
  "metadata": "object",

  //  includes only one of the fields `error`, `response`
  "error": {
    "code": "integer",
    "message": "string",
    "details": [
      "object"
    ]
  },
  "response": "object",
  // end of the list of possible fields

}

An Operation resource. For more information, see Operation.

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
createdAt	string (date-time) Creation timestamp. String in RFC3339 text format.
createdBy	string ID of the user or service account who initiated the operation.
modifiedAt	string (date-time) The time when the Operation resource was last modified. String in RFC3339 text format.
done	boolean (boolean) If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
metadata	object Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
error	object The error result of the operation in case of failure or cancellation. includes only one of the fields `error`, `response` The error result of the operation in case of failure or cancellation.
error. code	integer (int32) Error code. An enum value of google.rpc.Code.
error. message	string An error message.
error. details[]	object A list of messages that carry the error details.
response	object includes only one of the fields `error`, `response` The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is the standard Create/Update, the response should be the target resource of the operation. Any method that returns a long-running operation should document the response type, if any.

Method update

HTTP request

Path parameters

Body parameters

Response

Was the article helpful?