Commit e10c743b authored by Daniel Dehennin's avatar Daniel Dehennin
Browse files

Import API v1

parent cb2ae6a8
---
uri: vault.secret.set
description: |
Enregistre un secret.
sampleuse: |
zephir-client vault.secret.set '{"secretkey":"MySecretKey", "secret": {"passphrase":"MySecret"}}'
pattern: rpc
public: false
domain: vault-domain
parameters:
secretkey:
type: String
ref: Vault.SecretKey
description: |
Nom du secret.
secret:
type: Dict
ref: Vault.Secret
description: |
Contenu du secret.
response:
type: Boolean
description: Status.
errors:
- uri: vault.error.secret-not-available
---
uri: zephir.services.available
sampleuse: ~
description: |
Demander a un ou des services si est présent
pattern: event
parameters:
name:
type: String
description: Nom du service
default: null
public: false
domain: zephir-domain
---
uri: zephir.services.event
sampleuse: ~
description: |
Événement sur les services (démarrage/arrêt/...)
pattern: event
parameters:
name:
type: String
description: Nom du service
ip:
type: String
description: Adresse IP du service
status:
type: String
description: |
État du service
public: false
domain: zephir-domain
---
uri: zone.site.create
description: |
Creates a site
sampleuse: |
zephir-client zone.site.create '{"sitename":"MyBeautifulSite", "sitedescription": "site description", "parentsiteid":1}'
pattern: rpc
public: true
domain: zone-domain
parameters:
sitename:
type: String
description: |
Site name
sitedescription:
type: String
description: |
Site description
parentsiteid:
ref: Zone.SiteId
type: Number
description: |
Parent site identifier
default: null
response:
type: '[]ZoneSite'
description: Informations sur le site créé.
errors:
- uri: zone.site.error.database-not-available
- uri: zone.site.error.db-connection
- uri: zone.site.error.invalid-site-id
- uri: zone.site.error.unknown-site-id
- uri: zone.site.error.sitename-not-provided
related:
- zone.site.list
- zone.site.describe
- zone.site.update
- zone.site.delete
---
uri: zone.site.delete
description: |
Demande la suppression d'un site
sampleuse: |
zephir-client zone.site.delete '{"parameters":{"siteid":1}}'
pattern: rpc
public: true
domain: zone-domain
parameters:
siteid:
type: Number
description: |
Identifiant du site à supprimer
response:
type: Number
description: ID du site supprimé.
errors:
- uri: zone.site.delete.error.database_not_available
- uri: zone.site.delete.error.invalid_site_id
- uri: zone.site.delete.error.unknown_site_id
- uri: zone.site.delete.error.dependency_lock
related:
- zone.site.list
- zone.site.describe
- zone.site.create
- zone.site.update
- zone.site.event
---
uri: zone.site.describe
description: |
Retourne les attributs détaillées d'un site.
sampleuse: |
zephir-client zone.site.describe '{"kwargs":{"site":1}}'
pattern: rpc
public: true
domain: zone-domain
parameters:
siteid:
type: Number
description: |
Identifiant du site à récupérer.
response:
type: ZoneSite
description: Site avec ses attributs détaillés.
errors:
- uri: zone.site.describe.error.database_not_available
- uri: zone.site.describe.error.invalid_site_id
- uri: zone.site.describe.error.unknown_site_id
related:
- zone.site.list
- zone.site.create
- zone.site.update
- zone.site.delete
- zone.site.event
---
uri: zone.site.list
description: |
Retourne la liste des sites disponibles.
sampleuse: |
zephir-client -d'{}' zone.site.list
pattern: rpc
public: true
domain: zone-domain
response:
type: '[]ZoneSite'
description: Liste des sites disponibles.
errors:
- uri: zone.site.list.error.database_not_available
related:
- zone.site.describe
- zone.site.create
- zone.site.update
- zone.site.delete
- zone.site.event
---
title: ConfigConfiguration
type: object
description: Description de la configuration.
properties:
configuration:
type: File
description: Détail de la configuration au format JSON.
required:
- configuration
---
title: ConfigSession
type: object
description: Description de la session.
properties:
sessionid:
type: string
description: ID de la session.
ref: Config.SessionId
id:
type: number
description: ID de la configuration.
ref: Server.ServerId
username:
type: string
description: Nom de l'utilisateur.
timestamp:
type: number
description: Moment d’ouverture de la session.
required:
- sessionid
- id
- username
- timestamp
---
title: SaltExec
type: object
description: Description du job exécuté dans Salt.
properties:
jid:
type: string
description: ID de la tâche Salt.
ref: Server.JobId
minions:
type: array
items:
type: string
description: Minions devant exécuter la tâche.
required:
- jid
- servers_id
---
title: SaltJob
type: object
description: Description d'un job Salt exécuté précédement.
properties:
jid:
type: string
ref: Server.JobId
description: Identifiant de la tâche.
executed:
type: boolean
description: La tâche a été exécutée.
command:
type: string
description: Nom de la fonction.
arg:
type: string
description: Commande exécuté.
minion:
type: string
description: Identifiant du minion.
success:
type: boolean
description: Commande exécuté avec succès.
retcode:
type: number
description: Code de retour de la commande.
return:
type: string
description: Retour de la commande.
required:
- jid
- executed
- fun
- minion
---
title: IdentitySession
type: object
description: Informations sur l'identité de l'utilisateur.
properties:
username:
type: string
description: Nom de l'utilisateur.
required:
- username
---
title: ServerDescribe
type: object
description: Description du serveur.
properties:
serverid:
type: number
description: Identifiant du serveur.
ref: Server.ServerId
servername:
type: string
description: Nom du serveur.
serverdescription:
type: string
description: Description du serveur.
servermodelid:
type: number
description: Identifiant du modèle de serveur.
ref: Servermodel.ServermodelId
zoneid:
type: number
description: Identifiant de la zone.
ref: Zone.ZoneId
machineid:
type: number
description: Identifiant de la machine.
ref: Zone.MachineId
configuration:
type: file
description: Valeurs de configuration.
serverenvironment:
type: object
description: Variables d'environnement du serveur.
lastpeerconnection:
type: string
description: Timestamp de la dernière connexion avec le serveur.
required:
- serverid
- servername
- serverdescription
- servermodelid
---
title: ServerExec
type: object
description: Retour de l'exécution.
properties:
job_id:
type: string
description: Identifiant de la tâche.
ref: Server.JobId
server_id:
type: number
description: Identifiant du serveur.
ref: Server.ServerId
command:
type: string
description: Commande demandée.
automation:
type: string
description: Moteur d'exécution.
ref: Server.automation
executed:
type: boolean
description: La tâche a été exécutée.
success:
type: boolean
description: Commande exécuté avec succès.
retcode:
type: number
description: Code de retour de la commande.
return:
type: string
description: Retour de la commande.
required:
- command
- automation
- job_id
- server_id
- executed
---
title: ServerJob
type: object
description: Description d'une tâche exécutée précédement.
properties:
job_id:
type: string
ref: Server.JobId
description: Identifiant de la tâche.
command:
type: string
description: Commande exécuté.
automation:
type: string
description: Moteur d'exécution.
ref: Server.automation
executed:
type: boolean
description: La tâche a été exécutée.
success:
type: boolean
description: Etat de la commande.
required:
- job_id
- command
- automation
- executed
- success
---
title: ServerPeeringConf
type: object
description: Configuration d'appairage.
properties:
serverid:
type: number
ref: Server.ServerId
description: ID du serveur.
pub_key:
type: string
description: Clé publique du client.
ciphered_priv_key:
type: string
description: Clé privée du client.
client_configuration:
type: string
description: Élément de configuration du client.
required:
- serverid
- pub_key
- ciphered_priv_key
- client_configuration
---
title: Server
type: object
description: Description du serveur.
properties:
serverid:
type: number
description: Identifiant du serveur.
ref: Server.ServerId
servername:
type: string
description: Nom du serveur.
serverdescription:
type: string
description: Description du serveur.
servermodelid:
type: number
description: Identifiant du modèle de serveur.
ref: Servermodel.ServermodelId
zoneid:
type: number
description: Identifiant de la zone.
ref: Zone.ZoneId
machineid:
type: number
description: Identifiant de la machine.
ref: Zone.MachineId
automation:
type: string
description: Moteur d'exécution.
ref: Server.automation
lastpeerconnection:
type: string
description: Timestamp de la dernière connexion avec le serveur.
required:
- serverid
- servername
- serverdescription
- servermodelid
---
title: ServermodelDescribe
type: object
description: Description du modèle de serveur.
properties:
model:
type: object
description: Modèle de serveur avec ses attributs détaillés.
services:
type: array
items:
type: object
description: Liste des services applicatifs déclarés pour ce modèle de serveur.
schema:
type: File
description: Contenu du schema.
probes:
type: File
description: Informations sur les sondes.
required:
- model
- services
---
title: ServermodelSource
type: object
description: Description de la source.
properties:
sourceid:
type: number
description: ID de la source.
sourcename:
type: string
description: Nom de la source.
sourceurl:
type: string
description: URL de la source.
required:
- sourceid
- sourcename
- sourceurl
---
title: ServermodelVersion
type: object
description: Description de la configuration.
properties:
subreleaseid:
type: number
description: ID de la sous-version.
subreleasename:
type: string
description: Nom de la sous-version.
versionname:
type: string
description: Nom de la version.
versiondistribution:
type: string
description: Nom de la distribution.
required:
- subreleaseid
- subreleasename
- versionname
- versiondistribution
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment