> ## Documentation Index
> Fetch the complete documentation index at: https://flashrdp.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Task



## OpenAPI

````yaml /api/control-panel/server-tasks.json get /server/{serverId}/task/{taskId}
openapi: 3.0.1
info:
  title: API Documentation
  description: >-
    ## Overview


    This API allows you to manage your account and servers programmatically.
    Account management features are available to all authenticated users, while
    server management operations are restricted to server owners. Only users who
    own a server can perform actions such as creating, or managing through the
    API.


    ### Authentication


    The API uses **Bearer Token authorization** for all authenticated requests.


    To access protected endpoints, include your API token in the `Authorization`
    header of each request:


    ```

    Authorization: Bearer <your_api_token>

    ```


    If the token is missing, invalid, or expired, the API will respond with:

    ```

    HTTP 401 Unauthorized

    ```


    Tokens are issued through your account and must be kept secure.


    ### Data Format


    The API uses **JSON** for all requests and responses. All requests should be
    sent with the following headers:


    ```

    Content-Type: application/json

    Accept: application/json

    ```


    ### Rate Limiting


    The API is rate limited to prevent excessive requests and ensure fair usage.
    Limits may be increased on request. Each response includes rate limit
    headers that indicate your current usage:

    | Header | Description |

    | ------- | ------------ |

    | **X-RateLimit-Limit** | The total number of requests allowed per minute. |

    | **X-RateLimit-Remaining** | The number of requests remaining in the
    current time window. |

    | **X-RateLimit-Reset** | The time when the limit will be reset. |


    When the limit is reached, the API will respond with the following status
    until the limit resets:


    ```

    HTTP 429 Too Many Requests

    ```


    ### Service Availability


    If the API is temporarily unavailable or undergoing maintenance, it will
    return the following status:


    ```

    HTTP 503 Service Unavailable

    ```


    This status indicates a temporary outage and the request should be retried
    later once the service is restored.
  version: 1.0.0
servers:
  - url: https://servers.flashrdp.com/api
security: []
tags:
  - name: Server/Tasks
paths:
  /server/{serverId}/task/{taskId}:
    get:
      tags:
        - Server/Tasks
      summary: Task
      parameters:
        - name: serverId
          in: path
          description: ''
          required: true
          schema:
            type: string
        - name: taskId
          in: path
          description: The ID of a task.
          required: true
          example: '2976'
          schema:
            type: string
        - name: Accept
          in: header
          description: ''
          required: true
          example: application/json
          schema:
            type: string
            enum:
              - application/json
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      action:
                        type: string
                      started:
                        type: string
                      updated:
                        type: string
                      finished:
                        type: string
                      completed:
                        type: boolean
                      status:
                        type: string
                      success:
                        type: boolean
              example:
                data:
                  action: restart_server
                  started: '2025-10-10T20:04:55+00:00'
                  updated: '2025-10-10T20:04:55+00:00'
                  finished: '2025-10-10T20:04:55+00:00'
                  completed: true
                  status: complete
                  success: true
          headers: {}
        '401':
          $ref: '#/components/responses/Unauthorized'
          description: ''
        '404':
          $ref: '#/components/responses/NotFound'
          description: ''
        '429':
          $ref: '#/components/responses/TooManyRequests'
          description: ''
      deprecated: false
      security:
        - bearer: []
components:
  responses:
    Unauthorized:
      description: ''
      content: {}
    NotFound:
      description: ''
      content:
        application/json:
          schema:
            type: object
            properties:
              errors:
                type: array
                items:
                  type: string
          examples:
            Example 1:
              summary: Example 1
              value:
                errors:
                  - This is an error returned from the API
                  - This is another error return from the API
    TooManyRequests:
      description: ''
      content: {}
  securitySchemes:
    bearer:
      type: http
      scheme: bearer

````