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

# Get all usage graphs

> ### Overview

Returns CPU, memory, disk and network graphs. `period` accepts `hour`, `day`, `week`, `month` or `year` and defaults to `hour`. `aggregation` accepts `average` or `maximum` and defaults to `average`. Use `maximum` to see short usage spikes. Missing readings return 200 with an `unavailable` message and empty series. A stopped server may also have empty series.

### Permissions

Requires the `server.read` (View servers) permission for the selected team. Resources outside that team return 404.



## OpenAPI

````yaml https://console.advinservers.com/docs/openapi.json get /servers/{server}/metrics
openapi: 3.1.0
info:
  title: API reference
  version: 1.0.0
  description: >-
    Use this API to manage your team's servers, networks, backups, and other
    resources.


    ## Authentication


    Create an API key under **API Keys** and send it as a bearer token with
    every request:


    ```

    Authorization: Bearer {YOUR_API_KEY}

    Accept: application/json

    ```


    Copy the key when you create it. It cannot be shown again. Revoking a key
    takes effect immediately.


    ## Permissions


    Give each key only the permissions it needs. Every endpoint lists the
    required permission.


    Permissions cover servers and other resources in the key's team.


    ## Team scope


    A key can access resources in the team selected when it was created. This
    includes servers,

    snapshots, backups, firewall groups, images, SSH keys, scripts, networks and
    addresses.

    Resources in other teams return `404 Not Found`. Create a separate key for
    each team.


    The key determines the team for every request. Legacy keys that had no team
    are assigned

    to the account's first owned team.


    ## Actions that need the panel


    API keys cannot do the following, even with every permission. Sign in to the
    panel in a

    browser to do them:


    - Create, edit or revoke API keys

    - Edit the IP groups that restrict API keys

    - End signed-in sessions

    - Change two-factor authentication

    - Change the account's email address

    - Accept or decline team invitations

    - Switch or leave a team


    This keeps a leaked key from widening its own access or locking you out of
    your account.


    ## Source IP restrictions


    A key can be restricted to one or more IP groups. Requests from other
    addresses are rejected.


    ## Requests and responses


    Each endpoint lists its path, query, header, and body parameters. Examples
    use fictional data.


    Single records use JSON objects. Collections use JSON arrays unless the
    endpoint supports pagination. Timestamps use ISO 8601 in UTC.


    Error responses include `message`. Validation errors also include an
    `errors` object for each field. Each endpoint lists its status codes.


    ## Audit log


    Every API request, including reads, is recorded in the account audit log
    with the key that made it.
servers:
  - url: https://console.advinservers.com/api/v1/client
security:
  - http: []
tags:
  - name: Account
    description: Billing contact details and account setup progress.
  - name: Account activity
    description: Actions performed in the current team by people and API keys.
  - name: Servers
    description: >-
      Order and list servers, read their state and resource use, open a console,
      and control power.
  - name: Server settings
    description: >-
      Rename a server, rebuild it, and change its hardware, media, resolvers and
      credentials.
  - name: Backups
    description: Scheduled server copies stored separately from the server.
  - name: Snapshots
    description: >-
      Take, restore and move server snapshots. Snapshots are kept in snapshot
      storage that the team buys by the GiB.
  - name: Firewall groups
    description: Reusable sets of firewall rules, and the servers they apply to.
  - name: IP groups
    description: Reusable source address lists for firewall rules.
  - name: Server firewall
    description: >-
      Read default traffic policies and rules managed outside your firewall
      groups.
  - name: IP addresses
    description: Manage floating IPs and server address assignments.
  - name: Private networks
    description: Connect servers over a private network in the same location.
  - name: Reverse DNS
    description: Set the hostnames returned by IP address lookups.
  - name: DDoS protection
    description: Configure attack filtering for server addresses.
  - name: Bandwidth
    description: Buy extra bandwidth and share it between servers or location pools.
  - name: SSH keys
    description: Public keys the account can install on a server when it is built.
  - name: Setup scripts
    description: Scripts the account can run on a server when it is built.
  - name: ISO images
    description: ISO images you have downloaded, and the servers they are mounted on.
  - name: Server upgrades
    description: Change an existing server's plan.
  - name: Checkout
    description: Choose a payment method and pay for a purchase.
  - name: Invoices
    description: View and pay account invoices.
  - name: Billing
    description: Manage service renewals, payment methods and account credit.
  - name: Transfers
    description: Move resources between teams or transfer ownership.
  - name: Teams
    description: Manage the team assigned to your API key.
  - name: Team members
    description: Invite people and manage their team access.
  - name: Team roles
    description: Define the permissions granted to team members.
  - name: Team activity
    description: View actions performed in a team.
  - name: Support tickets
    description: >-
      Open, read, reply to and close support tickets. Tickets belong to the
      account holder and are not shared with team members.
paths:
  /servers/{server}/metrics:
    get:
      tags:
        - Servers
      summary: Get all usage graphs
      description: >-
        ### Overview


        Returns CPU, memory, disk and network graphs. `period` accepts `hour`,
        `day`, `week`, `month` or `year` and defaults to `hour`. `aggregation`
        accepts `average` or `maximum` and defaults to `average`. Use `maximum`
        to see short usage spikes. Missing readings return 200 with an
        `unavailable` message and empty series. A stopped server may also have
        empty series.


        ### Permissions


        Requires the `server.read` (View servers) permission for the selected
        team. Resources outside that team return 404.
      operationId: client.servers.metrics
      parameters:
        - name: server
          in: path
          required: true
          description: The server UUID
          schema:
            type: string
            examples:
              - ecc6f4f1
          example: ecc6f4f1
        - name: period
          in: query
          description: The value of `period`.
          schema:
            anyOf:
              - $ref: '#/components/schemas/MetricTimeframe'
                examples:
                  - day
              - type: 'null'
          example: day
        - name: aggregation
          in: query
          description: The value of `aggregation`.
          schema:
            anyOf:
              - $ref: '#/components/schemas/MetricAggregation'
                examples:
                  - maximum
              - type: 'null'
          example: maximum
      responses:
        '200':
          description: The record, as a JSON object. There is no envelope.
          content:
            application/json:
              schema:
                examples:
                  - period: hour
                    aggregation: average
                    unavailable: null
                    series:
                      cpu:
                        - time: 1789403880
                          cpu: 0.25
                        - time: 1789403940
                          cpu: 0.31
                        - time: 1789404000
                          cpu: 0.22
                      mem:
                        - time: 1789403880
                          mem: 2147483648
                        - time: 1789403940
                          mem: 2181038080
                        - time: 1789404000
                          mem: 2164260864
                      disk:
                        - time: 1789403880
                          diskread: 24576
                          diskwrite: 186368
                        - time: 1789403940
                          diskread: 8192
                          diskwrite: 241664
                        - time: 1789404000
                          diskread: 16384
                          diskwrite: 163840
                      net:
                        - time: 1789403880
                          netin: 412876
                          netout: 1893120
                        - time: 1789403940
                          netin: 398212
                          netout: 2011648
                        - time: 1789404000
                          netin: 455190
                          netout: 1768448
                allOf:
                  - $ref: '#/components/schemas/ServerMetricsData'
        '401':
          description: >-
            The key was missing, malformed, revoked, or belongs to an account
            that no longer exists.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    examples:
                      - Unauthenticated.
                required:
                  - message
        '403':
          description: >-
            Access denied. Check the key's team, permissions and allowed IP
            addresses. Some actions, such as managing API keys, require a
            browser session. The response message explains the reason.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    examples:
                      - >-
                        This API key is not allowed to do that in this team. It
                        needs the "snapshot.delete" permission.
                required:
                  - message
        '404':
          description: >-
            The resource was not found in the selected team. Resources in
            another account or team also return 404.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    examples:
                      - Not found.
                required:
                  - message
        '422':
          description: The requested period or aggregation is invalid.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    examples:
                      - The request could not be carried out.
                required:
                  - message
        '429':
          description: >-
            Too many requests. The `Retry-After` header says how many seconds to
            wait. Limits are per account, so several keys on one account share
            them.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    examples:
                      - Too Many Attempts.
                required:
                  - message
components:
  schemas:
    MetricTimeframe:
      type: string
      enum:
        - hour
        - day
        - week
        - month
        - year
      title: MetricTimeframe
    MetricAggregation:
      type: string
      enum:
        - average
        - maximum
      title: MetricAggregation
    ServerMetricsData:
      type: object
      description: >-
        A server's resource history over one window: what was asked for, and
        what came back.
      examples:
        - period: hour
          aggregation: average
          unavailable: null
          series:
            cpu:
              - time: 1789403880
                cpu: 0.25
              - time: 1789403940
                cpu: 0.31
              - time: 1789404000
                cpu: 0.22
            mem:
              - time: 1789403880
                mem: 2147483648
              - time: 1789403940
                mem: 2181038080
              - time: 1789404000
                mem: 2164260864
            disk:
              - time: 1789403880
                diskread: 24576
                diskwrite: 186368
              - time: 1789403940
                diskread: 8192
                diskwrite: 241664
              - time: 1789404000
                diskread: 16384
                diskwrite: 163840
            net:
              - time: 1789403880
                netin: 412876
                netout: 1893120
              - time: 1789403940
                netin: 398212
                netout: 2011648
              - time: 1789404000
                netin: 455190
                netout: 1768448
      properties:
        period:
          type: string
          description: The window the series cover, counted back from now.
          enum:
            - hour
            - day
            - week
            - month
            - year
          examples:
            - hour
        aggregation:
          type: string
          description: How the samples inside each bucket of the series were consolidated.
          enum:
            - average
            - maximum
          examples:
            - average
        unavailable:
          type:
            - string
            - 'null'
          description: >-
            Null when the series below were read, and a sentence saying so when
            they could not be.
          examples:
            - null
        series:
          $ref: '#/components/schemas/ServerMetricSeriesData'
          description: The value of `series`.
          examples:
            - cpu:
                - time: 1789403880
                  cpu: 0.25
                - time: 1789403940
                  cpu: 0.31
                - time: 1789404000
                  cpu: 0.22
              mem:
                - time: 1789403880
                  mem: 2147483648
                - time: 1789403940
                  mem: 2181038080
                - time: 1789404000
                  mem: 2164260864
              disk:
                - time: 1789403880
                  diskread: 24576
                  diskwrite: 186368
                - time: 1789403940
                  diskread: 8192
                  diskwrite: 241664
                - time: 1789404000
                  diskread: 16384
                  diskwrite: 163840
              net:
                - time: 1789403880
                  netin: 412876
                  netout: 1893120
                - time: 1789403940
                  netin: 398212
                  netout: 2011648
                - time: 1789404000
                  netin: 455190
                  netout: 1768448
      required:
        - period
        - aggregation
        - unavailable
        - series
      title: ServerMetricsData
    ServerMetricSeriesData:
      type: object
      description: The four resource graphs a server draws, as one object.
      examples:
        - cpu:
            - time: 1789403880
              cpu: 0.25
            - time: 1789403940
              cpu: 0.31
            - time: 1789404000
              cpu: 0.22
          mem:
            - time: 1789403880
              mem: 2147483648
            - time: 1789403940
              mem: 2181038080
            - time: 1789404000
              mem: 2164260864
          disk:
            - time: 1789403880
              diskread: 24576
              diskwrite: 186368
            - time: 1789403940
              diskread: 8192
              diskwrite: 241664
            - time: 1789404000
              diskread: 16384
              diskwrite: 163840
          net:
            - time: 1789403880
              netin: 412876
              netout: 1893120
            - time: 1789403940
              netin: 398212
              netout: 2011648
            - time: 1789404000
              netin: 455190
              netout: 1768448
      properties:
        cpu:
          type: array
          description: The value of `cpu`.
          examples:
            - - time: 1789403880
                cpu: 0.25
              - time: 1789403940
                cpu: 0.31
              - time: 1789404000
                cpu: 0.22
          items:
            anyOf:
              - type: object
                additionalProperties:
                  type: number
              - type: array
                items: {}
                maxItems: 0
        mem:
          type: array
          description: The value of `mem`.
          examples:
            - - time: 1789403880
                mem: 2147483648
              - time: 1789403940
                mem: 2181038080
              - time: 1789404000
                mem: 2164260864
          items:
            anyOf:
              - type: object
                additionalProperties:
                  type: number
              - type: array
                items: {}
                maxItems: 0
        disk:
          type: array
          description: The value of `disk`.
          examples:
            - - time: 1789403880
                diskread: 24576
                diskwrite: 186368
              - time: 1789403940
                diskread: 8192
                diskwrite: 241664
              - time: 1789404000
                diskread: 16384
                diskwrite: 163840
          items:
            anyOf:
              - type: object
                additionalProperties:
                  type: number
              - type: array
                items: {}
                maxItems: 0
        net:
          type: array
          description: The value of `net`.
          examples:
            - - time: 1789403880
                netin: 412876
                netout: 1893120
              - time: 1789403940
                netin: 398212
                netout: 2011648
              - time: 1789404000
                netin: 455190
                netout: 1768448
          items:
            anyOf:
              - type: object
                additionalProperties:
                  type: number
              - type: array
                items: {}
                maxItems: 0
      required:
        - cpu
        - mem
        - disk
        - net
      title: ServerMetricSeriesData
  securitySchemes:
    http:
      type: http
      description: >-
        Your API key, sent as a bearer token. Create one in the control panel
        under API Keys, give it only the permissions the integration needs, and
        copy it when it is created. It cannot be shown again. Each key is
        restricted to one owned team. The key determines the team for every
        request.
      scheme: bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.