---
title: "Operation"
description: "Use this section to describe an operation available for a resource collection. The section structure consists of the following elements: Request — an HTTP method required to invoke the operation and define the resource endpoint."
canonical: "https://helpcenter.veeam.com/docs/styleguide/tw/rest_api_operation.html"
breadcrumb: "Style Guide > Structuring Content > Topic Types > Reference Topic > REST API Reference > Resource Сollection > Endpoints and Methods > Operation"
dateModified: "2026-09-03"
---

# Operation

Use this section to describe an operation available for a resource collection. The section structure consists of the following elements:

1. **Request** — an HTTP method required to invoke the operation and define the resource endpoint. 

   Provide an HTTP request, request headers and a request body for the HTTP method:

   1. <a id="httprequest"></a>**HTTP request** — the request URL.

      Even if the product REST API is served over HTTPS, you must still use the *HTTP Request* heading. HTTP Request is the official term used in REST API documentation. HTTPS (Hyper Text Transfer Protocol Secure) is just a secure version of HTTP.

   2. **Request headers** — a list of request headers required for the request.

      For each header, specify whether it is required or optional, define its possible values and provide a short description.

   3. **Request body** — parameters or properties that a user must send in the request body.

      Include this subsection to do either of the following:

      - List parameters required for the request. For each parameter, specify its type and provide a short description.
      - List properties required for the request. For each property, specify its type and provide a short description.

2. **Response** —  the expected response.

   Begin the subsection with the following generic introductory phrase: *The server returns the following response to the client*. Then, provide a response code and response body.

   1. **Response code** — the response code returned by a successfully completed operation.
   2. [Optional] **Response body** — a description of the output; applies only if the response body is not empty.

3. **Example** — an example of a user request and a server response.

::: dropdown
## Example

## Request

To disable a failover plan and return plan scheduling settings to default values, send the HTTP POST request to the URL of the [/]{.Code_Example}`FailoverPlans/{id}/DisableSchedule` resource.

### HTTP Request

```
POST https://<hostname>:<port>/v2/FailoverPlans/{id}/DisableSchedule
```

### Request Headers

The request header must contain an authorization token for the current logon session.

## Response

The server returns the following response to the client.

### Response Code

A successfully completed operation returns the response code *200* *Success*.

## Example

The following example disables a schedule created for a failover plan with the ID be0d799a-cd89-4fd5-b612-5973384a6704.

```
Request:
POST https://uwin2012r2.n.local:9899/v2/FailoverPlans/be0d799a-cd89-4fd5-b612-5973384a6704/DisableSchedule
Request Header:
Authorization: Bearer <Access-Token>
Response:
200 Success
Response Body:
no content
```

:::