---
uri: server.describe

description: |
  Retourne les attributs détaillés d’un serveur.

sampleuse: |
  zephir-client server.describe -s 1

pattern: rpc

public: true

domain: server-domain

parameters:
  serverid:
    type: Number
    ref: Server.ServerId
    description: Identifiant du serveur.
    shortarg: s
  configuration:
    type: Boolean
    description: Inclure les valeurs de configuration.
    default: false
  environment:
    type: Boolean
    description: Inclure les variables d'environement.
    default: false
  peering:
    type: Boolean
    description: Inclure la clé d'appairage.
    default: false

response:
  type: ServerDescribe
  description: Description du serveur.

errors:
  - uri: server.error.database-not-available
  - uri: server.error.db-connection
  - uri: server.error.invalid-server-id
  - uri: server.error.unknown-server-id

related:
  - server.list
  - server.create
  - server.update
  - server.delete