Ga naar inhoud

Sites

OAuth-scopes: reads vereisen sites:read, writes vereisen sites:write. Twee uitzonderingen:

  • De endpoints voor back-up-export vereisen sites:write, inclusief het uitlezen van de status.
  • De metrics-endpoints zijn POSTs maar vereisen alleen sites:read. Ze vereisen ook bewerkrechten op de site; een alleen-lezen samenwerker krijgt 403 {"errors":["Not Authorized"]}.

Site-statussen die bepalen wat de endpoints teruggeven:

  • Dunning-suspended: show-, update-, delete- en tool-endpoints geven 402 service_suspended terug. List-endpoints tonen in plaats daarvan dunning_suspended: true. Het invoice-object bevat number en hosted_url; hosted_url is null zolang er een betaling wordt verwerkt.
  • Server in onderhoud of offline: acties die de server nodig hebben geven 409 node_maintenance of node_offline terug. Zie Node-status.
  • In verwijdering: een verwijderde site die wacht op definitief wissen geeft 403 pending_delete terug op update, delete en elk genest site-endpoint, reads inbegrepen. Hij verschijnt nog steeds in listresultaten en op GET /api/sites/:id. Zie Een site verwijderen.

Gerelateerde site-tooling staat op eigen pagina's: CDN, cache & logs en Shield.

Sites opvragen

Als je de account-ID-header in deze API-aanroep weglaat, worden alle sites teruggegeven die beschikbaar zijn voor je gebruiker. Als je de account-ID-header wel meegeeft, worden alleen sites voor dit account teruggegeven.

GET /api/sites

Verwijderde sites staan hier nog steeds tussen

Een verwijderde site blijft in deze lijst staan met pending_delete: true totdat hij definitief wordt gewist. Filter op pending_delete om alleen actieve sites te tonen.

Teruggegeven params
  • sites: Array
    • id: String
    • name: String
    • primary_domain: String
    • location: String (geografische regio)
    • account: Object
      • id: String
      • name: String
    • package: String
    • dunning_suspended: Boolean
    • pending_delete: Boolean | true zolang de site wacht op definitief wissen
    • delete_scheduled_at: DateTime | wisdatum; null voor actieve sites
    • node_status: Object | de status van de regio van de site. Site bekijken geeft de waarde per site. Zie Node-status
    • created_at
    • updated_at

Site bekijken

GET /api/sites/:id

Een site die in verwijdering staat lost hier nog steeds op (geen 404) maar geeft een beperkte payload terug (het tweede blok hieronder).

Teruggegeven params
  • site: Object
    • id: String
    • name: String
    • primary_domain: String
    • location: String (geografische regio)
    • region: String (Availability Zone)
    • package: String
    • pending_delete: Boolean | hier false
    • php_version: String
    • domain_cname: String
    • sftp_base_path: String
    • dunning_suspended: Boolean | op dit endpoint altijd false — een geblokkeerde site geeft in plaats daarvan 402 terug
    • node_status: Object | de live status van de servers waarop deze site draait. Ontbreekt bij een site in verwijdering. Zie Node-status
    • ssh: Object | leeg ({}) tenzij ssh_status available is
      • ipaddr: String
      • username: String
      • password: String
      • port: Integer
    • ssh_status: String | available, unavailable (tijdelijk — probeer opnieuw) of none (geen SSH/SFTP-toegang)
    • domains: Array
      • Zie het domains-API-endpoint
    • subscription: Object
    • id: String
    • status: String
    • created_at: DateTime
    • updated_at: DateTime
    • price: Object
      • amount_cents: Integer
      • term: String
    • run_rate: Object | de terugkerende kosten van het abonnement, geserialiseerd als een money-object met een cents-sleutel (Integer) en een currency_iso-sleutel (String) uit het facturatieplan van het account. Het is geen kale integer
    • sites: Array | elke site op dit abonnement, elk een volledig site-samenvattingsobject (dezelfde vorm als een item in Sites opvragen, zonder node_status) — inclusief de site die je hebt opgevraagd. Bij een gedeeld abonnement wordt dit een grote geneste payload
    • product: Object
      • id: String
      • name: String
    • account: Object
      • id: String
      • name: String
    • created_at
    • updated_at
Teruggegeven params (site in verwijdering)

De response bevat alleen identiteit plus verwijderstatus. region, php_version, domain_cname, sftp_base_path, dunning_suspended, node_status, ssh, ssh_status, domains en subscription worden weggelaten.

  • site: Object
    • id: String
    • name: String
    • primary_domain: String
    • location: String (geografische regio)
    • package: String
    • pending_delete: Boolean | true
    • status: String | "pending_delete" (dit veld ontbreekt bij actieve sites)
    • delete_scheduled_at: DateTime | wanneer de site definitief wordt gewist
    • account: Object
      • id: String
      • name: String
    • created_at
    • updated_at

Node-status en geweigerde acties

node_status geeft aan of de servers achter een site gezond zijn. Het object heeft dezelfde vorm in een GET-response en in een 409-weigering.

node_status-object
  • state: String | online, maintenance of offline
  • since: DateTime | wanneer de status inging; null als dat niet bekend is
  • planned: Boolean | true bij gepland onderhoud
  • message: String | bericht van de operator in platte tekst, of null. Escape de tekst voordat je hem weergeeft
  • operations: Object | per actie, wat er in deze status gebeurt. power: available, deferred of refused. backup, restore, export, scale en bastion_password_reset: available of refused. config_changes: available of deferred

Zolang de server van een site in onderhoud is of offline staat, geven de onderstaande endpoints 409 met code node_maintenance of node_offline: {"errors": ["..."], "code": "node_maintenance", "node_status": {...}}. Er is niets gewijzigd; probeer opnieuw zodra node_status.state online is.

Verandert de status nadat een verzoek is geaccepteerd (202), dan eindigt de task als CANCELLED met de reden.


Site bijwerken / resizen

PATCH /api/sites/:id

Verwerkt twee bedoelingen:

  1. Hernoemen (synchroon) — geef name mee. Geeft 202 terug met een lege body.
  2. Planwijziging (cart-gemedieerd, asynchroon) — geef plan mee (een Product short_name). De reactie is de gedeelde cart-envelop (zie Orders / Carts) — poll de cart op voltooiing. Er wordt geen task_id teruggegeven. Vereist een single-site-account en, voor een workspace die met een kaart betaalt, een standaard betaalmethode in het bestand; de facturatietermijn blijft behouden. payment en billing in het antwoord geven aan hoe de wijziging wordt betaald (zie Afrekenroutes).

Een planwijziging vereist factureringsrechten op de workspace van de site; zonder die rechten is het antwoord 403 not_authorized en verandert er niets, ook name niet. Alleen hernoemen vereist alleen bewerkrechten.

Wanneer beide velden aanwezig zijn, wordt het hernoemen eerst uitgevoerd; bij een validatiefout op het hernoemen wordt de resize volledig overgeslagen en is de reactie 422.

Een site die in verwijdering staat kan met geen van beide bedoelingen worden bijgewerkt: het verzoek wordt afgewezen met 403 pending_delete plus een delete_scheduled_at-veld, en er verandert niets. Herstel de site eerst.

Params
  • name: String | site hernoemen
  • plan: String | Product short_name (bijv. "basic")
Teruggegeven params (planwijziging-pad, 202 Accepted)
  • status: String | "accepted"
  • cart: Object | { token, status, rollup_status, poll_url }
  • payment: Object | { status, method_type, hosted_invoice_url }. Als de resize per bankoverschrijving wordt betaald, is status awaiting_bank_transfer en bevat het object daarnaast method, invoice_id, invoice_number, amount_due_cents, currency, due_date en instructions
  • orders: Array | [{ id, status, poll_url }] (leeg tijdens het asynchrone venster)
  • billing: Object | alleen post-pay-resizes: { mode: "postpay", invoice_date, entries }
Fouten (planwijziging)
  • 400 unknown_product | plan komt niet overeen met een Product short_name
  • 400 product_unavailable | Product bestaat maar wordt niet aangeboden op het facturatieplan van het account
  • 400 no_default_payment_method | facturatieaccount niet klaar om te belasten
  • 403 not_authorized | de gebruiker heeft geen factureringsrechten op de workspace van de site
  • 422 no_price_for_plan | geen prijs die overeenkomt met de termijn van het account
  • 422 multi_site_resize_unsupported | account heeft meer dan één actieve site
  • 422 subscription_not_proratable | dit abonnement kan niet worden geresized; neem contact op met support
  • 422 cart_pay_failed | de betaling kon niet worden gestart
  • 422 billing_settling | de facturatie van de site wordt nog afgewikkeld (een net aangemaakte site); wordt ook teruggegeven door Een site verwijderen. Dit is geen dunning-opschorting, die 402 service_suspended is
  • Afrekenweigeringen, net als bij orders: 400 billing_details_incomplete; 403 billing_permission_required; 409 bank_transfer_in_progress, bank_transfer_busy, postpay_busy; 422 outstanding_balance_exceeded, in_flight_limit_exceeded, payer_in_dunning, recent_dispute, instant_payment_method_required, sepa_not_trusted, bank_transfer_refused, bank_transfer_failed, postpay_route_changed, postpay_pay_open_invoices, postpay_contact_support, postpay_payment_in_progress, postpay_add_payment_method, postpay_change_refused, postpay_failed. Zie Orders per code

Een site herstarten

Herstart de WordPress-container voor een site. Andere containers, zoals de database, worden niet geraakt. Geeft 202 terug.

Tijdens onderhoud wordt de herstart in de wachtrij gezet tot het onderhoud klaar is (de task toont PAUSED), en heeft de 202 een body: {"deferred": true, "code": "node_maintenance", "node_status": {...}}. Staat de server offline, dan is het antwoord 409 node_offline en komt er niets in de wachtrij.

POST /api/sites/:id/restart

curl -X POST -H "Authorization: Bearer $CLOUDPRESS_TOKEN" -H "X-Auth-Account: $ACCOUNT_ID" \
  https://your-instance/api/sites/$SITE_ID/restart

Een site verwijderen

DELETE /api/sites/:id

Verwijdert de site, asynchroon. Geeft 200 terug zodra het verzoek is geaccepteerd.

De site komt daarna gedurende een bewaartermijn (standaard 7 dagen) in verwijdering te staan. In die periode geldt:

  • De site staat uit; zijn data en back-ups blijven bewaard.
  • De facturatie wordt onmiddellijk geannuleerd: verlengingen stoppen en de ongebruikte tijd wordt als tegoed op het saldo van het account bijgeschreven.
  • Transactionele e-mail voor de site wordt opgeschort.
  • De site blijft in de lijst van GET /api/sites staan met pending_delete: true, en GET /api/sites/:id geeft de beperkte payload terug met status: "pending_delete".
  • Al het overige is vergrendeld. PATCH /api/sites/:id, een tweede DELETE en elk genest site-endpoint, reads inbegrepen, geven 403 pending_delete terug met de delete_scheduled_at van de site.
  • Zijn hostnamen blijven gereserveerd, dus het koppelen van zo'n hostnaam aan een andere site binnen dezelfde facturatiefamilie geeft 422 hostname_in_use terug.

delete_scheduled_at toont wanneer de site definitief wordt gewist. Dan worden de site, zijn data en zijn domeinen permanent verwijderd.

Een site verwijderen vereist een gebruiker die lid is van het account van de site met de rol voor facturatiebeheer (een accountbeheerder, of een rol met zowel facturatie- als bewerkrechten). Bij een account dat de facturatie erft, wordt de rol op het facturatieaccount gecontroleerd. Andere aanroepers krijgen 403 {"errors":["Not Authorized"]}.

Een site die in verwijdering staat herstellen of vervroegd wissen kan niet via de API. Beide staan op de pagina van de site in het CloudPress-dashboard. Herstellen is een betaalde nieuwe aanschaf van hetzelfde plan.

Fouten
  • 403 | de aanroeper is geen accountlid met de rol voor facturatiebeheer ({"errors":["Not Authorized"]})
  • 403 pending_delete | de site staat al in verwijdering; de body bevat delete_scheduled_at
  • 402 service_suspended | de site is dunning-suspended (zie de paginakop)
  • 422 billing_settling | de facturatie van de site wordt nog afgewikkeld (het initiële facturatievenster van een net aangemaakte site)

Het verwijderen van een site kan invloed hebben op volumekortingen op je andere sites.


Site-SSO

Single sign-on naar de WordPress-beheeromgeving of de database (phpMyAdmin) van een site.

Niet beschikbaar via OAuth — SSO vereist een sessie- of API-sleutel-credential. Zonder de wp_login-rolflag kun je alleen URL's genereren voor WordPress-gebruikers waaraan de gebruiker van het token expliciet is gekoppeld; met wp_login voor elke gebruiker.

Alle WP-gebruikers opvragen

Dit geeft ruwe gebruikersgegevens van de WordPress-site terug. Het bijbehorende ID is het interne ID van WordPress, geen CloudPress-gebruiker.

GET /api/sites/:id/sso

Teruggegeven params
  • users: Array
    • ID: Integer
    • user_login: String
    • display_name: String
    • user_email: String
    • user_registered: DateTime
    • roles: String
    • url: String

Inloggen als gebruiker

POST /api/sites/:id/sso

Bij succes wordt 200 { "url": "..." } teruggegeven; bij falen 400. Geeft 422 {"errors":["Missing username"]} terug wanneer username vereist is maar leeg is. Geeft 409 node_maintenance of node_offline terug zolang de server van de site niet online is (hetzelfde geldt voor Alle WP-gebruikers opvragen); zie Node-status.

Params
  • kind: String | wordpress (standaard) of database
  • username: String | vereist tenzij kind database is. Ook als je kind weglaat is een username vereist
Teruggegeven params
  • url: String

SSH-gegevens opnieuw genereren

POST /api/sites/{site-id}/ssh/regenerate

Stelt een nieuw SSH/SFTP-wachtwoord in; host, poort, gebruikersnaam en hostsleutels blijven gelijk, en open sessies worden verbroken. Geen body; vereist sites:write en bewerkrechten. Geeft 202 terug met {"task": {...}} (vorm als in Een enkele site-task bekijken). Poll totdat status OK of FAILED is en lees dan het nieuwe wachtwoord uit Site bekijken — dit endpoint geeft het nooit terug.

Fouten
  • 402 service_suspended | de site is opgeschort wegens een onbetaalde factuur
  • 403 pending_delete | de site staat in verwijdering en is vergrendeld
  • 403 (geen code) | de gebruiker achter de credential heeft geen bewerkrechten op de site
  • 409 ssh_regeneration_in_progress | er loopt al een regeneratie; task is die regeneratie
  • 409 node_maintenance, node_offline | de server van de site is niet online; probeer het later opnieuw. Zie Node-status
  • 422 not_provisioned | de site heeft geen SSH-toegang om te roteren
  • 422 ssh_regeneration_refused | de rotatie is geweigerd; er is niets gewijzigd
  • 429 rate_limited | binnen de afgelopen 5 minuten al opnieuw gegenereerd; wacht retry_after seconden (ook in de Retry-After-header)
  • 503 computestacks_unavailable | tijdelijke storing; er is niets gewijzigd, probeer opnieuw

Tasks

Vraag alle tasks voor een bepaalde site op.

GET /api/sites/{site-id}/tasks

GET /api/sites/{site-id}/tasks/{filter-name}/filter

Filter is optioneel en kan een van de volgende zijn:

  • OK
  • PENDING
  • RUNNING
  • CANCELLED
  • PAUSED
  • FAILED
  • TODAY <-- Speciaal filter om alle events van vandaag te tonen.

Alle reacties zijn beperkt tot de 100 meest recente tasks.

Teruggegeven params

Geeft een array van objecten terug:

  • id: Integer
  • name: String
  • data: String | Ruwe data van het event
  • labels: Object | Een herstart die door onderhoud is uitgesteld, bevat deferred: "node_maintenance"; een verzoek dat door de server is geweigerd, bevat node_refused met de code
  • status: String | OK, PENDING, RUNNING, CANCELLED, PAUSED, FAILED
  • start_on: Timestamp | Wanneer de task is gestart. Wordt volledig weggelaten (niet null) wanneer die niet is gezet
  • end_on: Timestamp | Wordt volledig weggelaten (niet null) wanneer die niet is gezet
  • created_at: Timestamp
  • updated_at: Timestamp
  • performed_by: Object | Wordt volledig weggelaten wanneer er geen gebruiker aan is toegeschreven
    • id: String | null | Het ID van de gebruiker, of null wanneer de actor is gemaskeerd
    • name: String | Volledige naam van de gebruiker, of een gemaskeerde vervanger
    • email: String | null | null wanneer de actor is gemaskeerd

performed_by wordt gemaskeerd voor niet-klant-actoren

Tasks die door het platform zelf zijn uitgevoerd rapporteren {"id": null, "name": "System", "email": null}, en tasks die door supportmedewerkers zijn uitgevoerd rapporteren {"id": null, "name": "Support", "email": null}. Alleen acties van een gebruiker in je eigen workspace geven een echt ID, een echte naam en een echt e-mailadres terug. Behandel name als een weergavetekst, niet als een identifier — match op id en houd er rekening mee dat die null kan zijn.

Een enkele site-task bekijken

GET /api/sites/{site-id}/tasks/{id}

Geeft één task-object terug (dezelfde velden als hierboven).

Fouten
  • 404 unknown_task | er hoort geen task met dat id bij deze site

Metrics

Realtime resources

Dit endpoint geeft de realtime-status voor een site terug.

GET /api/sites/{site-id}/metrics/resources

Teruggegeven params
  • total_storage: Decimal
  • {Image Name}: Object | bijv. "WordPress"
    • cpu: Decimal | Percentage van het totale plan
    • storage: Decimal | GB
    • memory: Decimal | MB

Ruwe metrics

Geeft ruwe container-metrics voor een site terug.

POST /api/sites/{site-id}/metrics/resources

kind kan een of meer zijn van:

  • cpu
  • cpu_throttled
  • memory
  • memory_throttled
  • storage
Params
  • kind: Array | ['storage', 'memory'] (voorbeeld)
  • period_start: Integer | unix-timestamp (moet binnen de laatste maand vallen)
  • period_end: Integer | unix-timestamp (na period_start, binnen de laatste maand)
  • step: String | standaard '1m'.

De parameters Period en Step hebben geen invloed op de storage-metric. Die geeft altijd de huidige waarde terug.

Teruggegeven params
  • service_name: Object
    • id: Integer
    • name: String
    • image: String
    • resources: Object | Afhankelijk van welke waarden zijn geselecteerd
      • cpu: Array<time, value>
      • cpu_throttled: Array<time, value>
      • memory: Array<time, value>
      • memory_throttled: Array<time, value>
      • storage: Decimal
Fouten

Alle foutbodies gebruiken de array-structuur {"errors": [...]}.

  • 422 | lege of ongeldige kind, of period_start/period_end buiten de laatste maand / verkeerde volgorde
  • 502 | upstream metric-service niet beschikbaar
  • 400 | onverwachte fout

CDN-metrics

Geeft ruwe CDN-statistieken voor een site terug.

POST /api/sites/{site-id}/metrics/cdn

Params
  • period_start: Integer | Unix-timestamp. Heeft voorrang op period. (>3 maanden oud → 422)
  • step: String | hourly of monthly. Wordt alleen geraadpleegd met period_start.
  • period: String | vooraf ingesteld venster — een van 12h, 24h, 7d, 30d. Wordt alleen gebruikt wanneer period_start ontbreekt. Onbekende waarden → 422.
Teruggegeven params
  • TotalBandwidthUsed: Integer | Voor de opgegeven periode
  • TotalOriginTraffic: Integer | Voor de opgegeven periode
  • TotalRequestsServed: Integer | Voor de opgegeven periode
  • CacheHitRate: Integer
  • OriginResponseTimeChart: Object | "2025-11-20T00:00:00Z": 0 (ISO8601-timestamp → Integer)
  • BandwidthUsedChart: Object
  • BandwidthCachedChart: Object
  • CacheHitRateChart: Object
  • RequestsServedChart: Object
  • PullRequestsPulledChart: Object
  • OriginTrafficChart: Object
  • GeoTrafficDistribution: Object | bijv. "EU: Stockholm, SE": 0
  • Error3xxChart: Object
  • Error4xxChart: Object
  • Error5xxChart: Object

De response kan meer velden bevatten dan hierboven staan.

Eenheden: bandbreedte- en traffictotalen zijn in bytes. CacheHitRate is een percentage van 0 tot 100, ongerond.

Fouten
  • 409 | CDN niet actief voor deze site
  • 422 | ontbrekende/nul/te-oude period_start, of onbekende period
  • 502 | upstream statistiekenophaling mislukt
Voorbeeld: maandelijkse bandbreedte tonen
curl -X POST -d '{"period_start": 1760983782, "step": "monthly"}'

Dit geeft data terug voor de afgelopen maand, in dagelijkse stappen, maar wat belangrijker is: de waarde TotalBandwidthUsed geldt voor de volledige periode van 30 dagen.

Zie ook Shield-metrics.


Back-ups

Gebruik het Tasks-endpoint om de status van deze acties te volgen.

Alle back-ups opvragen

Geeft een lijst van back-ups voor een bepaalde site terug, gegroepeerd per volume. Geeft [] terug wanneer er geen volumes zijn; een volume zonder archieven wordt als {} weergegeven.

GET /api/sites/{site-id}/backups

Teruggegeven params
  • {label}: Object | bijv. wordpress, of mysql
    • id: Integer | ID van het volume (vereist voor back-upbewerkingen)
    • size: Decimal | GB - totale ruwe back-upgrootte (niet de ingerichte capaciteit van het volume)
    • usage: Decimal | GB - gecomprimeerde en gededupliceerde back-upgrootte (werkelijk gebruik op schijf)
    • archives: Array
      • id: String
      • name: String
      • created: String | in iso8601-formaat

Een back-up maken

PATCH /api/sites/{site-id}/backups/{volume-id}

Geeft 202 terug. Een onbekend volume geeft 404 {"errors":["Volume not found"]} terug. Geeft 409 node_maintenance of node_offline terug zolang de server van de site back-ups weigert; zie Node-status.

Params
  • name: String | Back-upnaam

Een back-up verwijderen

DELETE /api/sites/{site-id}/backups/{volume-id}

Geeft 202 terug. Geeft 409 node_maintenance of node_offline terug zolang de server van de site back-ups weigert.

Params
  • backup_id: String | Back-up-ID

Een back-up terugzetten

PATCH /api/sites/{site-id}/restores/{volume-id}

Geeft 202 terug. Geeft 409 node_maintenance of node_offline terug zolang de server van de site terugzetten weigert; zie Node-status.

Params
  • backup_id: String | Back-up-ID

Een back-up-export aanvragen

POST /api/sites/{site-id}/backups/{volume-id}/export

Vraagt een downloadbare .tar.gz van één back-uparchief aan. Asynchroon: geeft 202 terug met {"status": "preparing", "backup_id": "..."}. Poll Exportstatus voor de download-URL.

Beide export-endpoints vereisen sites:write en bewerkrechten op de site, inclusief het uitlezen van de status.

Params
Fouten
  • 422 | backup_id ontbreekt ({"errors":["backup_id is required"]})
  • 404 | onbekend volume ({"errors":["Volume not found"]})
  • 403 | de gebruiker achter de token heeft geen bewerkrechten op de site ({"errors":["Not Authorized"]})
  • 409 node_maintenance, node_offline | de server van de site weigert exports. Zie Node-status

Loopt er al een export voor het volume, dan heeft het verzoek geen effect. Volg de voortgang via het status-endpoint.


Exportstatus en download

GET /api/sites/{site-id}/backups/{volume-id}/export?backup_id={archive-id}

Geeft de exportstatus van één archief terug, plus de download-URL zodra die klaar is. Haal de URL op met een gewone HTTPS-GET; hij heeft geen CloudPress-credentials nodig.

Params
  • backup_id: String (vereist) | Archief-ID, meegegeven in de querystring
Teruggegeven params
  • status: String | een van none, in_progress, ready, expired, failed
  • url: String | alleen bij ready — HTTPS-URL naar de .tar.gz
  • expires_at: String | alleen bij ready — iso8601, wanneer de URL vervalt
  • size: Integer | alleen bij ready — grootte van de export in bytes
  • error: String | alleen bij failed — leesbare reden van de mislukking
Fouten
  • 422 | backup_id ontbreekt ({"errors":["backup_id is required"]})
  • 404 | onbekend volume ({"errors":["Volume not found"]}), of geen archief dat bij backup_id past ({"errors":["Backup not found"]})
  • 403 | de gebruiker achter de token heeft geen bewerkrechten op de site ({"errors":["Not Authorized"]})

Behandel url als een bearer-secret

Iedereen die hem heeft, kan de volledige back-up downloaden tot hij vervalt. Log, stuur of bewaar hem niet. Zodra status expired is, vraag je een nieuwe export aan.


PHP-versie wijzigen

Beschikbare opvragen

GET /api/sites/{site-id}/variants

Teruggegeven params
  • php: Array<Object> | Momenteel wordt alleen php teruggegeven.
    • id: Integer | variant_id nodig om de versie te wijzigen
    • label: String
    • is_default: Boolean | Wordt gebruikt bij het uitrollen van een nieuwe site.
    • active: Boolean | Huidige versie die de site gebruikt

Wijzigen

Bij het wijzigen van de PHP-versie van een site wordt de site herstart met een ander container-image. Houd er rekening mee dat de site even nodig heeft om te herstarten. Geeft 202 terug. Het URL-segment moet php zijn — elke andere variant geeft 422 {"errors":["only php version changes are allowed"]} terug.

PATCH /api/sites/{site-id}/variants/php

Params
  • variant_id: Integer
Teruggegeven params (202 Accepted)
  • task_id: Integer | Het ID van de task zodat je kunt meekijken.