{"info":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"description":"","owner":"13664964","collectionId":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","publishedId":"TVssjU7Z","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"1A3C33","highlight":"1D4D40"},"publishDate":"2020-12-19T05:13:22.000Z"},"item":[{"name":"user","item":[{"name":"get current user","id":"91d1394a-3716-457d-a2ed-66121426d2a4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"}],"url":"https://my.gridpane.com/oauth/api/v1/user","description":"

Request for user account information.

\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}},"urlObject":{"path":["oauth","api","v1","user"],"host":["https://my.gridpane.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"91d1394a-3716-457d-a2ed-66121426d2a4"},{"name":"get current user integrations","id":"01adb870-c8df-4c52-b340-a7a2936f4427","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"}],"url":"https://my.gridpane.com/oauth/api/v1/user/integrations","description":"

Request for all integrations available to this user account.

\n

IDs can be used for API actions that require integrations.

\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}},"urlObject":{"path":["oauth","api","v1","user","integrations"],"host":["https://my.gridpane.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"01adb870-c8df-4c52-b340-a7a2936f4427"},{"name":"Create new user account (agency only)","id":"eaf2d172-e0cf-40dc-91a5-9920acdf9928","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"{string}\",\n \"email\": \"{string}\",\n \"teamId\": {int},\n \"role\": \"{string}\"\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/user","description":"

Create a new user account on an agency instance

\n

name - string - required

\n

Username of the new user account to be created

\n

email - string - required

\n

email of the new user account to be created

\n

teamId - integer - required

\n

All users on an agency instance need to be assigned to a team belonging to the instance owner.
Team IDs can be parsed from the response to an API request to:
GET /api/v1/user

\n

role - string - required

\n

The Team Role for the new user on their assigned team.
Accepts: admin || staff || client

\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}},"urlObject":{"path":["oauth","api","v1","user"],"host":["https://my.gridpane.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"eaf2d172-e0cf-40dc-91a5-9920acdf9928"}],"id":"87c3fbcb-b349-444b-8f49-61fb75446129","_postman_id":"87c3fbcb-b349-444b-8f49-61fb75446129","description":"","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}}},{"name":"server","item":[{"name":"get servers list","id":"fe28ec91-8050-4221-90f9-81c4f0999e9a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"}],"url":"https://my.gridpane.com/oauth/api/v1/server","description":"

Request for all servers belonging to User.

\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}},"urlObject":{"path":["oauth","api","v1","server"],"host":["https://my.gridpane.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"fe28ec91-8050-4221-90f9-81c4f0999e9a"},{"name":"get servers list - summaries","id":"66eb5b04-5526-4233-8841-9e694da7ae98","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"Bearer {{oath_token}}"}],"body":{"mode":"raw","raw":"{\n \"summary\": {boolean}\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/server","description":"

Request for all servers belonging to a user.
Returns a summarised object for each server detailing only the most important data.

\n

summary - boolean

\n

summary key accepts true||false values.

\n

For each server the response will contain:

\n
    \n
  • id
    • \n
  • label
    • \n
  • ip
    • \n
  • region
    • \n
  • sub_id (from provider)
    • \n
  • subdomain (for monit/phpma sites)
    • \n
  • webserver (nginx or openlitespeed)
    • \n
  • database (percona or mariadb)
    • \n
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}},"urlObject":{"path":["oauth","api","v1","server"],"host":["https://my.gridpane.com"],"query":[],"variable":[]}},"response":[{"id":"96ff571d-3170-4433-98d2-f63ebea48674","name":"get a summary of all servers belonging to a user","originalRequest":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"Bearer {{oath_token}}"}],"body":{"mode":"raw","raw":"{\n \"summary\" true\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/server"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"66eb5b04-5526-4233-8841-9e694da7ae98"},{"name":"get single server","id":"889d5639-8201-4930-b3ac-b19d0e972354","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"}],"url":"https://my.gridpane.com/oauth/api/v1/server/{server.id}","description":"

Request for individual server data

\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}},"urlObject":{"path":["oauth","api","v1","server","{server.id}"],"host":["https://my.gridpane.com"],"query":[],"variable":[]}},"response":[{"id":"b96107cb-9152-4e73-b2f8-15eb3fe44312","name":"get single server by server id in request url","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"}],"url":"https://my.gridpane.com/oauth/api/v1/server/1"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"889d5639-8201-4930-b3ac-b19d0e972354"},{"name":"get single server - summary","id":"8a931357-a459-41d8-a667-d212311ac353","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"Bearer {{oath_token}}"}],"body":{"mode":"raw","raw":"{\n \"summary\": {boolean}\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/server/{server.id}","description":"

Request for an individual server belonging to a user
Returns a summarised object for the provided server id detailing only the most important data

\n

summary - boolean

\n

summary key accepts true||false values.

\n

For each server the response will contain:

\n
    \n
  • id
    • \n
  • label
    • \n
  • ip
    • \n
  • region
    • \n
  • sub_id (from provider)
    • \n
  • subdomain (for monit/phpma sites)
    • \n
  • webserver (nginx or openlitespeed)
    • \n
  • database (percona or mariadb)
    • \n
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}},"urlObject":{"path":["oauth","api","v1","server","{server.id}"],"host":["https://my.gridpane.com"],"query":[],"variable":[]}},"response":[{"id":"c9af06e9-654a-4e52-9ba5-d6ab6b5fba29","name":"get summary of single server by ID","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"summary\": true\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/server/1"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"8a931357-a459-41d8-a667-d212311ac353"},{"name":"get digital ocean server plans","id":"4352d23f-ffc5-4b0e-bb2c-0724a02901b0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"Bearer {{oath_token}}"}],"url":"https://my.gridpane.com/oauth/api/v1/server/digitalocean/plans","description":"

Get all available Digital Ocean Plans to make a POST build request using plan_id and region_id

\n

Will provide the necessary plan_id with each plan containing a regions json containing the id of available regions for that plan.

\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}},"urlObject":{"path":["oauth","api","v1","server","digitalocean","plans"],"host":["https://my.gridpane.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"4352d23f-ffc5-4b0e-bb2c-0724a02901b0"},{"name":"get vultr server plans","id":"9be734f5-f2aa-4e41-944a-95fa40dbe45e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"Bearer {{oath_token}}"}],"url":"https://my.gridpane.com/oauth/api/v1/server/vultr/plans","description":"

Get all available Vultr Plans to make a POST build request using plan_id and region_id

\n

Will provide the necessary plan_id with each plan containing a regions json containing the id of available regions for that plan.

\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}},"urlObject":{"path":["oauth","api","v1","server","vultr","plans"],"host":["https://my.gridpane.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"9be734f5-f2aa-4e41-944a-95fa40dbe45e"},{"name":"get linode server plans","id":"d14131fa-a4f7-44e9-b0d2-db057d78aecf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"Bearer {{oath_token}}"}],"url":"https://my.gridpane.com/oauth/api/v1/server/linode/plans","description":"

Get all available Linode Plans to make a POST build request using plan_id and region_id

\n

Will provide the necessary plan_id with each plan containing a regions json containing the id of available regions for that plan.

\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}},"urlObject":{"path":["oauth","api","v1","server","linode","plans"],"host":["https://my.gridpane.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"d14131fa-a4f7-44e9-b0d2-db057d78aecf"},{"name":"get aws-lightsail server plans","id":"7bbb3c7e-baf7-41cf-83c5-317d7d4e9ffb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"Bearer {{oath_token}}"}],"url":"https://my.gridpane.com/oauth/api/v1/server/aws-lightsail/plans","description":"

Get all available AWS Lightsail Plans to make a POST build request using plan_id and region_id

\n

Will provide the necessary plan_id with each plan containing a regions json containing the id of available regions for that plan.

\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}},"urlObject":{"path":["oauth","api","v1","server","aws-lightsail","plans"],"host":["https://my.gridpane.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"7bbb3c7e-baf7-41cf-83c5-317d7d4e9ffb"},{"name":"get UpCloud server plans","id":"528f1f42-2509-4474-bd10-9c99d7d5dedf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"Bearer {{oath_token}}"}],"url":"https://my.gridpane.com/oauth/api/v1/server/upcloud/plans","description":"

Get all available UpCloud Plans to make a POST build request using plan_id and region_id

\n

Will provide the necessary plan_id with each plan containing a regions json containing the id of available regions for that plan.

\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}},"urlObject":{"path":["oauth","api","v1","server","upcloud","plans"],"host":["https://my.gridpane.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"528f1f42-2509-4474-bd10-9c99d7d5dedf"},{"name":"get server build progress","id":"34a85117-f9d2-4a69-be22-38dc402ddf17","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"}],"url":"https://my.gridpane.com/oauth/api/v1/server/build-progress/{server.id}","description":"

Request for all servers belonging to User.

\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}},"urlObject":{"path":["oauth","api","v1","server","build-progress","{server.id}"],"host":["https://my.gridpane.com"],"query":[],"variable":[]}},"response":[{"id":"b47bc28c-05e5-4fd4-97b9-228d265efed3","name":"get server build progress - build preparing","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"}],"url":"https://my.gridpane.com/oauth/api/v1/server/build-progress/1984"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"server_id\": 1984,\n \"build_status\": \"preparing to initiate build... waiting for ready callback from server!\"\n}"},{"id":"4b9fd39a-9f8d-44d5-b6e9-dd3452f06084","name":"get server build progress - build complete","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"}],"url":"https://my.gridpane.com/oauth/api/v1/server/build-progress/1984"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"server_id\": 1984,\n \"build_percentage\": 100,\n \"current_details\": \"Provisioning complete!!!\",\n \"updated_at\": \"2021-05-06T09:13:09.000000Z\"\n}"}],"_postman_id":"34a85117-f9d2-4a69-be22-38dc402ddf17"},{"name":"clone all sites to another server","id":"defcda50-8675-4442-b3ec-0d5d95d83358","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","type":"text","value":"Bearer {{oath_token}}"}],"body":{"mode":"raw","raw":"{\r\n \"clone_to_server\": {integer}\r\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/server/{server.id}","description":"

Clone all sites from origin server to destination server.

\n

clone_to_server - integer - required

\n

clone_to_server accepts an integer value as the id of the destination server to clone to.

\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}},"urlObject":{"path":["oauth","api","v1","server","{server.id}"],"host":["https://my.gridpane.com"],"query":[],"variable":[]}},"response":[{"id":"170ce7a1-6543-4ccd-9b73-8b6b9d914dcc","name":"clone all sites to another server","originalRequest":{"method":"PUT","header":[{"key":"Authorization","type":"text","value":"Bearer {{oath_token}}"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"clone_to_server\": 2\r\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/server/1"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"defcda50-8675-4442-b3ec-0d5d95d83358"},{"name":"update system timezone","id":"48df9166-eb32-4b94-9a7e-adb1c624cfc1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","type":"text","value":"Bearer {{oath_token}}"}],"body":{"mode":"raw","raw":"{\r\n \"server_timezone\": \"{string}\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/server/{server.id}","description":"

Update Server Timezone by using server id as url parameter

\n

server_timezone - string

\n

server_timezone can have the following values:

\n
UTC     \nAfrica/Abidjan   \nAfrica/Accra\nAfrica/Addis_Ababa\nAfrica/Algiers\nAfrica/Asmara\nAfrica/Bamako\nAfrica/Bangui\nAfrica/Banjul\nAfrica/Bissau\nAfrica/Blantyre\nAfrica/Brazzaville\nAfrica/Bujumbura\nAfrica/Cairo\nAfrica/Casablanca\nAfrica/Ceuta\nAfrica/Conakry\nAfrica/Dakar\nAfrica/Dar_es_Salaam\nAfrica/Djibouti\nAfrica/Douala\nAfrica/El_Aaiun\nAfrica/Freetown\nAfrica/Gaborone\nAfrica/Harare\nAfrica/Johannesburg\nAfrica/Juba\nAfrica/Kampala\nAfrica/Khartoum\nAfrica/Kigali\nAfrica/Kinshasa\nAfrica/Lagos\nAfrica/Libreville\nAfrica/Lome\nAfrica/Luanda\nAfrica/Lubumbashi\nAfrica/Lusaka\nAfrica/Malabo\nAfrica/Maputo\nAfrica/Maseru\nAfrica/Mbabane\nAfrica/Mogadishu\nAfrica/Monrovia\nAfrica/Nairobi\nAfrica/Ndjamena\nAfrica/Niamey\nAfrica/Nouakchott\nAfrica/Ouagadougou\nAfrica/Porto-Novo\nAfrica/Sao_Tome\nAfrica/Tripoli\nAfrica/Tunis\nAfrica/Windhoek\nAmerica/Adak\nAmerica/Anchorage\nAmerica/Anguilla\nAmerica/Antigua\nAmerica/Araguaina\nAmerica/Argentina/Buenos_Aires\nAmerica/Argentina/Catamarca\nAmerica/Argentina/Cordoba\nAmerica/Argentina/Jujuy\nAmerica/Argentina/La_Rioja\nAmerica/Argentina/Mendoza\nAmerica/Argentina/Rio_Gallegos\nAmerica/Argentina/Salta\nAmerica/Argentina/San_Juan\nAmerica/Argentina/San_Luis\nAmerica/Argentina/Tucuman\nAmerica/Argentina/Ushuaia\nAmerica/Aruba\nAmerica/Asuncion\nAmerica/Atikokan\nAmerica/Bahia\nAmerica/Bahia_Banderas\nAmerica/Barbados\nAmerica/Belem\nAmerica/Belize\nAmerica/Blanc-Sablon\nAmerica/Boa_Vista\nAmerica/Bogota\nAmerica/Boise\nAmerica/Cambridge_Bay\nAmerica/Campo_Grande\nAmerica/Cancun\nAmerica/Caracas\nAmerica/Cayenne\nAmerica/Cayman\nAmerica/Chicago\nAmerica/Chihuahua\nAmerica/Costa_Rica\nAmerica/Creston\nAmerica/Cuiaba\nAmerica/Curacao\nAmerica/Danmarkshavn\nAmerica/Dawson\nAmerica/Dawson_Creek\nAmerica/Denver\nAmerica/Detroit\nAmerica/Dominica\nAmerica/Edmonton\nAmerica/Eirunepe\nAmerica/El_Salvador\nAmerica/Fort_Nelson\nAmerica/Fortaleza\nAmerica/Glace_Bay\nAmerica/Goose_Bay\nAmerica/Grand_Turk\nAmerica/Grenada\nAmerica/Guadeloupe\nAmerica/Guatemala\nAmerica/Guayaquil\nAmerica/Guyana\nAmerica/Halifax\nAmerica/Havana\nAmerica/Hermosillo\nAmerica/Indiana/Indianapolis\nAmerica/Indiana/Knox\nAmerica/Indiana/Marengo\nAmerica/Indiana/Petersburg\nAmerica/Indiana/Tell_City\nAmerica/Indiana/Vevay\nAmerica/Indiana/Vincennes\nAmerica/Indiana/Winamac\nAmerica/Inuvik\nAmerica/Iqaluit\nAmerica/Jamaica\nAmerica/Juneau\nAmerica/Kentucky/Louisville\nAmerica/Kentucky/Monticello\nAmerica/Kralendijk\nAmerica/La_Paz\nAmerica/Lima\nAmerica/Los_Angeles\nAmerica/Lower_Princes\nAmerica/Maceio\nAmerica/Managua\nAmerica/Manaus\nAmerica/Marigot\nAmerica/Martinique\nAmerica/Matamoros\nAmerica/Mazatlan\nAmerica/Menominee\nAmerica/Merida\nAmerica/Metlakatla\nAmerica/Mexico_City\nAmerica/Miquelon\nAmerica/Moncton\nAmerica/Monterrey\nAmerica/Montevideo\nAmerica/Montserrat\nAmerica/Nassau\nAmerica/New_York\nAmerica/Nipigon\nAmerica/Nome\nAmerica/Noronha\nAmerica/North_Dakota/Beulah\nAmerica/North_Dakota/Center\nAmerica/North_Dakota/New_Salem\nAmerica/Nuuk\nAmerica/Ojinaga\nAmerica/Panama\nAmerica/Pangnirtung\nAmerica/Paramaribo\nAmerica/Phoenix\nAmerica/Port-au-Prince\nAmerica/Port_of_Spain\nAmerica/Porto_Velho\nAmerica/Puerto_Rico\nAmerica/Punta_Arenas\nAmerica/Rainy_River\nAmerica/Rankin_Inlet\nAmerica/Recife\nAmerica/Regina\nAmerica/Resolute\nAmerica/Rio_Branco\nAmerica/Santarem\nAmerica/Santiago\nAmerica/Santo_Domingo\nAmerica/Sao_Paulo\nAmerica/Scoresbysund\nAmerica/Sitka\nAmerica/St_Barthelemy\nAmerica/St_Johns\nAmerica/St_Kitts\nAmerica/St_Lucia\nAmerica/St_Thomas\nAmerica/St_Vincent\nAmerica/Swift_Current\nAmerica/Tegucigalpa\nAmerica/Thule\nAmerica/Thunder_Bay\nAmerica/Tijuana\nAmerica/Toronto\nAmerica/Tortola\nAmerica/Vancouver\nAmerica/Whitehorse\nAmerica/Winnipeg\nAmerica/Yakutat\nAmerica/Yellowknife\nAntarctica/Casey\nAntarctica/Davis\nAntarctica/DumontDUrville\nAntarctica/Macquarie\nAntarctica/Mawson\nAntarctica/McMurdo\nAntarctica/Palmer\nAntarctica/Rothera\nAntarctica/Syowa\nAntarctica/Troll\nAntarctica/Vostok\nArctic/Longyearbyen\nAsia/Aden\nAsia/Almaty\nAsia/Amman\nAsia/Anadyr\nAsia/Aqtau\nAsia/Aqtobe\nAsia/Ashgabat\nAsia/Atyrau\nAsia/Baghdad\nAsia/Bahrain\nAsia/Baku\nAsia/Bangkok\nAsia/Barnaul\nAsia/Beirut\nAsia/Bishkek\nAsia/Brunei\nAsia/Chita\nAsia/Choibalsan\nAsia/Colombo\nAsia/Damascus\nAsia/Dhaka\nAsia/Dili\nAsia/Dubai\nAsia/Dushanbe\nAsia/Famagusta\nAsia/Gaza\nAsia/Hebron\nAsia/Ho_Chi_Minh\nAsia/Hong_Kong\nAsia/Hovd\nAsia/Irkutsk\nAsia/Jakarta\nAsia/Jayapura\nAsia/Jerusalem\nAsia/Kabul\nAsia/Kamchatka\nAsia/Karachi\nAsia/Kathmandu\nAsia/Khandyga\nAsia/Kolkata\nAsia/Krasnoyarsk\nAsia/Kuala_Lumpur\nAsia/Kuching\nAsia/Kuwait\nAsia/Macau\nAsia/Magadan\nAsia/Makassar\nAsia/Manila\nAsia/Muscat\nAsia/Nicosia\nAsia/Novokuznetsk\nAsia/Novosibirsk\nAsia/Omsk\nAsia/Oral\nAsia/Phnom_Penh\nAsia/Pontianak\nAsia/Pyongyang\nAsia/Qatar\nAsia/Qostanay\nAsia/Qyzylorda\nAsia/Riyadh\nAsia/Sakhalin\nAsia/Samarkand\nAsia/Seoul\nAsia/Shanghai\nAsia/Singapore\nAsia/Srednekolymsk\nAsia/Taipei\nAsia/Tashkent\nAsia/Tbilisi\nAsia/Tehran\nAsia/Thimphu\nAsia/Tokyo\nAsia/Tomsk\nAsia/Ulaanbaatar\nAsia/Urumqi\nAsia/Ust-Nera\nAsia/Vientiane\nAsia/Vladivostok\nAsia/Yakutsk\nAsia/Yangon\nAsia/Yekaterinburg\nAsia/Yerevan\nAtlantic/Azores\nAtlantic/Bermuda\nAtlantic/Canary\nAtlantic/Cape_Verde\nAtlantic/Faroe\nAtlantic/Madeira\nAtlantic/Reykjavik\nAtlantic/South_Georgia\nAtlantic/St_Helena\nAtlantic/Stanley\nAustralia/Adelaide\nAustralia/Brisbane\nAustralia/Broken_Hill\nAustralia/Darwin\nAustralia/Eucla\nAustralia/Hobart\nAustralia/Lindeman\nAustralia/Lord_Howe\nAustralia/Melbourne\nAustralia/Perth\nAustralia/Sydney\nEurope/Amsterdam\nEurope/Andorra\nEurope/Astrakhan\nEurope/Athens\nEurope/Belgrade\nEurope/Berlin\nEurope/Bratislava\nEurope/Brussels\nEurope/Bucharest\nEurope/Budapest\nEurope/Busingen\nEurope/Chisinau\nEurope/Copenhagen\nEurope/Dublin\nEurope/Gibraltar\nEurope/Guernsey\nEurope/Helsinki\nEurope/Isle_of_Man\nEurope/Istanbul\nEurope/Jersey\nEurope/Kaliningrad\nEurope/Kiev\nEurope/Kirov\nEurope/Lisbon\nEurope/Ljubljana\nEurope/London\nEurope/Luxembourg\nEurope/Madrid\nEurope/Malta\nEurope/Mariehamn\nEurope/Minsk\nEurope/Monaco\nEurope/Moscow\nEurope/Oslo\nEurope/Paris\nEurope/Podgorica\nEurope/Prague\nEurope/Riga\nEurope/Rome\nEurope/Samara\nEurope/San_Marino\nEurope/Sarajevo\nEurope/Saratov\nEurope/Simferopol\nEurope/Skopje\nEurope/Sofia\nEurope/Stockholm\nEurope/Tallinn\nEurope/Tirane\nEurope/Ulyanovsk\nEurope/Uzhgorod\nEurope/Vaduz\nEurope/Vatican\nEurope/Vienna\nEurope/Vilnius\nEurope/Volgograd\nEurope/Warsaw\nEurope/Zagreb\nEurope/Zaporozhye\nEurope/Zurich\nIndian/Antananarivo\nIndian/Chagos\nIndian/Christmas\nIndian/Cocos\nIndian/Comoro\nIndian/Kerguelen\nIndian/Mahe\nIndian/Maldives\nIndian/Mauritius\nIndian/Mayotte\nIndian/Reunion\nPacific/Apia\nPacific/Auckland\nPacific/Bougainville\nPacific/Chatham\nPacific/Chuuk\nPacific/Easter\nPacific/Efate\nPacific/Enderbury\nPacific/Fakaofo\nPacific/Fiji\nPacific/Funafuti\nPacific/Galapagos\nPacific/Gambier\nPacific/Guadalcanal\nPacific/Guam\nPacific/Honolulu\nPacific/Kiritimati\nPacific/Kosrae\nPacific/Kwajalein\nPacific/Majuro\nPacific/Marquesas\nPacific/Midway\nPacific/Nauru\nPacific/Niue\nPacific/Norfolk\nPacific/Noumea\nPacific/Pago_Pago\nPacific/Palau\nPacific/Pitcairn\nPacific/Pohnpei\nPacific/Port_Moresby\nPacific/Rarotonga\nPacific/Saipan\nPacific/Tahiti\nPacific/Tarawa\nPacific/Tongatapu\nPacific/Wake\nPacific/Wallis\n
","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}},"urlObject":{"path":["oauth","api","v1","server","{server.id}"],"host":["https://my.gridpane.com"],"query":[],"variable":[]}},"response":[{"id":"44c5201c-4edd-4c49-b603-1ae812f4b66e","name":"Update Server Timezone to EST - America/Detroit locale","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"server_timezone\": \"America/Detroit\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/server/1"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"48df9166-eb32-4b94-9a7e-adb1c624cfc1"},{"name":"update security update settings","id":"ecb60a67-c774-4553-9311-19e60194a94a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","type":"text","value":"Bearer {{oath_token}}"}],"body":{"mode":"raw","raw":"{\r\n \"security_updates_reboot\": {boolean},\r\n \"security_updates_reboot_time\": \"{string}\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/server/{server.id}","description":"

Update server security updates reboot settings by using server id as url parameter

\n

security_updates_reboot - boolean

\n

security_updates_reboot can have the following values:
true||false

\n

security_updates_reboot_time - string

\n

security_updates_reboot_time can have the following value:
24 hour time, excluding seconds, colon separated hours and minues
e.g. 02:30

\n
Note:
\n

Either or both values can be passed, however if security_updates_reboot is currently set to false,
then updating it's reboot time will also enable security reboots.

\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}},"urlObject":{"path":["oauth","api","v1","server","{server.id}"],"host":["https://my.gridpane.com"],"query":[],"variable":[]}},"response":[{"id":"2ffe265f-85b9-4d20-838a-02d82195abe7","name":"enable security updates and set security reboot to 4am","originalRequest":{"method":"PUT","header":[{"key":"Authorization","type":"text","value":"Bearer {{oath_token}}"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"security_updates_reboot_time\": \"04:00\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/server/1"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"ecb60a67-c774-4553-9311-19e60194a94a"},{"name":"update server from v1 backups to v2 backups system","id":"6c9c8f84-3206-4e7b-a09d-923ae3c41fe9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","type":"text","value":"Bearer {{oath_token}}"}],"body":{"mode":"raw","raw":"{\r\n \"update_backups_system\": {boolean},\r\n \"enable_site_local_backups\": {boolean}\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/server/{server.id}","description":"

Update server from backups v1 system to backups v2 system

\n

update_backups_system - boolean

\n

update_backups_system can have the following values:
true

\n

enable_site_local_backups - boolean

\n

If passed true then once the system has been updated to backups v2 it will enable local automated backups on an hourly schedule set to midnight.

\n

enable_site_local_backups can have the following values:
true

\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}},"urlObject":{"path":["oauth","api","v1","server","{server.id}"],"host":["https://my.gridpane.com"],"query":[],"variable":[]}},"response":[{"id":"80293efc-02db-4c97-86bb-7eb38e5458f3","name":"update server backups system to v2 and enable automatic local backups for all sites on the server","originalRequest":{"method":"PUT","header":[{"key":"Authorization","type":"text","value":"Bearer {{oath_token}}"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"update_backups_system\": true,\r\n \"enable_site_local_backups\": true\r\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/server/1"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"6c9c8f84-3206-4e7b-a09d-923ae3c41fe9"},{"name":"create a new custom server","id":"fc3b95e7-3fcf-4b14-a34e-a85d9f4a9080","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"}],"body":{"mode":"raw","raw":"{ \n \"name\":\"{string}\", \n \"ip\":\"{string}\", \n \"datacenter\":\"{string}\", \n \"webserver\":\"{string}\", \n \"database\":\"{string}\" \n}\n","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/server/custom","description":"

Create a new custom server in the GridPane App

\n

name - string - required

\n

The label/hostname for your server.

\n

ip - string - required

\n

Accepte ipv4 only.

\n

datacenter - string - required

\n

Provide the datacenter or other string you wish to associate with the server.

\n

webserver - string - required

\n

Provide the webserver you wish to build the server with.

\n

Accepts nginx or openlitespeed

\n

database - string - required

\n

Provide the database you wish to build the server with.

\n

Accepts percona or mariadb

\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}},"urlObject":{"path":["oauth","api","v1","server","custom"],"host":["https://my.gridpane.com"],"query":[],"variable":[]}},"response":[{"id":"b075b452-e07a-4394-a184-df0540d22b70","name":"create a new custom server","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{ \n \"servername\":\"hal9000\", \n \"ip\":\"199.199.199.199\", \n \"datacenter\":\"space-station-v\", \n \"webserver\":\"nginx\", \n \"database\":\"percona\" \n}\n","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/server/custom"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"instructions\": \"You will need to provision a BRAND NEW KVM virtualized VPS or bare metal server with only a standard Ubuntu 18.04 LTS image installed. Once initial provisioning is complete at the provider, log in to your server via console or SSH and run the following command as ROOT. The process will take about 15 minutes to complete!\",\n \"command\": \"wget -O gridpane-me.sh 'https://my.gridpane.com/provision/gridpane-me.sh'; bash gridpane-me.sh 'my.gridpane.com' c34c30a3-69c4-406e-b978-bb6da2985730\",\n \"server_id\": 2001\n}\n"}],"_postman_id":"fc3b95e7-3fcf-4b14-a34e-a85d9f4a9080"},{"name":"create a new digital ocean server","id":"0e0dd5b7-3e2c-421b-b557-6fcc22392d0a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"integration_id\":{integer},\n \"name\":\"{string}\",\n \"region_id\":\"{string}\",\n \"plan_id\":\"{string}\",\n \"webserver\":\"{string}\",\n \"database\":\"{string}\",\n \"enable_auto_backups\": {boolean},\n \"blueprint_id\": {integer} \n}\n","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/server/digitalocean","description":"

Create a new Digital Ocean server in the GridPane App

\n

integration_id - integer - required

\n

The ID of the Digital Ocean integration attached to the account that you wish to use.

\n

Can be found using GET current user integrations

\n

name - string - required

\n

The label/hostname for your server.

\n

region_id - string - required

\n

The region id for your server specifies which Digital Ocean datacenter to build your server in.

\n

Can be found using GET Digital Ocean server plans

\n

plan_id - string - required

\n

The plan id for your server specifies the server you want to build according to available Digital Ocean server plans.

\n

Can be found using GET Digital Ocean server plans

\n

webserver - string - required

\n

Provide the webserver you wish to build the server with.

\n

Accepts nginx or openlitespeed

\n

database - string - required

\n

Provide the database you wish to build the server with.

\n

Accepts percona or mariadb

\n

enable_auto_backups - boolean - optional

\n

Do you want to enable backups at Digital Ocean for this server

\n

Accepts true or false

\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}},"urlObject":{"path":["oauth","api","v1","server","digitalocean"],"host":["https://my.gridpane.com"],"query":[],"variable":[]}},"response":[{"id":"254e6ee2-8868-4a7b-ac05-2625f5ecf163","name":"create a new digital ocean server","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"integration_id\":42,\n \"name\":\"life-squared\",\n \"region_id\":\"nyc1\",\n \"plan_id\":\"s-2vcpu-2gb-amd\",\n \"webserver\":\"nginx\",\n \"database\":\"percona\",\n \"enable_auto_backups\": true \n}\n","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/server/digitalocean"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"server_id\": 1764,\n \"building\": {\n \"integration_id\": 42,\n \"provider\": \"digitalocean\",\n \"name\": \"life-squared\",\n \"region_id\": \"nyc1\",\n \"plan_id\": \"s-2vcpu-2gb-amd\",\n \"webserver\": \"nginx\",\n \"database\": \"percona\",\n \"enable_auto_backups\": true\n },\n \"build_status\": \"Preparing to initiate build... waiting for ready callback from server!\",\n \"temp_pass\": \"LpdvsJCA2u8E6Rc\"\n}\n\n"}],"_postman_id":"0e0dd5b7-3e2c-421b-b557-6fcc22392d0a"},{"name":"create a new vultr server","id":"6b99e38a-1815-4161-bb94-89adb97b6017","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"integration_id\":{integer},\n \"name\":\"{string}\",\n \"region_id\":\"{string}\",\n \"plan_id\":\"{string}\",\n \"webserver\":\"{string}\",\n \"database\":\"{string}\",\n \"enable_auto_backups\": {boolean},\n \"blueprint_id\": {integer} \n}\n","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/server/vultr","description":"

Create a new Vultr server in the GridPane App

\n

integration_id - integer - required

\n

The ID of the Vultr integration attached to the account that you wish to use.

\n

Can be found using GET current user integrations

\n

name - string - required

\n

The label/hostname for your server.

\n

region_id - string - required

\n

The region id for your server specifies which Digital Ocean datacenter to build your server in.

\n

Can be found using GET Vultr server plans

\n

plan_id - string - required

\n

The plan id for your server specifies the server you want to build according to available Vultr server plans.

\n

Can be found using GET Vultr server plans

\n

webserver - string - required

\n

Provide the webserver you wish to build the server with.

\n

Accepts nginx or openlitespeed

\n

database - string - required

\n

Provide the database you wish to build the server with.

\n

Accepts percona or mariadb

\n

enable_auto_backups - boolean - optional

\n

Do you want to enable backups at Vultr for this server

\n

Accepts true or false

\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}},"urlObject":{"path":["oauth","api","v1","server","vultr"],"host":["https://my.gridpane.com"],"query":[],"variable":[]}},"response":[{"id":"4b0df32a-9072-4d9c-a3dc-02b84628eb3c","name":"create a new vultr server","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"integration_id\":42,\n \"name\":\"life-squared\",\n \"region_id\":\"5\",\n \"plan_id\":\"401\",\n \"webserver\":\"nginx\",\n \"database\":\"percona\",\n \"enable_auto_backups\": true \n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/server/vultr"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"server_id\": 1764,\n \"building\": {\n \"integration_id\": 42,\n \"provider\": \"vultr\",\n \"name\": \"life-squared\",\n \"region_id\": \"5\",\n \"plan_id\": \"401\",\n \"webserver\": \"nginx\",\n \"database\": \"percona\",\n \"enable_auto_backups\": true\n },\n \"build_status\": \"Preparing to initiate build... waiting for ready callback from server!\",\n \"temp_pass\": \"LpdvsJCA2u8E6Rc\"\n}\n"}],"_postman_id":"6b99e38a-1815-4161-bb94-89adb97b6017"},{"name":"create a new linode server","id":"cb6a5da8-fbba-497e-b7c6-90558949b4e0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"integration_id\":{integer},\n \"name\":\"{string}\",\n \"region_id\":\"{string}\",\n \"plan_id\":\"{string}\",\n \"webserver\":\"{string}\",\n \"database\":\"{string}\",\n \"enable_auto_backups\": {boolean},\n \"blueprint_id\": {integer} \n}\n","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/server/linode","description":"

Create a new Linode server in the GridPane App

\n

integration_id - integer - required

\n

The ID of the Linode integration attached to the account that you wish to use.

\n

Can be found using GET current user integrations

\n

name - string - required

\n

The label/hostname for your server.

\n

region_id - string - required

\n

The region id for your server specifies which Digital Ocean datacenter to build your server in.

\n

Can be found using GET Linode server plans

\n

plan_id - string - required

\n

The plan id for your server specifies the server you want to build according to available Linode server plans.

\n

Can be found using GET Linode server plans

\n

webserver - string - required

\n

Provide the webserver you wish to build the server with.

\n

Accepts nginx or openlitespeed

\n

database - string - required

\n

Provide the database you wish to build the server with.

\n

Accepts percona or mariadb

\n

enable_auto_backups - boolean - optional

\n

Do you want to enable backups at Linode for this server

\n

Accepts true or false

\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}},"urlObject":{"path":["oauth","api","v1","server","linode"],"host":["https://my.gridpane.com"],"query":[],"variable":[]}},"response":[{"id":"6022e305-41f4-41f8-a7fc-41f6e3efb814","name":"create a new linode","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"integration_id\":42,\n \"name\":\"life-squared\",\n \"region_id\":\"us-west\",\n \"plan_id\":\"g6-standard-4\",\n \"webserver\":\"nginx\",\n \"database\":\"percona\",\n \"enable_auto_backups\": true \n}\n","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/server/linode"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"server_id\": 1764,\n \"building\": {\n \"integration_id\": 42,\n \"provider\": \"linode\",\n \"name\": \"life-squared\",\n \"region_id\": \"us-west\",\n \"plan_id\": \"g6-standard-4\",\n \"webserver\": \"nginx\",\n \"database\": \"percona\",\n \"enable_auto_backups\": true\n },\n \"build_status\": \"Preparing to initiate build... waiting for ready callback from server!\",\n \"temp_pass\": \"LpdvsJCA2u8E6Rc\"\n}\n"}],"_postman_id":"cb6a5da8-fbba-497e-b7c6-90558949b4e0"},{"name":"create a new aws-lightsail server","id":"0835e89d-6d78-4edf-b265-4dc07481e021","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"integration_id\":{integer},\n \"name\":\"{string}\",\n \"region_id\":\"{string}\",\n \"plan_id\":\"{string}\",\n \"webserver\":\"{string}\",\n \"database\":\"{string}\",\n \"enable_auto_backups\": {boolean},\n \"blueprint_id\": {integer} \n}\n","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/server/aws-lightsail","description":"

Create a new AWS Lightsail server in the GridPane App

\n

integration_id - integer - required

\n

The ID of the AWS integration attached to the account that you wish to use.

\n

Can be found using GET current user integrations

\n

name - string - required

\n

The label/hostname for your server.

\n

region_id - string - required

\n

The region id for your server specifies which AWS datacenter to build your server in.

\n

Can be found using GET Linode server plans

\n

plan_id - string - required

\n

The plan id for your server specifies the server you want to build according to available AWS server plans.

\n

Can be found using GET AWS server plans

\n

webserver - string - required

\n

Provide the webserver you wish to build the server with.

\n

Accepts nginx or openlitespeed

\n

database - string - required

\n

Provide the database you wish to build the server with.

\n

Accepts percona or mariadb

\n

enable_auto_backups - boolean - optional

\n

Do you want to enable backups at AWS for this server

\n

Accepts true or false

\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}},"urlObject":{"path":["oauth","api","v1","server","aws-lightsail"],"host":["https://my.gridpane.com"],"query":[],"variable":[]}},"response":[{"id":"39c5ec0b-3d65-44be-8586-3ed3f96e71c8","name":"create a new upcloud instance","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"integration_id\":42,\n \"name\":\"life-squared\",\n \"region_id\":\"uk-lon1\",\n \"plan_id\":\"1xCPU-2GB\",\n \"webserver\":\"nginx\",\n \"database\":\"percona\",\n \"size\":\"50\"\n}\n","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/server/aws-lightsail"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"server_id\": 1764,\n \"building\": {\n \"integration_id\": 42,\n \"provider\": \"upcloud\",\n \"name\": \"life-squared\",\n \"region_id\": \"uk-lon1\",\n \"plan_id\": \"1xCPU-2GB\",\n \"webserver\": \"nginx\",\n \"database\": \"percona\",\n \"enable_auto_backups\": false,\n \"size\": \"50\"\n },\n \"build_status\": \"Preparing to initiate build... waiting for ready callback from server!\",\n \"temp_pass\": \"LpdvsJCA2u8E6Rc\"\n}\n"}],"_postman_id":"0835e89d-6d78-4edf-b265-4dc07481e021"},{"name":"create a new upcloud server","id":"e82c56bf-e9eb-42ef-844d-f81c4a71002e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"integration_id\":{integer},\n \"name\":\"{string}\",\n \"region_id\":\"{string}\",\n \"plan_id\":\"{string}\",\n \"webserver\":\"{string}\",\n \"database\":\"{string}\",\n \"blueprint_id\": {integer} \n}\n","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/server/upcloud","description":"

Create a new UpCloud server in the GridPane App

\n

integration_id - integer - required

\n

The ID of the UpCloud integration attached to the account that you wish to use.

\n

Can be found using GET current user integrations

\n

name - string - required

\n

The label/hostname for your server.

\n

region_id - string - required

\n

The region id for your server specifies which UpCloud datacenter to build your server in.

\n

Can be found using GET Linode server plans

\n

plan_id - string - required

\n

The plan id for your server specifies the server you want to build according to available UpCloud server plans.

\n

Can be found using GET UpCloud server plans

\n

webserver - string - required

\n

Provide the webserver you wish to build the server with.

\n

Accepts nginx or openlitespeed

\n

database - string - required

\n

Provide the database you wish to build the server with.

\n

Accepts percona or mariadb

\n

size - string - required

\n

Provide the storage_size for the selected plan.

\n

Can be found using GET UpCloud server plans

\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}},"urlObject":{"path":["oauth","api","v1","server","upcloud"],"host":["https://my.gridpane.com"],"query":[],"variable":[]}},"response":[{"id":"c73e72a7-b535-40e9-a6dc-fdb03023c603","name":"create a new aws-lightsail instance","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"integration_id\":42,\n \"name\":\"life-squared\",\n \"region_id\":\"us-west\",\n \"plan_id\":\"g6-standard-4\",\n \"webserver\":\"nginx\",\n \"database\":\"percona\",\n \"enable_auto_backups\": true \n}\n","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/server/aws-lightsail"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"server_id\": 1764,\n \"building\": {\n \"integration_id\": 42,\n \"provider\": \"aws\",\n \"name\": \"life-squared\",\n \"region_id\": \"us-east-1\",\n \"plan_id\": \"small_2_0\",\n \"webserver\": \"nginx\",\n \"database\": \"percona\",\n \"enable_auto_backups\": true\n },\n \"build_status\": \"Preparing to initiate build... waiting for ready callback from server!\",\n \"temp_pass\": \"LpdvsJCA2u8E6Rc\"\n}\n"}],"_postman_id":"e82c56bf-e9eb-42ef-844d-f81c4a71002e"},{"name":"delete server by ID","id":"8a0962d0-0f15-4d31-aec6-049bcd7ca4a9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"}],"url":"https://my.gridpane.com/oauth/api/v1/server/{server.id}","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}},"urlObject":{"path":["oauth","api","v1","server","{server.id}"],"host":["https://my.gridpane.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"8a0962d0-0f15-4d31-aec6-049bcd7ca4a9"}],"id":"f308d543-921c-462d-8299-7d92ba406645","_postman_id":"f308d543-921c-462d-8299-7d92ba406645","description":"","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}}},{"name":"site","item":[{"name":"get sites list","id":"f69f26b8-a44e-44cf-815d-cb49885bfa93","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"}],"url":"https://my.gridpane.com/oauth/api/v1/site","description":"

Request for all sites belonging to User.

\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}},"urlObject":{"path":["oauth","api","v1","site"],"host":["https://my.gridpane.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"f69f26b8-a44e-44cf-815d-cb49885bfa93"},{"name":"get single site","id":"d36ed289-3e5d-4ad9-b018-47018072eb67","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"}],"url":"https://my.gridpane.com/oauth/api/v1/site/{site.id}","description":"

Request for individual site data

\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}},"urlObject":{"path":["oauth","api","v1","site","{site.id}"],"host":["https://my.gridpane.com"],"query":[],"variable":[]}},"response":[{"id":"ea57f953-d8d7-4a2e-be42-06808b4a0862","name":"get single site by site id in requet url","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"}],"url":"https://my.gridpane.com/oauth/api/v1/site/1"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"d36ed289-3e5d-4ad9-b018-47018072eb67"},{"name":"create a new site","id":"8b5156be-753b-4beb-811a-69108d29cc01","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"url\": \"{string}\",\n \"server_id\": {integer},\n \"bundle_id\": {integer},\n \"php_version\": \"{string}\",\n \"pm\": \"{string}\",\n \"nginx_caching\": \"{string}\",\n \"system_user_id\": {integer},\n \"username\": \"{string}\",\n \"waf\": \"{string}\",\n \"smtp\": {integer},\n \"dns_integration_id\": {integer},\n \"dns_management\": \"{string}\",\n \"wp_users\": [\n {\n \"username\": \"{string}\",\n \"email\": \"{string}\",\n \"password\": \"{string}\",\n \"role\": \"{string}\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/site","description":"

Create a new site on a GridPane server.

\n

url - string- required

\n

The domain of the WordPress site.
This will be created in the domains table and attached to the site as the primary domain.

\n

server_id - integer - required

\n

The id of the server on which to build the site.

\n

php_version - string - required

\n

Accepted versions: 7.2 7.3 7.4

\n

pm - string - required

\n

PHP-FPM process management\nAccepted values: dynamic static ondemand

\n

nginx_caching - string - required

\n

Nginx Page caching\nAccepted values: redis fastcgi none

\n

system_user_id - integer || username - string :: required

\n

Either username or system_user_id is required.
If you enter both a system_user_id and username that do not match, the request will error.

\n

system_user_id:
A valid system user id from the server to set as the site owner.

\n

username can be:

\n
    \n
  1. The username of an existing system user on the server to which to assign site ownership
    2. \n
  2. A new user to create on the server and to whom the site ownership shall be assigned.
    3. \n
\n

waf - string - optional

\n

The WAF to enable on the site.\nAccepted values: 6G 7G modsec

\n

smtp - integer - optional

\n

The integration ID of the SMTP integration to set up on the site.

\n

Use the GET /user/integration to find your available smtp integration ids.

\n

dns_integration_id - integer - optional

\n

The integration ID of the DNS integration to set use to manage the site domain DNS.

\n

Use the GET /user/integration to find your available DNS integration ids.

\n

dns_management - string - required IF

\n

Required IF dns_integration_id is passed

\n

The DNS Integration to enable for the site primary domain.\nAccepted values:

\n
    \n
  • dnsme_full
    • \n
  • dnsme_challenge
    • \n
  • cloudflare_full
    • \n
  • cloudflare_challenge
    • \n
\n

wp_users - json array with user objects - optional

\n

An array of json objects each containing a wp_user to add.
This array can contain up to 5 users to add to the site on build.
Each user object can/should contain the following key:values:
username - string - required
The username of the user to add.
email - string - required
The email of the user to add.
password - string - optional
An optional password for the user.
If no password is provided an autogenerated password will be used.
role - string - required
The role of the user. The following standard roles can be used:
-primary_administrator
-administrator
-editor
-contributor
-subscriber
If contained in the request, the user with the role of primary_administrator will be added as a WordPress administrator and will be set as the primary administrator for the purposes of GridPane functionality.
If no primary_administrator is found then GridPane will continue to add the default WP Admin from the users settings as the primary administrator for the site. \nIf more than 5 users are contained in the array, the system will prioritise the users based on role heirarchy first, with secondary priority going to position in the request array.

\n

bundle_id - integer - optional

\n

The id of the bundle that will be used to build the site.

\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}},"urlObject":{"path":["oauth","api","v1","site"],"host":["https://my.gridpane.com"],"query":[],"variable":[]}},"response":[{"id":"47615410-100d-4c63-b2e8-61ef5f96358f","name":"create site and assign to existing user by system-user id","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"url\": \"awesome.site\",\n \"server_id\": 1,\n \"php_version\": \"7.3\",\n \"pm\": \"dynamic\",\n \"nginx_caching\": \"redis\",\n \"system_user_id\": 999, \n \"waf\": \"7G\"\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/site"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"df4250ee-db7b-4e5a-9acf-bd06c928d642","name":"create site and assign to user by username (optionally create new user)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"url\": \"wicked.website\",\n \"server_id\": 1,\n \"php_version\": \"7.3\",\n \"pm\": \"static\",\n \"nginx_caching\": \"fastcgi\",\n \"username\": \"new-user-name\", \n \"waf\": \"modsec\"\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/site"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"dad00629-2e22-4cf7-8898-d052f68f11de","name":"create a new site with 3 users including a primary admin","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"url\": \"another.site\",\n \"server_id\": 1,\n \"php_version\": \"7.4\",\n \"pm\": \"dynamic\",\n \"nginx_caching\": \"redis\",\n \"username\": \"uniqueuser\",\n \"waf\": \"7G\",\n \"ssl\": \"primary-ssl\",\n \"wp_users\": [\n {\n \"username\": \"anakin\",\n \"email\": \"anakin@vader.com\",\n \"password\": \"DisappointedWithEveryonesLackOfFaith\",\n \"role\": \"primary_administrator\"\n },\n {\n \"username\": \"Obi\",\n \"email\": \"OB1@kenobi.com\",\n \"password\": \"IHaveYetToExperienceLuck\",\n \"role\": \"administrator\"\n },\n {\n \"username\": \"Akbar\",\n \"email\": \"Adm.Akbar@fleet.com\",\n \"password\": \"IWonderIfItsATrap\",\n \"role\": \"editor\"\n }\n ]\n}\n","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/site"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"178bd10a-084a-4497-bb72-79df5a1c6905","name":"create site and assign to user by username (optionally create new user) Copy","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"url\": \"wicked.website\",\n \"server_id\": 1,\n \"php_version\": \"7.3\",\n \"pm\": \"static\",\n \"nginx_caching\": \"fastcgi\",\n \"username\": \"new-user-name\", \n \"waf\": \"modsec\",\n \"smtp\": 42,\n \"dns_management\": \"dnsme_full\", \n \"dns_integration_id\": 2001 \n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/site"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"42f8688b-dfcb-46ee-b2c1-e8c7f5f6cdb1","name":"create a new site with bundle","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"url\": \"wicked.website\",\n \"server_id\": 1,\n \"bundle_id\": 8,\n \"php_version\": \"7.3\",\n \"pm\": \"static\",\n \"nginx_caching\": \"fastcgi\",\n \"username\": \"new-user-name\", \n \"waf\": \"modsec\"\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/site"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"8b5156be-753b-4beb-811a-69108d29cc01"},{"name":"change site system user","id":"7e760467-bcbf-4f83-a0db-462c245a3399","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","type":"text","value":"Bearer {{oath_token}}"}],"body":{"mode":"raw","raw":"{\n \"system_user_id\": {integer},\n \"username\": \"{string}\"\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/site/{site.id}","description":"

Change the server system user that owns a GridPane site

\n

system_user_id - integer || username - string

\n

Either username or system_user_id must be passed.
If you enter both a system_user_id and username that do not match, the request will error.

\n

system_user_id:\nA valid system user.id from the server to set as the site owner

\n

username:\nThe username from a valid system user on the server to set as the site owner.

\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}},"urlObject":{"path":["oauth","api","v1","site","{site.id}"],"host":["https://my.gridpane.com"],"query":[],"variable":[]}},"response":[{"id":"0188c49b-6931-4263-bf4c-69de0105286b","name":"update site system-user owner by username","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"username\": \"rasputin\"\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/site/{site.id}"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"9bbc72ae-d6a4-482c-8e73-d12cbca2d535","name":"change site system user owner by system-user id","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"system_user_id\": 1\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/site/{site.id}"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"7e760467-bcbf-4f83-a0db-462c245a3399"},{"name":"change site php version","id":"fcd14d11-7529-482a-971d-f18223787b9b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"php_version\": \"{string}\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/site/{site.id}","description":"

Change php version of site using site id as url parameter

\n

php_version - string

\n

php_version can have the following values: 7.2, 7.3, 7.4

\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}},"urlObject":{"path":["oauth","api","v1","site","{site.id}"],"host":["https://my.gridpane.com"],"query":[],"variable":[]}},"response":[{"id":"0f0eaa9e-8aed-403c-9aa7-77b9ab43f035","name":"change site php version to PHP7.4","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"php_version\": \"7.4\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/site/1"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"fcd14d11-7529-482a-971d-f18223787b9b"},{"name":"change site php-fpm process manager","id":"598e9324-a06b-4df6-8fde-a378c15e3d5e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","type":"text","value":"Bearer {{oath_token}}"}],"body":{"mode":"raw","raw":"{\r\n \"pm\": \"{string}\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/site/{site.id}","description":"

Change php-fpm site pool process manager - set how the php-fpm process manager handles workers.

\n

pm - string

\n

pm can accept the following values: static, dynamic, ondemand

\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}},"urlObject":{"path":["oauth","api","v1","site","{site.id}"],"host":["https://my.gridpane.com"],"query":[],"variable":[]}},"response":[{"id":"f5ade0ec-3448-45f2-9685-5f0f4cb7f496","name":"set the PHP-FPM process manager to Static","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"pm\": \"static\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/site/1"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"598e9324-a06b-4df6-8fde-a378c15e3d5e"},{"name":"change site php-fpm process idle timeout","id":"bd747b8c-c5ee-4798-b021-6338e2b7f80b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","type":"text","value":"Bearer {{oath_token}}"}],"body":{"mode":"raw","raw":"{\r\n \"pm_process_idle_timeout\": {integer}\r\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/site/{site.id}","description":"

Change php-fpm site pool process_idle_timeout - The number of seconds after which an idle process will be killed.
Only used when pm is set to ondemand.

\n

pm_process_idle_timeout - integer

\n

pm_process_idle_timeout accepts integers greater than 0

\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}},"urlObject":{"path":["oauth","api","v1","site","{site.id}"],"host":["https://my.gridpane.com"],"query":[],"variable":[]}},"response":[{"id":"f18b07b0-787f-408b-bb0d-0cb2f9541f67","name":"set PHP-FPM to kill any idle worker process after 10 seconds when process management is set to Ondemand","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"pm_process_idle_timeout\": 10\r\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/site/1"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"bd747b8c-c5ee-4798-b021-6338e2b7f80b"},{"name":"change site php-fpm max children","id":"edb15840-fea9-424f-ae83-866dba7ebae3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","type":"text","value":"Bearer {{oath_token}}"}],"body":{"mode":"raw","raw":"{\r\n \"pm_max_children\": {integer}\r\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/site/{site.id}","description":"

Change php-fpm site pool max_children - the maximum number of PHP workers the PHP-FPM process manager has access to.

\n

pm_max_children - integer

\n

pm_max_children accepts integers greater than 0
If pm is dynamic then pm_max_children must be greater than or equal to pm_max_spare_servers
If pm is dynamic then pm_max_children must be greater than or equal to pm_min_spare_servers
If pm is dynamic then pm_max_children must be greater than or equal to pm_start_servers

\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}},"urlObject":{"path":["oauth","api","v1","site","{site.id}"],"host":["https://my.gridpane.com"],"query":[],"variable":[]}},"response":[{"id":"b69adc60-e766-4245-b38e-d7b7f3a00140","name":"set the maximum number of PHP-FPM workers to 32","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"pm_max_children\": 32\r\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/site/1"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"edb15840-fea9-424f-ae83-866dba7ebae3"},{"name":"change site php-fpm max requests","id":"59b994bf-2ac5-4886-ab30-1aef8bd5e665","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","type":"text","value":"Bearer {{oath_token}}"}],"body":{"mode":"raw","raw":"{\r\n \"pm_max_requests\": {integer}\r\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/site/{site.id}","description":"

Change php-fpm site pool max_requests - the number of requests each child process should execute before respawning.

\n

pm_max_requests - integer

\n

pm_max_requests accepts integers greater than 0

\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}},"urlObject":{"path":["oauth","api","v1","site","{site.id}"],"host":["https://my.gridpane.com"],"query":[],"variable":[]}},"response":[{"id":"4c6e5eda-bdb0-4d50-b464-a6ccf976c9d6","name":"set PHP-FPM to kill a worker process after handling 500 requests","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"pm_max_requests\": 500\r\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/site/1"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"59b994bf-2ac5-4886-ab30-1aef8bd5e665"},{"name":"change site php-fpm max spare servers","id":"f25a581f-92b4-40e6-8e03-ef025e5f1fd4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","type":"text","value":"Bearer {{oath_token}}"}],"body":{"mode":"raw","raw":"{\r\n \"pm_max_spare_servers\": {integer}\r\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/site/{site.id}","description":"

Change php-fpm site pool max_spare_servers - the maximum number of php workers in idle state.
Only used when pm set to dynamic.

\n

pm_max_spare_servers - integer

\n

pm_max_spare_servers accepts integers greater than 0
pm_max_spare_servers must be greater than or equal to pm_min_spare_servers
pm_max_spare_servers must be greater than or equal to pm_start_servers
pm_max_spare_servers must be less than or equal to pm_max_children

\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}},"urlObject":{"path":["oauth","api","v1","site","{site.id}"],"host":["https://my.gridpane.com"],"query":[],"variable":[]}},"response":[{"id":"cfcafbaf-8973-42b0-bf41-1a97571c1416","name":"set PHP-FPM to maintain a maximum of 2 idle workers when Process Management is set to Dynamic","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"pm_max_spare_servers\": 2\r\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/site/1"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"f25a581f-92b4-40e6-8e03-ef025e5f1fd4"},{"name":"change site php-fpm min spare servers","id":"992e637d-a53c-4d3a-8beb-5c7e2727a17b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","type":"text","value":"Bearer {{oath_token}}"}],"body":{"mode":"raw","raw":"{\r\n \"pm_min_spare_servers\": {integer}\r\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/site/{site.id}","description":"

Change php-fpm site pool min_spare_servers - the minimum number of php workers in idle state.
Only used when pm set to dynamic.

\n

pm_min_spare_servers - integer

\n

pm_min_spare_servers accepts integers greater than 0
pm_min_spare_servers must be less than or equal to pm_max_spare_servers
pm_min_spare_servers must be less than or equal to pm_start_servers
pm_min_spare_servers must be less than or equal to pm_max_children

\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}},"urlObject":{"path":["oauth","api","v1","site","{site.id}"],"host":["https://my.gridpane.com"],"query":[],"variable":[]}},"response":[{"id":"83c0cc18-427d-4684-b5c5-0f69d3fbc378","name":"set PHP-FPM to maintain a minimum of 2 idle workers when Process Management is set to Dynamic","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"pm_min_spare_servers\": 2\r\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/site/1"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"992e637d-a53c-4d3a-8beb-5c7e2727a17b"},{"name":"change site php-fpm start servers","id":"572b6fa2-ef3a-4df9-8b0a-9e72061ea75d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","type":"text","value":"Bearer {{oath_token}}"}],"body":{"mode":"raw","raw":"{\r\n \"pm_start_servers\": {integer}\r\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/site/{site.id}","description":"

Change php-fpm site pool start_servers - the number of workers created on startup.
Only used when pm set to dynamic.

\n

pm_start_servers - integer

\n

pm_start_servers accepts integers greater than 0
pm_start_servers must be less than or equal to pm_max_spare_servers
pm_start_servers must be greater than or equal to pm_min_spare_servers
pm_start_servers must be less than or equal to pm_max_children

\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}},"urlObject":{"path":["oauth","api","v1","site","{site.id}"],"host":["https://my.gridpane.com"],"query":[],"variable":[]}},"response":[{"id":"acc88723-c4ab-484c-8bc9-e9edd8b3758c","name":"set PHP-FPM to spawn 2 workers on startup when process management is set to Dynamic","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"pm_start_servers\": 2\r\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/site/1"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"572b6fa2-ef3a-4df9-8b0a-9e72061ea75d"},{"name":"change site php-fpm slowlog timeout","id":"64448785-ac76-4cd3-bb04-f2c81505b881","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","type":"text","value":"Bearer {{oath_token}}"}],"body":{"mode":"raw","raw":"{\r\n \"php_slowlog_timeout\": {integer}\r\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/site/{site.id}","description":"

Change php-fpm site pool request_slowlog_timeout.

\n

php_slowlog_timeout - integer

\n

php_slowlog_timeout accepts positive integers as seconds and 0
0 disables request slow logging.

\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}},"urlObject":{"path":["oauth","api","v1","site","{site.id}"],"host":["https://my.gridpane.com"],"query":[],"variable":[]}},"response":[{"id":"793ace79-8d00-4ebe-b2b8-9b0eb2b8943a","name":"disable PHP-FPM slow logging","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"php_slowlog_timeout\": 0\r\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/site/{site.id}"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"8f9cb27f-91d7-4ece-8dd0-e2fd55702654","name":"enable PHP-FPM slow logging and set the time required to trigger logging to 10 seconds","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"php_slowlog_timeout\": 10\r\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/site/1"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"64448785-ac76-4cd3-bb04-f2c81505b881"},{"name":"change site php-fpm slowlog trace depth","id":"5f76d640-7854-42b4-8a8b-32ab0bbc1c0b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","type":"text","value":"Bearer {{oath_token}}"}],"body":{"mode":"raw","raw":"{\r\n \"php_slowlog_trace_depth\": {integer}\r\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/site/{site.id}","description":"

Change php-fpm site pool request_slowlog_trace_depth.

\n

php_slowlog_trace_depth - integer

\n

php_slowlog_trace_depth accepts positive integers.

\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}},"urlObject":{"path":["oauth","api","v1","site","{site.id}"],"host":["https://my.gridpane.com"],"query":[],"variable":[]}},"response":[{"id":"d25e9a24-235a-4abc-a253-011c61db4f57","name":"set the PHP-FPM slow log stack trace depth to 20","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"php_slowlog_trace_depth\": 20\r\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/site/1"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"5f76d640-7854-42b4-8a8b-32ab0bbc1c0b"},{"name":"change site php ini max_execution_time","id":"8df64329-4fd3-4cc4-bcaf-4308be25e0ab","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","type":"text","value":"Bearer {{oath_token}}"}],"body":{"mode":"raw","raw":"{\r\n \"max_execution_time\": {integer}\r\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/site/{site.id}","description":"

Change site php .user.ini max_execution_time

\n

max_execution_time - integer

\n

max_execution_time accepts integer values as seconds.
0 means unlimited.

\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}},"urlObject":{"path":["oauth","api","v1","site","{site.id}"],"host":["https://my.gridpane.com"],"query":[],"variable":[]}},"response":[{"id":"3ff1ea7a-afd7-4879-9752-7555ee7228cf","name":"set the maximum execution time for a script to 60 seconds","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"max_execution_time\": 60\r\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/site/1"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"8df64329-4fd3-4cc4-bcaf-4308be25e0ab"},{"name":"change site php ini max_file_uploads","id":"02e09b94-7333-4611-bd91-e74ee2499ad0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","type":"text","value":"Bearer {{oath_token}}"}],"body":{"mode":"raw","raw":"{\r\n \"max_file_uploads\": {integer}\r\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/site/{site.id}","description":"

Change site php .user.ini max_file_uploads

\n

max_file_uploads - integer

\n

max_file_uploads accepts integer values as the maximum number of files to uploaded simultaneously.
Accepts positive integers only.

\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}},"urlObject":{"path":["oauth","api","v1","site","{site.id}"],"host":["https://my.gridpane.com"],"query":[],"variable":[]}},"response":[{"id":"dead79e9-a700-463b-bb52-6f787a0433f3","name":"set the maximum number of simultaneous file uploads to 20","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"max_file_uploads\": 20\r\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/site/1"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"02e09b94-7333-4611-bd91-e74ee2499ad0"},{"name":"change site php ini max_input_time","id":"b8a4c381-56e2-4576-a059-78a27817ebcf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","type":"text","value":"Bearer {{oath_token}}"}],"body":{"mode":"raw","raw":"{\r\n \"max_input_time\": {integer}\r\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/site/{site.id}","description":"

Change site php .user.ini max_input_time

\n

max_input_time - integer

\n

max_input_time accepts integer values as number of seconds.
Accepts positive integers, -1 and 0
0 means unlimited
-1 means use max_execution_time instead

\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}},"urlObject":{"path":["oauth","api","v1","site","{site.id}"],"host":["https://my.gridpane.com"],"query":[],"variable":[]}},"response":[{"id":"2462e999-1995-4927-bddd-0cf108febd39","name":"set the maximum input time to 60 seconds","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"max_input_time\": 60\r\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/site/1"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"b8a4c381-56e2-4576-a059-78a27817ebcf"},{"name":"change site php ini max_input_vars","id":"5b269227-5c96-41cb-92d2-44adda31a8a3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","type":"text","value":"Bearer {{oath_token}}"}],"body":{"mode":"raw","raw":"{\r\n \"max_input_vars\": {integer}\r\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/site/{site.id}","description":"

Change site php .user.ini max_input_vars

\n

max_input_vars - integer

\n

max_input_vars accepts integer values as number of allowed input variables.
Only values greater than 0.

\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}},"urlObject":{"path":["oauth","api","v1","site","{site.id}"],"host":["https://my.gridpane.com"],"query":[],"variable":[]}},"response":[{"id":"2644f486-503e-46e1-8a9b-e1907be62313","name":"set the maximum number of input variables to 10000","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"max_input_vars\": 10000\r\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/site/1"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"5b269227-5c96-41cb-92d2-44adda31a8a3"},{"name":"change site php ini memory_limit","id":"9ac892fe-d78f-4b42-a802-1ec246535340","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","type":"text","value":"Bearer {{oath_token}}"}],"body":{"mode":"raw","raw":"{\r\n \"memory_limit\": {integer}\r\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/site/{site.id}","description":"

Change site php .user.ini memory_limit

\n

memory_limit - integer

\n

memory_limit accepts integer values as MB.

\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}},"urlObject":{"path":["oauth","api","v1","site","{site.id}"],"host":["https://my.gridpane.com"],"query":[],"variable":[]}},"response":[{"id":"faf9a43d-aa38-4ab5-ba92-f8b201261ebd","name":"set the memory limit allowed by site scripts to 256MB","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"memory_limit\": 256\r\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/site/1"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"9ac892fe-d78f-4b42-a802-1ec246535340"},{"name":"change site php ini post_max_size","id":"130608d3-c424-4ec3-abc2-96eb77454686","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","type":"text","value":"Bearer {{oath_token}}"}],"body":{"mode":"raw","raw":"{\r\n \"post_max_size\": {integer}\r\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/site/{site.id}","description":"

Change site php .user.ini post_max_size

\n

post_max_size - integer

\n

post_max_size accepts integer values as MB.
Positive integers greater than 0.

\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}},"urlObject":{"path":["oauth","api","v1","site","{site.id}"],"host":["https://my.gridpane.com"],"query":[],"variable":[]}},"response":[{"id":"7090b793-4454-4cc7-8627-7d07426711ef","name":"set the max size of POST data to 256MB","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"post_max_size\": 256\r\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/site/1"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"130608d3-c424-4ec3-abc2-96eb77454686"},{"name":"change site php ini upload_max_filesize","id":"8ffb6b36-e48c-48b6-a720-309057713a87","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","type":"text","value":"Bearer {{oath_token}}"}],"body":{"mode":"raw","raw":"{\r\n \"upload_max_filesize\": {integer}\r\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/site/{site.id}","description":"

Change site php .user.ini upload_max_filesize

\n

upload_max_filesize - integer

\n

upload_max_filesize accepts integer values as MB.
Positive integers greater than 0.

\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}},"urlObject":{"path":["oauth","api","v1","site","{site.id}"],"host":["https://my.gridpane.com"],"query":[],"variable":[]}},"response":[{"id":"7fac7d67-d296-49fd-8484-26cf1eec96c6","name":"restrict file upload size to 50 MB","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"upload_max_filesize\": 50\r\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/site/1"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"8ffb6b36-e48c-48b6-a720-309057713a87"},{"name":"change site php ini session.cookie_lifetime","id":"4e24aa64-029e-4c58-8305-300c4f82ced4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","type":"text","value":"Bearer {{oath_token}}"}],"body":{"mode":"raw","raw":"{\r\n \"session_cookie_lifetime\": {integer}\r\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/site/{site.id}","description":"

Change site php .user.ini session.cookie_lifetime

\n

session_cookie_lifetime - integer

\n

session_cookie_lifetime accepts integer values as seconds.
0 value means until the browser is closed.

\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}},"urlObject":{"path":["oauth","api","v1","site","{site.id}"],"host":["https://my.gridpane.com"],"query":[],"variable":[]}},"response":[{"id":"e137c1fd-2780-49af-ab98-f3ab854ab328","name":"Set session cookie lifetime until the browser is closed","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"session_cookie_lifetime\": 0\r\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/site/1"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"4e24aa64-029e-4c58-8305-300c4f82ced4"},{"name":"change site php ini session.gc_maxlifetime","id":"3f84cf06-fd5c-4fc9-8dca-b6eb38c99212","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","type":"text","value":"Bearer {{oath_token}}"}],"body":{"mode":"raw","raw":"{\r\n \"session_gc_maxlifetime\": {integer}\r\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/site/{site.id}","description":"

Change site php .user.ini session.gc_maxlifetime

\n

session_gc_maxlifetime - integer

\n

session_gc_maxlifetime accepts integer values as seconds.
Only values greater than 0.

\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}},"urlObject":{"path":["oauth","api","v1","site","{site.id}"],"host":["https://my.gridpane.com"],"query":[],"variable":[]}},"response":[{"id":"0a875661-ba27-466f-9571-68cf3f618023","name":"set time in seconds for data garbage collection","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"session_gc_maxlifetime\": 1440\r\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/site/1"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"3f84cf06-fd5c-4fc9-8dca-b6eb38c99212"},{"name":"change site php ini short open tag","id":"79c18282-79eb-4611-b860-7d5c1cd4ae97","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","type":"text","value":"Bearer {{oath_token}}"}],"body":{"mode":"raw","raw":"{\r\n \"short_open_tag\": {boolean}\r\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/site/{site.id}","description":"

Change site php .user.ini short_open_tag - allow the use of <?

\n

short_open_tag - boolean

\n

short_open_tag accepts boolean values true||false

\n

Note - will accept 1||0 but string values are typecast according to truthiness.

\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}},"urlObject":{"path":["oauth","api","v1","site","{site.id}"],"host":["https://my.gridpane.com"],"query":[],"variable":[]}},"response":[{"id":"e802ddd0-3c93-4ad5-8162-5a33541f4d97","name":"enable the use of php short open tags","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"short_open_tag\": \"on\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/site/1"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"79c18282-79eb-4611-b860-7d5c1cd4ae97"},{"name":"change site php configuration - all settings","id":"9e83a749-fed6-4598-be37-c51d92b72588","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","type":"text","value":"Bearer {{oath_token}}"}],"body":{"mode":"raw","raw":"{\r\n \"php_version\": \"{string}\", \r\n \"pm\": \"{string}\", \r\n \"pm_process_idle_timeout\": {integer}, \r\n \"pm_max_children\": {integer}, \r\n \"pm_max_requests\": {integer}, \r\n \"pm_max_spare_servers\": {integer}, \r\n \"pm_min_spare_servers\": {integer}, \r\n \"pm_start_servers\": {integer}, \r\n \"php_slowlog_timeout\": {integer}, \r\n \"php_slowlog_trace_depth\": {integer}, \r\n \"max_execution_time\": {integer},\r\n \"max_file_uploads\": {integer},\r\n \"max_input_time\": {integer},\r\n \"max_input_vars\": {integer},\r\n \"memory_limit\": {integer},\r\n \"post_max_size\": {integer},\r\n \"upload_max_filesize\": {integer},\r\n \"session_cookie_lifetime\": {integer},\r\n \"session_gc_maxlifetime\": {integer},\r\n \"short_open_tag\": {boolean}\r\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/site/{site.id}","description":"

Update sites complete PHP configuration using a single request.

\n

All key:value are optional

\n

Please see individual requests for key:value validation instructions

\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}},"urlObject":{"path":["oauth","api","v1","site","{site.id}"],"host":["https://my.gridpane.com"],"query":[],"variable":[]}},"response":[{"id":"41d5aea6-d2bb-4bb7-bc5f-94821deb296c","name":"enable php-fpm slow logging and adjust slow log trace depth","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"php_slowlog_timeout\": 5, \r\n \"php_slowlog_trace_depth\": 20\r\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/site/1"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"aaa44cb9-5c1b-442e-ba74-1e5913b004ad","name":"change site php version, reconfigure php-fpm dynamic","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"php_version\": \"7.4\", \r\n \"pm\": \"dynamic\", \r\n \"pm_max_children\": 16, \r\n \"pm_max_requests\": 500, \r\n \"pm_max_spare_servers\": 4, \r\n \"pm_min_spare_servers\": 2, \r\n \"pm_start_servers\": 4\r\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/site/1"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"b9a2a90b-3cae-4466-83b4-75e2e4218694","name":"change site php version and restrict php ini values","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"php_version\": \"7.4\", \r\n \"max_execution_time\": 30,\r\n \"max_input_time\": -1,\r\n \"memory_limit\": 256\r\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/site/{site.id}"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"9e83a749-fed6-4598-be37-c51d92b72588"},{"name":"change site WAF configuration - 6G","id":"2408d5ed-4037-4848-a1b1-3d1ac24a11bc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","type":"text","value":"Bearer {{oath_token}}"}],"body":{"mode":"raw","raw":"{\r\n \"six_g_waf\": {boolean}\r\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/site/{site.id}","description":"

Enable/Disable the site 6G WAF

\n

six_g_waf - boolean

\n

six_g_waf accepts boolean values true||false

\n

true - to enable the 6G WAF
false - to disable the 6G WAF

\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}},"urlObject":{"path":["oauth","api","v1","site","{site.id}"],"host":["https://my.gridpane.com"],"query":[],"variable":[]}},"response":[{"id":"a89d2856-e726-4e43-9d94-281aa759bd0d","name":"enable the 6G WAF for a site","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"six_g_waf\": true\r\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/site/1"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"2408d5ed-4037-4848-a1b1-3d1ac24a11bc"},{"name":"change site WAF configuration - 7G","id":"e148643b-5d32-4460-9ff4-4d7b74918c7c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","type":"text","value":"Bearer {{oath_token}}"}],"body":{"mode":"raw","raw":"{\r\n \"seven_g_waf\": {boolean}\r\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/site/{site.id}","description":"

Enable/Disable the site 7G WAF

\n

seven_g_waf - boolean

\n

seven_g_waf accepts boolean values true||false

\n

true - to enable the 7G WAF
false - to disable the 7G WAF

\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}},"urlObject":{"path":["oauth","api","v1","site","{site.id}"],"host":["https://my.gridpane.com"],"query":[],"variable":[]}},"response":[{"id":"70ed9527-7e7e-4684-bc34-f9f6ed800ab2","name":"enable the 7G WAF for a site","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"seven_g_waf\": true\r\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/site/1"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"e148643b-5d32-4460-9ff4-4d7b74918c7c"},{"name":"change site WAF configuration - ModSec","id":"e2f942af-8690-4e05-ac73-88755b9948d1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","type":"text","value":"Bearer {{oath_token}}"}],"body":{"mode":"raw","raw":"{\r\n \"mod_sec_waf\": {boolean}\r\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/site/{site.id}","description":"

Enable/Disable the site ModSec WAF

\n

seven_g_waf - boolean

\n

mod_sec_waf accepts boolean values true||false

\n

true - to enable the ModSec WAF
false - to disable the ModSec WAF

\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}},"urlObject":{"path":["oauth","api","v1","site","{site.id}"],"host":["https://my.gridpane.com"],"query":[],"variable":[]}},"response":[{"id":"4dc50d87-ebf2-4324-b977-716b8ff56209","name":"enable the ModSec WAF for a site","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"mod_sec_waf\": true\r\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/site/1"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"e2f942af-8690-4e05-ac73-88755b9948d1"},{"name":"clone site with the same domain","id":"4c42fc5d-5528-4197-a2d8-dee95fb1bd2e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","type":"text","value":"Bearer {{oath_token}}"}],"body":{"mode":"raw","raw":"{\r\n \"clone_to_server\": {integer}\r\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/site/{site.id}","description":"

Clone a site with the same domain.
This action is only allowed when cloning the site to a different server from the origin.

\n

clone_to_server - integer - required

\n

clone_to_server accepts an integer value as the id of the server you want to create the new domain clone on.

\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}},"urlObject":{"path":["oauth","api","v1","site","{site.id}"],"host":["https://my.gridpane.com"],"query":[],"variable":[]}},"response":[{"id":"01694911-58fd-48da-af9c-c296fd980f81","name":"clone site with the same domain","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"clone_to_server\": 1\r\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/site/1"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"4c42fc5d-5528-4197-a2d8-dee95fb1bd2e"},{"name":"clone site with a new domain","id":"e47cd75c-ba64-4662-a400-05d8f81af2af","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","type":"text","value":"Bearer {{oath_token}}"}],"body":{"mode":"raw","raw":"{\r\n \"clone_to_server\": {integer},\r\n \"new_domain\": \"{string}\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/site/{site.id}","description":"

Clone a site on the same server or to another server with a new domain.

\n

clone_to_server - integer - required

\n

clone_to_server accepts an integer value as the id of the server you want to create the new domain clone on.

\n

new_domain - string - required

\n

new_domain accepts a string value for the new domain.

\n

Do not include the http|https scheme.
Do not include any www host.
staging. and canary. host domains are reserved for system use and not allowed.

\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}},"urlObject":{"path":["oauth","api","v1","site","{site.id}"],"host":["https://my.gridpane.com"],"query":[],"variable":[]}},"response":[{"id":"e80ffff2-9610-4ccd-a8ad-b91699843478","name":"clone site with a new domain","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"clone_to_server\": 1,\r\n \"new_domain\": \"not.the.same.website\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/site/1"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"e47cd75c-ba64-4662-a400-05d8f81af2af"},{"name":"clone over site","id":"9b700fa0-122a-471b-ba49-14f0893110f0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","type":"text","value":"Bearer {{oath_token}}"}],"body":{"mode":"raw","raw":"{\r\n \"clone_to_server\": {integer},\r\n \"new_domain\": \"{string}\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/site/{site.id}","description":"

Clone over a destination site with the current site

\n

clone_over_to_server - integer - required

\n

clone_over_to_server accepts an integer value as the id of the server on which the site you wish to clone over exists

\n

site_id - integer - required

\n

The id of the site that you wish to overwrite with the current site.

\n

include_db_rewrites - boolean - optional

\n

If you do not wish to perform a database search and replace for the destination url with the origin url then send a false value.

\n

Defaults to true

\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}},"urlObject":{"path":["oauth","api","v1","site","{site.id}"],"host":["https://my.gridpane.com"],"query":[],"variable":[]}},"response":[{"id":"a880a4ae-6492-4158-9eab-839533dbf0f2","name":"overwrite site 2 on server 1 with the current site, but do not perform database rewrites of urls.","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"clone_over_to_server\": 1,\r\n \"site_id\": 2,\r\n \"include_db_rewrites\": false\r\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/site/1"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"9b700fa0-122a-471b-ba49-14f0893110f0"},{"name":"enable/disable site basic HTTP authentication","id":"928983e4-1b73-4eed-9e71-1592ad0f2c75","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"http_auth\": {boolean}\r\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/site/{site.id}","description":"

Enable/Disable server level basic authentication for a site using htpasswd.

\n

http_auth - boolean

\n

http_auth accepts the following values: true || false

\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}},"urlObject":{"path":["oauth","api","v1","site","{site.id}"],"host":["https://my.gridpane.com"],"query":[],"variable":[]}},"response":[{"id":"24722567-85fa-4603-9c50-59015bdf8969","name":"Enable server level basic authentication for a site","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"http_auth\": true\r\n}"},"url":"https://my.gridpane.com/oauth/api/v1/site/1"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"928983e4-1b73-4eed-9e71-1592ad0f2c75"},{"name":"enable/disable site nginx page caching","id":"ac8eaa59-51e3-48b3-8b41-6ae6c3b4d2c9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","type":"text","value":"Bearer {{oath_token}}"}],"body":{"mode":"raw","raw":"{\r\n \"nginx_caching\": \"{string}\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/site/{site.id}","description":"

Enable/Disable Nginx Page Caching - either Redis SRCaching or FastCGI Caching

\n

nginx_caching - string

\n

nginx_caching accepts the following string values:

\n
    \n
  • redis - to enable Nginx Redis SRCache Page Caching
    • \n
  • fastcgi - to enable Nginx Fastcgi Page Caching
    • \n
  • none - to disable active Nginx Page Caching
    • \n
\n

note\nAny active page caching needs to be disabled prior to enabling an alternative form of page caching. It is not possible to swap from one type of Nginx page caching directly to the alternative type of Nginx page caching.

\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}},"urlObject":{"path":["oauth","api","v1","site","{site.id}"],"host":["https://my.gridpane.com"],"query":[],"variable":[]}},"response":[{"id":"86f28c72-40ba-4813-b4cb-9aad72d179e9","name":"enable Nginx Redis SRCache Page Caching for a site","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"nginx_caching\": \"redis\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/site/1"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"ac8eaa59-51e3-48b3-8b41-6ae6c3b4d2c9"},{"name":"change site nginx caching ttl with nginx caching","id":"3453aecc-d8aa-40ef-96df-5850021c3a3e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"nginx_caching\": \"{string}\",\r\n \"nginx_caching_ttl\": \"{integer}\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/site/{site.id}","description":"

Change site nginx caching ttl with nginx caching

\n

nginx_caching - string

\n

Enable/Disable Nginx Page Caching - either Redis SRCaching or FastCGI Caching

\n

nginx_caching accepts the following string values:

\n
    \n
  • redis - to enable Nginx Redis SRCache Page Caching
    • \n
  • fastcgi - to enable Nginx Fastcgi Page Caching
    • \n
  • none - to disable active Nginx Page Caching
    • \n
\n

note\nAny active page caching needs to be disabled prior to enabling an alternative form of page caching. It is not possible to swap from one type of Nginx page caching directly to the alternative type of Nginx page caching.

\n

nginx_caching_ttl - integer

\n

This value cannot be specified with \"nginx_caching\": \"none\"

\n

nginx_caching_ttl accepts integer values

\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}},"urlObject":{"path":["oauth","api","v1","site","{site.id}"],"host":["https://my.gridpane.com"],"query":[],"variable":[]}},"response":[{"id":"16de9ff6-d95d-4fa6-a83e-d6b9b9caa657","name":"change site nginx caching ttl with nginx caching","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"nginx_caching\": \"redis\",\r\n \"nginx_caching_ttl\": 5\r\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/site/1"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"3453aecc-d8aa-40ef-96df-5850021c3a3e"},{"name":"change site nginx caching ttl","id":"eb5c97a5-2d53-40aa-86b8-b2ff6366b56d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","type":"text","value":"Bearer {{oath_token}}"}],"body":{"mode":"raw","raw":"{\r\n \"nginx_caching_ttl\": \"{integer}\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/site/{site.id}","description":"

Change site nginx caching ttl

\n

nginx_caching_ttl - integer

\n

nginx_caching_ttl accepts integer values

\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}},"urlObject":{"path":["oauth","api","v1","site","{site.id}"],"host":["https://my.gridpane.com"],"query":[],"variable":[]}},"response":[{"id":"d6fd1eae-456a-4fa6-bda5-f96b4d814fb8","name":"change site nginx caching ttl","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"nginx_caching_ttl\": 5\r\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/site/1"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"eb5c97a5-2d53-40aa-86b8-b2ff6366b56d"},{"name":"change site object caching","id":"c105f498-e116-40b6-bc3b-a3153f8382bf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"object_caching\": \"{boolean}\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/site/{site.id}","description":"

Change site object caching

\n

object_caching - boolean

\n

object_caching accepts the following values: true || false

\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}},"urlObject":{"path":["oauth","api","v1","site","{site.id}"],"host":["https://my.gridpane.com"],"query":[],"variable":[]}},"response":[{"id":"4298ec6b-56b9-4e19-b4c1-772b61412375","name":"change site object caching","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"object_caching\": true\r\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/site/1"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"c105f498-e116-40b6-bc3b-a3153f8382bf"},{"name":"clear site caches","id":"906a469b-a046-4347-a968-272cdecc3258","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"clear_cache\": \"{string}\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/site/{site.id}","description":"

Clear site caches

\n

clear_cache - string

\n

clear_cache accepts the following string values:

\n
    \n
  • page - to clear page cache
    • \n
  • object - to clear object cache
    • \n
  • all - to clear all caches
    • \n
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}},"urlObject":{"path":["oauth","api","v1","site","{site.id}"],"host":["https://my.gridpane.com"],"query":[],"variable":[]}},"response":[{"id":"6eeda45a-6715-469e-8ec0-59e581ee47ef","name":"clear site caches","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"clear_cache\": \"page\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/site/1"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"906a469b-a046-4347-a968-272cdecc3258"},{"name":"enable/disable site suspension","id":"1c749606-42b2-4097-834d-e74118b2f10f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","type":"text","value":"Bearer {{oath_token}}"}],"body":{"mode":"raw","raw":"{\r\n \"suspend_site\": \"{boolean}\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/site/{site.id}","description":"

Suspend/unsuspend a site - serve an html suspension page for all site requests.
Endpoint is only available on Agency plans and above.

\n

suspend_site - boolean

\n

suspend_site accepts the following values: true || false

\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}},"urlObject":{"path":["oauth","api","v1","site","{site.id}"],"host":["https://my.gridpane.com"],"query":[],"variable":[]}},"response":[{"id":"7fee891d-0e6c-47b5-949b-66bb5555e8f9","name":"suspend a site","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"suspend_site\": true\r\n}"},"url":{"raw":"https://my.gridpane.com/oauth/api/v1/site/1","host":["https://my.gridpane.com"],"path":["oauth","api","v1","site","1"],"query":[{"key":"","value":null,"type":"text","disabled":true}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"1c749606-42b2-4097-834d-e74118b2f10f"},{"name":"enable secure wp debug","id":"a83dbfdb-03f2-4860-a7fa-1c079a1949fc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","type":"text","value":"Bearer {{oath_token}}"}],"body":{"mode":"raw","raw":"{\r\n \"debug\":{boolean}\r\n}\r\n\r\n","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/site/{site.id}","description":"

debug - boolean

\n

accepts true or false

\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}},"urlObject":{"path":["oauth","api","v1","site","{site.id}"],"host":["https://my.gridpane.com"],"query":[],"variable":[]}},"response":[{"id":"f56918de-967c-493c-9292-ade7052a73af","name":"enable secure wp debug on a site","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"debug\":true\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://my.gridpane.com/oauth/api/v1/site/42","host":["https://my.gridpane.com"],"path":["oauth","api","v1","site","42"],"query":[{"key":"","value":null,"type":"text","disabled":true}]}},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":""}],"_postman_id":"a83dbfdb-03f2-4860-a7fa-1c079a1949fc"},{"name":"run WP-CLI commands on site","id":"86fbf87a-c5b2-4f64-825d-56e1801f5225","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","type":"text","value":"Bearer {{oath_token}}"}],"body":{"mode":"raw","raw":"{\r\n \"wp\": {\r\n \"{wp_command.string}\": [\"{wp_subcommand_and_options.string}\"]\r\n }\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/site/run-wp-cli/{site.id}","description":"

Run WP-CLI commands on a site

\n

wp_command - json key - string

\n

Accepts any WP-CLI command.

\n

This is the key for a json object. The json object accepts an array of strings.

\n

wp_command_and_options - json array - string

\n

Accepts an array of strings.

\n

Each string will form a separate command with the object key.

\n

Each string must include the subcommand and any options.

\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}},"urlObject":{"path":["oauth","api","v1","site","run-wp-cli","{site.id}"],"host":["https://my.gridpane.com"],"query":[],"variable":[]}},"response":[{"id":"40492790-9853-4c28-9e0c-e17a557773f8","name":"update 2 plugins and all themes, then flush wp cache","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"wp\": {\r\n \"plugin\": [ \r\n \"update bbpress\",\r\n \"update nginx-helper\"\r\n ],\r\n \"theme\": [ \"update -all --exclude=hello\" ],\r\n \"cache\": [ \"flush\" ]\r\n }\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":{"raw":"https://my.gridpane.com/oauth/api/v1/site/run-wp-cli/42","host":["https://my.gridpane.com"],"path":["oauth","api","v1","site","run-wp-cli","42"],"query":[{"key":"","value":null,"type":"text","disabled":true}]}},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"message\": \"Commands successfully executed on 199.199.199.199 server.\"\n}"},{"id":"fb95825e-55d7-4124-9b96-489c187ff58b","name":"update user 2 and delete user 1","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"wp\": {\r\n \"user\": [\r\n \"update 2 --display_name=robin --user_pass=holycow@waynemanor\",\r\n \"delete 1 --reassign=2\"\r\n ]\r\n }\r\n}\r\n\r\n","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/site/run-wp-cli/42"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"message\": \"Commands successfully executed on 199.199.199.199 server.\"\n}"}],"_postman_id":"86fbf87a-c5b2-4f64-825d-56e1801f5225"},{"name":"add wp users to a site","id":"f1cf9560-01c3-4827-aa0e-8afe88c60c03","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","type":"text","value":"Bearer {{oath_token}}"}],"body":{"mode":"raw","raw":"{\r\n \"wp_users\": [\r\n {\r\n \"username\": \"{string}\",\r\n \"email\": \"{string}\",\r\n \"password\": \"{string}\",\r\n \"role\": \"{string}\"\r\n }\r\n ]\r\n}\r\n\r\n","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/site/add-wp-users/{site.id}","description":"

An array of json objects each containing a wp_user to add.

\n

This array can contain up to 5 users to add to the site on build.

\n

Each user object can/should contain the following key:values:

\n

username - string - required
The username of the user to add.
email - string - required
The email of the user to add.
password - string - optional
An optional password for the user.
If no password is provided an autogenerated password will be used.
role - string - required
The role of the user. The following standard roles can be used:
-administrator
-editor
-contributor
-subscriber

\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}},"urlObject":{"path":["oauth","api","v1","site","add-wp-users","{site.id}"],"host":["https://my.gridpane.com"],"query":[],"variable":[]}},"response":[{"id":"c630874a-e0bd-4e57-b92b-6daa21d081ff","name":"add a new admin and editor user to a site","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"wp_users\": [\r\n {\r\n \"username\": \"batman\",\r\n \"email\": \"batman@wayne.enterprise\",\r\n \"password\": \"ilovecatwomanmeow\",\r\n \"role\": \"administrator\"\r\n },\r\n {\r\n \"username\": \"robin\",\r\n \"email\": \"robin@wayne.enterprise\",\r\n \"password\": \"iamstartingtoquestionthisendeavour\",\r\n \"role\": \"editor\"\r\n }\r\n ]\r\n}\r\n\r\n","options":{"raw":{"language":"json"}}},"url":{"raw":"https://my.gridpane.com/oauth/api/v1/site/add-wp-users/42","host":["https://my.gridpane.com"],"path":["oauth","api","v1","site","add-wp-users","42"],"query":[{"key":"","value":null,"type":"text","disabled":true}]}},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"site_id\": 42,\n \"server_id\": 2001,\n \"message\": \"Commands successfully executed on 199.199.199.199 server.\"\n}\n"}],"_postman_id":"f1cf9560-01c3-4827-aa0e-8afe88c60c03"},{"name":"delete site","id":"f493722f-169e-44e6-bb09-46222e322629","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"site_id\": {site.id},\n \"server_id\": {server.id}\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/site/","description":"

Delete a site from a GridPane server using both the site_id and server_id to avoid any mistakes.

\n

site_id - integer - required

\n

site_id of the site you wish to delete

\n

server_id - integer - required

\n

server_id of the server that hosts the site you wish to delete

\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}},"urlObject":{"path":["oauth","api","v1","site",""],"host":["https://my.gridpane.com"],"query":[],"variable":[]}},"response":[{"id":"ad08bd2e-35e0-4763-b154-494dea88e0e9","name":"delete site by id and server id in payload","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"site_id\": 1,\n \"server_id\": 1\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/site/"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"f493722f-169e-44e6-bb09-46222e322629"},{"name":"delete site by ID","id":"1250c316-64cc-40cf-9e2f-1254d0437706","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"}],"body":{"mode":"raw","raw":""},"url":"https://my.gridpane.com/oauth/api/v1/site/{site_id}","description":"

Delete a site from a GridPane server using the site id in the request url. More dangerous than requiring site id and server id in a payload. You have been warned.

\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}},"urlObject":{"path":["oauth","api","v1","site","{site_id}"],"host":["https://my.gridpane.com"],"query":[],"variable":[]}},"response":[{"id":"820a07e9-5789-411f-8547-1511d1f66f94","name":"delete site by ID in request url","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"}],"body":{"mode":"raw","raw":""},"url":"https://my.gridpane.com/oauth/api/v1/site/1"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"1250c316-64cc-40cf-9e2f-1254d0437706"}],"id":"53d68a49-f6e9-4473-9fc0-b89d37bcbf5c","_postman_id":"53d68a49-f6e9-4473-9fc0-b89d37bcbf5c","description":"","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}}},{"name":"domain","item":[{"name":"get domains list","id":"d652c517-bec7-43f3-b384-26aaf4af3528","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"}],"url":"https://my.gridpane.com/oauth/api/v1/domain","description":"

Request for all domains belonging to User.

\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}},"urlObject":{"path":["oauth","api","v1","domain"],"host":["https://my.gridpane.com"],"query":[],"variable":[]}},"response":[{"id":"3ae3a453-f952-49b9-aab3-622e43466bf1","name":"get domains list","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"}],"url":"https://my.gridpane.com/oauth/api/v1/domain"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"d652c517-bec7-43f3-b384-26aaf4af3528"},{"name":"get specific domain","id":"9a9983d1-913f-414a-b2ec-95f9a18d58e6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"}],"url":"https://my.gridpane.com/oauth/api/v1/domain/{domain.id}","description":"

Get specific domain using domain id as url parameter

\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}},"urlObject":{"path":["oauth","api","v1","domain","{domain.id}"],"host":["https://my.gridpane.com"],"query":[],"variable":[]}},"response":[{"id":"421c1511-d948-4667-a7e3-93e546e6b2e7","name":"get specific domain","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"}],"url":"https://my.gridpane.com/oauth/api/v1/domain/1"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"9a9983d1-913f-414a-b2ec-95f9a18d58e6"},{"name":"add domain to site","id":"22378837-cf0b-48d9-b8f6-a3a5445bc204","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"domain_url\": \"{string}\",\n \"site_id\": {integer},\n \"server_id\": {integer},\n \"type\": \"{string}\",\n \"dns_management\": \"{string}\",\n \"dns_integration_id\": {integer}\n}"},"url":"https://my.gridpane.com/oauth/api/v1/domain","description":"

Add a new add on domain to an existing site

\n

domain_url - string - required

\n

The domain that you wish to add to the site

\n

site_id - integer - required

\n

The site_id of the site to which you want to add the domain

\n

server_id - integer - required

\n

The server_id of the server that hosts the site to which you want to add the domain

\n

type - string - required

\n

The type of domain you want to add, accepts alias||redirect.

\n

dns_management - string - required

\n

Value for type of DNS integration to use.

\n

dns_management can have the following values:

\n
    \n
  • none_none
    • \n
  • cloudflare_full
    • \n
  • cloudflare_challenge
    • \n
  • dnsme_full
    • \n
  • dnsme_challenge
    • \n
\n

dns_integration_id - integer - required IF

\n

Require IF not setting the integration to none_none
The integration ID of the DNS integration to set use to manage the site domain DNS.

\n

Use the GET /user/integration to find your available DNS integration ids.

\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}},"urlObject":{"path":["oauth","api","v1","domain"],"host":["https://my.gridpane.com"],"query":[],"variable":[]}},"response":[{"id":"136c02ae-d27c-4530-ad60-12418e2d1c83","name":"add redirect domain to a site and set up full cloudflare integration","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"domain_url\": \"redirect.domain\",\n \"site_id\": 1038,\n \"server_id\": 2001,\n \"type\": \"redirect\",\n \"dns_management\": \"cloudflare_full\",\n \"dns_integration_id\": 42\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/domain"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"be6cb906-9ac2-4b60-8f79-a4ef2d12808f","name":"add a new alias domain to a site with no DNS management","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"domain_url\": \"alias.domain\",\n \"site_id\": 42,\n \"server_id\": 23,\n \"type\": \"alias\"\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/domain"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"22378837-cf0b-48d9-b8f6-a3a5445bc204"},{"name":"switch to primary type","id":"14fa44a4-a411-4ec9-82aa-20670ecadf1b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"switch_to_primary_type\": {switch_to_primary_type}\r\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/domain/{domain.id}","description":"

Switch to primary type using domain id as url parameter.

\n

switch_to_primary_type - boolean

\n

Only accepts true to initiate the primary domain swap with current primary domain.

\n

Only alias domains can be updated to primary.

\n

Staging site must be disabled when updating the domain type on the primary site.

\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}},"urlObject":{"path":["oauth","api","v1","domain","{domain.id}"],"host":["https://my.gridpane.com"],"query":[],"variable":[]}},"response":[{"id":"b0c8e17a-82fc-4746-92df-eb65f38322f4","name":"switch to primary type","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"switch_to_primary_type\": true\r\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/domain/2"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"14fa44a4-a411-4ec9-82aa-20670ecadf1b"},{"name":"update dns api integration","id":"27ff6c9a-484f-43f0-95ed-ef041cf4ac71","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"dns_integration_id\": {integer},\r\n \"dns_management\": \"{string}\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/domain/{domain.id}","description":"

Update dns api integration for a domain

\n

dns_management - string - required

\n

Value for changing domain api integration.

\n

Api integration cannot be changed when ssl and wildcard are enabled.

\n

dns_management can have the following values:

\n
    \n
  • none_none
    • \n
  • dnsme_full
    • \n
  • cloudflare_full
    • \n
  • dnsme_challenge
    • \n
  • cloudlfare_challenge
    • \n
\n

dns_integration_id - integer - required IF

\n

Require IF not setting the integration to none_none

\n

The integration ID of the DNS integration to set use to manage the site domain DNS.

\n

Use the GET /user/integration to find your available DNS integration ids.

\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}},"urlObject":{"path":["oauth","api","v1","domain","{domain.id}"],"host":["https://my.gridpane.com"],"query":[],"variable":[]}},"response":[{"id":"fce97dc8-be26-4be5-a3a7-fe946e2e0ad3","name":"update api integration","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"dns_integration_id\": 42,\r\n \"dns_management\": \"cloudflare_full\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/domain/1"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"27ff6c9a-484f-43f0-95ed-ef041cf4ac71"},{"name":"update ssl configuration - enable/disable","id":"a47a7168-986b-49cf-802b-56aaedd9c85a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"ssl\": {boolean}\r\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/domain/{domain.id}","description":"

Update ssl using domain id as url parameter.

\n

ssl - boolean

\n

Value for ssl enabling or disabling, accepts true||false

\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}},"urlObject":{"path":["oauth","api","v1","domain","{domain.id}"],"host":["https://my.gridpane.com"],"query":[],"variable":[]}},"response":[{"id":"3bd21e7a-5efe-4135-863e-1da27a05768a","name":"update ssl","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"ssl\": true\r\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/domain/1"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"a47a7168-986b-49cf-802b-56aaedd9c85a"},{"name":"update route configuration - www/root","id":"05e13d67-6362-4308-99b2-0c1e87493b71","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"routing\": \"{string}\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/domain/{domain.id}","description":"

Update routing using domain id as url parameter.

\n

routing - string

\n

Value for domain routing changing.

\n

routing can have the following values: none, www, root.

\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}},"urlObject":{"path":["oauth","api","v1","domain","{domain.id}"],"host":["https://my.gridpane.com"],"query":[],"variable":[]}},"response":[{"id":"b00971ad-178a-44d1-8f1b-cbd2f542a537","name":"update routing","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"routing\": \"www\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/domain/1"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"05e13d67-6362-4308-99b2-0c1e87493b71"},{"name":"update wildcard configuration - enable/disable","id":"f30f0753-a763-4fa5-a829-417e86385fe6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"wildcard\": {boolean}\r\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/domain/{domain.id}","description":"

Update wildcard using domain id.

\n

wildcard - boolean

\n

Value for wildcard enabling or disabling, accepts true||false.

\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}},"urlObject":{"path":["oauth","api","v1","domain","{domain.id}"],"host":["https://my.gridpane.com"],"query":[],"variable":[]}},"response":[{"id":"50fb5e4a-4ea2-4c18-984f-67bb0a35982d","name":"update wildcard","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"wildcard\": true\r\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/domain/1"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"f30f0753-a763-4fa5-a829-417e86385fe6"},{"name":"delete domain by ID","id":"e7c11da6-b139-492a-ab67-a16745b6bde6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"}],"url":"https://my.gridpane.com/oauth/api/v1/domain/{domain.id}","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}},"urlObject":{"path":["oauth","api","v1","domain","{domain.id}"],"host":["https://my.gridpane.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"e7c11da6-b139-492a-ab67-a16745b6bde6"}],"id":"73f8b784-e81c-40dd-b6f8-3300e59614ef","_postman_id":"73f8b784-e81c-40dd-b6f8-3300e59614ef","description":"","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}}},{"name":"system-user","item":[{"name":"get system users list","id":"5281f73e-22aa-4c4b-8278-ac8824bced22","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"}],"url":"https://my.gridpane.com/oauth/api/v1/system-user","description":"

Get list of all system users across all servers belonging to an account

\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}},"urlObject":{"path":["oauth","api","v1","system-user"],"host":["https://my.gridpane.com"],"query":[],"variable":[]}},"response":[{"id":"d689d8c1-3176-40cd-9915-cc3d6e17818e","name":"get system users list","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"}],"url":"https://my.gridpane.com/oauth/api/v1/system-user"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"5281f73e-22aa-4c4b-8278-ac8824bced22"},{"name":"get specific system user","id":"dd7bb5a4-e54b-4f03-80aa-4e6b1580066f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"}],"url":"https://my.gridpane.com/oauth/api/v1/system-user/{system_user.id}","description":"

Get specific system user using system user id as url parameter

\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}},"urlObject":{"path":["oauth","api","v1","system-user","{system_user.id}"],"host":["https://my.gridpane.com"],"query":[],"variable":[]}},"response":[{"id":"a030e0c2-190c-429c-9c25-aa40011de152","name":"get specific system user","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"}],"url":"https://my.gridpane.com/oauth/api/v1/system-user/1"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"dd7bb5a4-e54b-4f03-80aa-4e6b1580066f"},{"name":"create system user","id":"fb3a38b3-6746-44ba-95d1-04d7db8d5895","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"username\": \"{string}\",\n \"server_id\": {integer},\n \"password\":\"{string}\",\n \"password_confirmation\":\"{string}\",\n \"ssh_public_key\":\"{string}\"\n}"},"url":"https://my.gridpane.com/oauth/api/v1/system-user","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}},"urlObject":{"path":["oauth","api","v1","system-user"],"host":["https://my.gridpane.com"],"query":[],"variable":[]}},"response":[{"id":"b9f260d2-d089-485b-989e-fab8de026fa4","name":"create system user","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"username\": \"batman\",\n \"password\": \"robinWearsPanties\",\n \"password_confirmation\": \"robinWearsPanties\"\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/system-user"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"fb3a38b3-6746-44ba-95d1-04d7db8d5895"},{"name":"update system user","id":"8cae85df-09b4-4b0b-b378-ee4019ced0b2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"password\":\"{string}\",\n \"password_confirmation\":\"{string}\",\n \"ssh_public_key\":\"{string}\"\n}\n"},"url":"https://my.gridpane.com/oauth/api/v1/system-user/{system_user.id}","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}},"urlObject":{"path":["oauth","api","v1","system-user","{system_user.id}"],"host":["https://my.gridpane.com"],"query":[],"variable":[]}},"response":[{"id":"9a52e210-7bed-4f08-829f-28bc1d9ab8bc","name":"update system user password","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"password\": \"robinWearsPanties\",\n \"password_confirmation\": \"robinWearsPanties\"\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/system-user/42"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"message\": \"password for system-user with username batman was an updated\"\n}"}],"_postman_id":"8cae85df-09b4-4b0b-b378-ee4019ced0b2"},{"name":"delete system user by ID","id":"641d64e2-1d5a-4adb-bc84-56739704629b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"}],"url":"https://my.gridpane.com/oauth/api/v1/system-user/{system_user.id}","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}},"urlObject":{"path":["oauth","api","v1","system-user","{system_user.id}"],"host":["https://my.gridpane.com"],"query":[],"variable":[]}},"response":[{"id":"c0a34d9c-863f-48e9-a6b3-3e89324edfee","name":"delete system user by ID in request url","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"}],"url":"https://my.gridpane.com/oauth/api/v1/system-user/1"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"641d64e2-1d5a-4adb-bc84-56739704629b"}],"id":"e0cb117d-3985-41f4-af03-bdf66bbecc14","_postman_id":"e0cb117d-3985-41f4-af03-bdf66bbecc14","description":"","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}}},{"name":"teams","item":[{"name":"get user teams","id":"55c720ad-4d25-4ded-9f33-e393dc4cd2fd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"}],"url":"https://my.gridpane.com/oauth/api/v1/settings/teams","description":"

Get user teams

\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}},"urlObject":{"path":["oauth","api","v1","settings","teams"],"host":["https://my.gridpane.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"55c720ad-4d25-4ded-9f33-e393dc4cd2fd"},{"name":"get current user team","id":"c4011eb2-f28d-4b7a-98bb-422daa377961","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"}],"url":"https://my.gridpane.com/oauth/api/v1/settings/teams/current","description":"

Get current user team

\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}},"urlObject":{"path":["oauth","api","v1","settings","teams","current"],"host":["https://my.gridpane.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"c4011eb2-f28d-4b7a-98bb-422daa377961"}],"id":"18f452b4-2af3-4ca1-aeb5-2b2d57450da1","_postman_id":"18f452b4-2af3-4ca1-aeb5-2b2d57450da1","description":"","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}}},{"name":"bundles","item":[{"name":"get bundles","id":"add1e93b-f830-4697-adbb-41c557edec3f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"}],"url":"https://my.gridpane.com/oauth/api/v1/bundle/","description":"

Returns JSON file with all bundles name and id

\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}},"urlObject":{"path":["oauth","api","v1","bundle",""],"host":["https://my.gridpane.com"],"query":[],"variable":[]}},"response":[{"id":"b03a88c7-23e5-4e81-8b4c-6c34f12952c9","name":"get bundles","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"}],"url":"https://my.gridpane.com/oauth/api/v1/bundle/"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"bundles\": [\n {\n \"id\": 1,\n \"name\": \"foo-bar\"\n },\n {\n \"id\": 2,\n \"name\": \"bar-foo\"\n },\n {\n \"id\": 5,\n \"name\": \"foo-foo\"\n },\n {\n \"id\": 7,\n \"name\": \"bar-bar\"\n }\n ]\n}"}],"_postman_id":"add1e93b-f830-4697-adbb-41c557edec3f"},{"name":"get bundle by id","id":"8dc55921-d129-41f4-9f6f-442579b05578","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"}],"url":"https://my.gridpane.com/oauth/api/v1/bundle/{bundle.id}","description":"

Returns JSON file with bundle name and plugins and themes by the bundle id

\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}},"urlObject":{"path":["oauth","api","v1","bundle","{bundle.id}"],"host":["https://my.gridpane.com"],"query":[],"variable":[]}},"response":[{"id":"21f5d439-28b3-4e03-8af5-cd94fb80d305","name":"get bundle by id","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"}],"url":"https://my.gridpane.com/oauth/api/v1/bundle/1"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"bundle\": {\n \"name\": \"foo bar\",\n \"plugins\": [\n {\n \"id\": 1,\n \"name\": \"foo bar\",\n \"is_active\": true\n },\n {\n \"id\": 2,\n \"name\": \"foo bar\",\n \"is_active\": false\n },\n {\n \"id\": 5,\n \"name\": \"foo bar\",\n \"is_active\": false\n }\n ],\n \"themes\": [\n {\n \"id\": 2,\n \"name\": \"foo bar\",\n \"is_active\": false\n },\n {\n \"id\": 5,\n \"name\": \"foo bar\",\n \"is_active\": true\n },\n {\n \"id\": 6,\n \"name\": \"foo bar\",\n \"is_active\": true\n }\n ]\n }\n}"}],"_postman_id":"8dc55921-d129-41f4-9f6f-442579b05578"},{"name":"create bundle","id":"2db0e559-d8e2-410c-a695-747d282a05fd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"bundle_name\": \"{string}\",\n \"plugins\": [\n {\n \"name\": \"{string}\",\n \"is_active\": {boolean}\n },\n {\n \"name\": \"{string}\",\n \"is_active\": {boolean}\n }\n ],\n \"themes\": [\n {\n \"name\": \"{string}\",\n \"is_active\": {boolean}\n },\n {\n \"name\": \"{string}\",\n \"is_active\": {boolean}\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/bundle/","description":"

Creates a bundle with plugins and themes

\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}},"urlObject":{"path":["oauth","api","v1","bundle",""],"host":["https://my.gridpane.com"],"query":[],"variable":[]}},"response":[{"id":"06bf81e6-496f-44bd-99a2-264f71d49bd4","name":"create bundle","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"bundle_name\": \"foo bar baz\",\n \"plugins\": [\n {\n \"name\": \"bar foo\",\n \"is_active\": true\n },\n {\n \"name\": \"https://bar\",\n \"is_active\": false\n }\n ],\n \"themes\": [\n {\n \"name\": \"https://foo\",\n \"is_active\": true\n },\n {\n \"name\": \"foo bar\",\n \"is_active\": false\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/bundle/"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Bundle created\"\n}"}],"_postman_id":"2db0e559-d8e2-410c-a695-747d282a05fd"},{"name":"add theme to bundle","id":"fe6cc35e-5868-4224-bba9-ffb882b7f633","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"{string}\",\n \"is_active\": \"{boolean}\"\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/bundle/{bundle.id}/theme","description":"

Add a theme to bundle by the bundle id

\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}},"urlObject":{"path":["oauth","api","v1","bundle","{bundle.id}","theme"],"host":["https://my.gridpane.com"],"query":[],"variable":[]}},"response":[{"id":"fd9461fe-9782-4791-85fd-022d0c6367a6","name":"add theme to bundle","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"foo bar\",\n \"is_active\": false\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/bundle/1/theme"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Theme created\"\n}"}],"_postman_id":"fe6cc35e-5868-4224-bba9-ffb882b7f633"},{"name":"add plugin to bundle","id":"93d447ec-3803-4152-9adb-e94a05effbe5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"{string}\",\n \"is_active\": \"{boolean}\"\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/bundle/{bundle.id}/plugin","description":"

Add a plugin to bundle by the bundle id

\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}},"urlObject":{"path":["oauth","api","v1","bundle","{bundle.id}","plugin"],"host":["https://my.gridpane.com"],"query":[],"variable":[]}},"response":[{"id":"1b4d1f07-2a76-4c0d-b3d1-858857c7d51e","name":"add plugin to bundle","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"foo bar\",\n \"is_active\": false\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/bundle/1/plugin"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Plugins created\"\n}"}],"_postman_id":"93d447ec-3803-4152-9adb-e94a05effbe5"},{"name":"update bundle name","id":"0716e420-5491-4733-b64e-583ce060dd7d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"new_name\": \"{string}\"\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/bundle/{bundle.id}","description":"

Update bundle name by the bundle id

\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}},"urlObject":{"path":["oauth","api","v1","bundle","{bundle.id}"],"host":["https://my.gridpane.com"],"query":[],"variable":[]}},"response":[{"id":"4bfd960c-1a71-45d6-96d1-9da748371866","name":"update bundle name","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"new_name\": \"foo bar baz\"\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/bundle/1"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Bundle updated\"\n}"}],"_postman_id":"0716e420-5491-4733-b64e-583ce060dd7d"},{"name":"update plugin by bundle_id and plugin_id","id":"be30440c-4199-4f4e-895b-d324f238daf0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"{string}\",\n \"is_active\": \"{boolean}\"\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/bundle/{bundle.id}/plugin/{plugin.id}","description":"

Update plugin name or activate|deactivate plugin by bundle and plugin id

\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}},"urlObject":{"path":["oauth","api","v1","bundle","{bundle.id}","plugin","{plugin.id}"],"host":["https://my.gridpane.com"],"query":[],"variable":[]}},"response":[{"id":"de947780-b2fa-444c-b8b7-486ea85c68dd","name":"update plugin","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"foo bar baz\",\n \"is_active\": true\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/bundle/1/plugin/1"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Plugin updated\"\n}"},{"id":"a4efcccf-9c3e-43d9-bd9b-4f9be069c3fd","name":"update plugin name","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"foo bar baz\"\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/bundle/1/plugin/1"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Plugin updated\"\n}"},{"id":"7807123d-cbd9-41e7-93af-4e7aa76d6f50","name":"activate plugin","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"is_active\": true\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/bundle/1/plugin/1"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Plugin updated\"\n}"},{"id":"4e8a5d82-63b7-4775-8961-07fe8b211194","name":"deactivate plugin","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"is_active\": false\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/bundle/1/plugin/1"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Plugin updated\"\n}"}],"_postman_id":"be30440c-4199-4f4e-895b-d324f238daf0"},{"name":"update theme by bundle_id and theme_id Copy","id":"10ae1514-3e91-4444-982e-17e97a11cf72","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"{string}\",\n \"is_active\": \"{boolean}\"\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/bundle/{bundle.id}/theme/{theme.id}","description":"

Update theme name or activate|deactivate plugin by bundle and theme id

\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}},"urlObject":{"path":["oauth","api","v1","bundle","{bundle.id}","theme","{theme.id}"],"host":["https://my.gridpane.com"],"query":[],"variable":[]}},"response":[{"id":"e138c12d-f1d1-40cb-b87f-b177ae9bb9ec","name":"update theme","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"foo-bar\",\n \"is_active\": true\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/bundle/15/theme/34"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Theme updated\"\n}"},{"id":"b00a1c4e-e495-42d0-a91a-67f321291f79","name":"update theme name","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"foo bar baz\"\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/bundle/1/theme/1"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Theme updated\"\n}"},{"id":"b0d3990e-918a-4cca-be01-a4e97b003f71","name":"activate theme","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"is_active\": true\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/bundle/1/theme/1"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Theme updated\"\n}"},{"id":"9a61d220-b3f0-48ca-82b4-7ed862ca1307","name":"deactivate theme","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"is_active\": false\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/bundle/1/theme/1"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Theme updated\"\n}"}],"_postman_id":"10ae1514-3e91-4444-982e-17e97a11cf72"},{"name":"remove bundle","id":"e09b72df-0b77-4478-acc3-94331692233c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"}],"url":"https://my.gridpane.com/oauth/api/v1/bundle/{bundle.id}","description":"

Remove bundle by the bundle id

\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}},"urlObject":{"path":["oauth","api","v1","bundle","{bundle.id}"],"host":["https://my.gridpane.com"],"query":[],"variable":[]}},"response":[{"id":"990efc59-6d57-420c-9c80-6ecf0c974821","name":"remove bundle","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"}],"url":"https://my.gridpane.com/oauth/api/v1/bundle/1"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Bundle removed\"\n}"}],"_postman_id":"e09b72df-0b77-4478-acc3-94331692233c"},{"name":"remove plugin by bundle_id and plugin_id","id":"d86255a9-1425-4f28-8a97-e421653e0b0f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"}],"url":"https://my.gridpane.com/oauth/api/v1/bundle/{bundle.id}/plugin/{plugin.id}","description":"

Remove plugin by the bundle and plugin id

\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}},"urlObject":{"path":["oauth","api","v1","bundle","{bundle.id}","plugin","{plugin.id}"],"host":["https://my.gridpane.com"],"query":[],"variable":[]}},"response":[{"id":"a9ea08cd-5b9a-444c-9be5-c1c110cfb50d","name":"remove plugin","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"}],"url":"https://my.gridpane.com/oauth/api/v1/bundle/1/plugin/1"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Plugin removed\"\n}"}],"_postman_id":"d86255a9-1425-4f28-8a97-e421653e0b0f"},{"name":"remove theme by bundle_id and theme_id","id":"9c9b7c3b-c8e3-425d-9032-4d43e38aecb2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"}],"url":"https://my.gridpane.com/oauth/api/v1/bundle/{bundle.id}/theme/{theme.id}","description":"

Remove theme by the bundle and theme id

\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}},"urlObject":{"path":["oauth","api","v1","bundle","{bundle.id}","theme","{theme.id}"],"host":["https://my.gridpane.com"],"query":[],"variable":[]}},"response":[{"id":"7a654f6a-be49-4e42-a87d-7981ff4b40b8","name":"remove theme","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"}],"url":"https://my.gridpane.com/oauth/api/v1/bundle/1/theme/1"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Theme removed\"\n}"}],"_postman_id":"9c9b7c3b-c8e3-425d-9032-4d43e38aecb2"}],"id":"a59b9caa-d176-402e-b305-ad6e933e7511","_postman_id":"a59b9caa-d176-402e-b305-ad6e933e7511","description":"","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}}},{"name":"backups","item":[{"name":"Refresh site available backups","id":"761586b2-cd33-4607-9b91-45ce1c371014","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"}],"url":"https://my.gridpane.com/oauth/api/v1/backups/refresh/{site.id}","description":"

Update GridPane application database with all available backups for a site.

\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}},"urlObject":{"path":["oauth","api","v1","backups","refresh","{site.id}"],"host":["https://my.gridpane.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"761586b2-cd33-4607-9b91-45ce1c371014"},{"name":"Get original source available backups","id":"d0f42001-86c6-409d-ba63-8fcc73d3758f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"}],"url":"https://my.gridpane.com/oauth/api/v1/backups/original/{site.id}","description":"

Request to return all available backups for a site from the GridPane application database.

\n

A complete record of available backups are stored on a users server and the GridPane application database only refreshes its record of them during usage of the application.

\n

Please run the GET to refresh the applications record of a site's available backups prior to using this endpoint to ensure you are receiving the latest record of backups.i

\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}},"urlObject":{"path":["oauth","api","v1","backups","original","{site.id}"],"host":["https://my.gridpane.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"d0f42001-86c6-409d-ba63-8fcc73d3758f"},{"name":"Get alternative backups sources","id":"f5951126-715b-4b6f-9ba9-8d8ec7e9f10f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"}],"url":"https://my.gridpane.com/oauth/api/v1/backups/alternative-source/{site.id}","description":"

Fetch all possible alternative sources for remote backups for this site.

\n

Will return a list of other servers and deleted versions of this site that may have created remote backups, along with those remote backup integrations used.

\n

Data from this request can be used in a POST request to check available alternative backups, followed by a GET request for alternative source backups.

\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}},"urlObject":{"path":["oauth","api","v1","backups","alternative-source","{site.id}"],"host":["https://my.gridpane.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"f5951126-715b-4b6f-9ba9-8d8ec7e9f10f"},{"name":"Get alternative source available backups","id":"5fe743e8-14a6-4c5f-9897-3d6aba7a47c0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"}],"url":"https://my.gridpane.com/oauth/api/v1/backups/alternative/{site.id}","description":"

Return a record of all available alternative backups for a site from the GridPane application database.

\n

A complete record of available backups are only stored on a users server when called upon and the GridPane application database only refreshes its record of them during usage of the application.

\n

For this request to return the list of backups you first need to run a GET request for alternative sources of backups for this site. Use that data to make a POST request to check for any alternative backups followed by a GET request to update the application and receive a response containing these backups.

\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}},"urlObject":{"path":["oauth","api","v1","backups","alternative","{site.id}"],"host":["https://my.gridpane.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"5fe743e8-14a6-4c5f-9897-3d6aba7a47c0"},{"name":"Get all available backups integrations","id":"ebbe67db-1b50-4c07-9988-70356dc4b99c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"}],"url":"https://my.gridpane.com/oauth/api/v1/backups/integrations","description":"

Get all possible remote backup integrations available to a user for their sites.

\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}},"urlObject":{"path":["oauth","api","v1","backups","integrations"],"host":["https://my.gridpane.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"ebbe67db-1b50-4c07-9988-70356dc4b99c"},{"name":"Get site backup integrations","id":"c0d5e585-b288-4384-865d-c1867d2a2112","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"}],"url":"https://my.gridpane.com/oauth/api/v1/backups/integrations/{site.id}","description":"

Get a site's attached remote backup integrations.

\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}},"urlObject":{"path":["oauth","api","v1","backups","integrations","{site.id}"],"host":["https://my.gridpane.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"c0d5e585-b288-4384-865d-c1867d2a2112"},{"name":"Get all sites backups schedules","id":"d8816895-8ca7-403f-b414-9b030317e275","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"}],"url":"https://my.gridpane.com/oauth/api/v1/backups/schedules","description":"

Get the backup schedules for all sites belonging to a user.

\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}},"urlObject":{"path":["oauth","api","v1","backups","schedules"],"host":["https://my.gridpane.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"d8816895-8ca7-403f-b414-9b030317e275"},{"name":"Get all sites on server backup schedules","id":"ec0c8fbc-c9d2-42da-a8f7-3dee2c6d1d47","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"}],"url":"https://my.gridpane.com/oauth/api/v1/backups/schedules/server/{server.id}","description":"

Get the backup schedules for all sites on a server.

\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}},"urlObject":{"path":["oauth","api","v1","backups","schedules","server","{server.id}"],"host":["https://my.gridpane.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"ec0c8fbc-c9d2-42da-a8f7-3dee2c6d1d47"},{"name":"Get site backup schedules","id":"28b31036-c7c6-4313-8e61-f8aea4bc83b1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"}],"url":"https://my.gridpane.com/oauth/api/v1/backups/schedules/site/{site.id}","description":"

Get the backups schedule for a single site.

\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}},"urlObject":{"path":["oauth","api","v1","backups","schedules","site","{site.id}"],"host":["https://my.gridpane.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"28b31036-c7c6-4313-8e61-f8aea4bc83b1"},{"name":"Get site backups prune schedule","id":"d58f2415-1150-419d-8e46-00de7db6d97f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"}],"url":"https://my.gridpane.com/oauth/api/v1/backups/prune-schedule/{site.id}","description":"

Get the prune schedules for a site backups.

\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}},"urlObject":{"path":["oauth","api","v1","backups","prune-schedule","{site.id}"],"host":["https://my.gridpane.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"d58f2415-1150-419d-8e46-00de7db6d97f"},{"name":"Add remote backup integration to site","id":"8089d9f1-d14e-472e-986c-bf4de66c4ceb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"integrations_id\": {integer}\n}\n\n","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/backups/integrations/{site.id}","description":"

Request to attach a remote backup integration to a site.

\n

integration_id - integer - required

\n

The integration id for the remote backup provider you wish to use.

\n

Find available integrations using a GET request for your available integrations.

\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}},"urlObject":{"path":["oauth","api","v1","backups","integrations","{site.id}"],"host":["https://my.gridpane.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"8089d9f1-d14e-472e-986c-bf4de66c4ceb"},{"name":"Create a new backup","id":"650df9b5-e030-435a-b8e6-a8e0fac59d18","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"type\": \"{string}\",\n \"integration_id\": {integer},\n \"tag\": \"{string}\"\n}\n","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/backups/{site.id}","description":"

Request to create a new manual backup for a site.

\n

type - string - required

\n

The type of backup you wish to create, accepts:

\n
    \n
  • local
    • \n
  • remote
    • \n
\n

integration_id - integer - required IF

\n

Required if type == remote

\n

Accepts integration ids belonging to user integrations attached to the site.

\n

tag - string - optional

\n

Accepts alphanumeric strings with dashes

\n
    \n
  • upto 32 characters
    • \n
  • reserved keywords disallowed
      \n
    • manual (lower/upper case)
      • \n
    • auto (lower/upper case)
      • \n
    \n
    • \n
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}},"urlObject":{"path":["oauth","api","v1","backups","{site.id}"],"host":["https://my.gridpane.com"],"query":[],"variable":[]}},"response":[{"id":"ad775dd3-0391-4040-a39c-c11fb0c46ee1","name":"Create a new backup local backup and tag it.","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"type\": \"local\",\n \"tag\": \"enjoy-life\"\n}\n","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/backups/42"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"58e40134-63ee-43c5-bf5a-83de81175057","name":"Create a new remote backup using attached integration 2001","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"type\": \"remote\",\n \"integration_id\": 42\n}\n","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/backups/2001"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"650df9b5-e030-435a-b8e6-a8e0fac59d18"},{"name":"Check available alternative backups","id":"aff250e8-e2bc-4dce-9631-5d86eca3fc77","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"alternative_server_id\":6458,\n \"integration_id\":35\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/backups/refresh-alternative/{site.id}","description":"

Request to run a check for any remote backups for a site that may have been created on another server.

\n

alternative_server_id - integer - required

\n

ID of other server from where a remote backup may have been created.

\n

Use a GET alternative backups sources for this ID

\n

integration_id - integer - required

\n

ID of the remote integration that may have been used to create a remote backup on another server with this site.

\n

Use a GET alternative backups sources for this ID

\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}},"urlObject":{"path":["oauth","api","v1","backups","refresh-alternative","{site.id}"],"host":["https://my.gridpane.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"aff250e8-e2bc-4dce-9631-5d86eca3fc77"},{"name":"Restore a backup","id":"6bbde9fa-9e77-4ea3-88a4-f2e56c23e31e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"backup_source\": \"{string}\",\n \"source_type\": \"{string}\",\n \"backup_type\": \"{string}\",\n \"backup\": \"{string}\"\n}\n","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/backups/restore/{site.id}","description":"

Request to restore a backup

\n

backup_source - string - required

\n

The source of the backup to restore, accepts:

\n
    \n
  • local
    • \n
  • aws-s3
    • \n
  • backblaze
    • \n
  • dropbox
    • \n
  • wasabi
    • \n
\n

source_type - string - required

\n

The type of the source of the backup to restore, accepts:

\n
    \n
  • original
    • \n
  • alternative
    • \n
\n

original is used when restoring a backup that was created on this server.

\n

alternative is used when restoring a remote backup that was created on another server.

\n

backup_type - string - required

\n

The type of backup:

\n
    \n
  • manual
    • \n
  • automatic
    • \n
\n

backup - string - required

\n

The backup that you want to restore. This will be a string composed of a date, a time, and optionally a tag.

\n

e.g\n2021-11-24 08:59\n2021-11-24 08:59 mytag

\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}},"urlObject":{"path":["oauth","api","v1","backups","restore","{site.id}"],"host":["https://my.gridpane.com"],"query":[],"variable":[]}},"response":[{"id":"fdf985e4-b234-4093-b528-b99003d75047","name":"Restore a tagged remote backup manually created by a site","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"backup_source\": \"wasabi\",\n \"source_type\": \"original\",\n \"backup_type\": \"manual\",\n \"backup\": \"2021-20-21 20:21 twentytwentyone\"\n}\n","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/backups/restore/1038"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"da406d08-63aa-4329-b4ba-02be3ff99fc4","name":"Restore a remote backup created by a site with the same primary domain on another server.","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"backup_source\": \"wasabi\",\n \"source_type\": \"alternative\",\n \"backup_type\": \"automatic\",\n \"backup\": \"2021-20-21 20:21\"\n}\n","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/backups/restore/1038"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"6bbde9fa-9e77-4ea3-88a4-f2e56c23e31e"},{"name":"Enable/Disable automatic backups for a site","id":"1af77d18-6ae5-437b-8a89-37b7dee73f22","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"type\": \"{string}\",\n \"enable\": {boolean}\n}\n","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/backups/automatic/{site.id}","description":"

Enable/Disable remote/local automatic backups for a site

\n

type - string - required

\n

Type of automatic backup to enable/disable:

\n
    \n
  • local
    • \n
  • remote
    • \n
\n

enable - boolean - required

\n

Whether to enable or disable:

\n
    \n
  • true == enable
    • \n
  • false == disable
    • \n
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}},"urlObject":{"path":["oauth","api","v1","backups","automatic","{site.id}"],"host":["https://my.gridpane.com"],"query":[],"variable":[]}},"response":[{"id":"a3fb2462-9ebc-4f8d-ace9-0b10edeaee8d","name":"Enable remote backups for a site","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"type\": \"remote\",\n \"enable\": true\n}\n","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/backups/automatic/42"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"1af77d18-6ae5-437b-8a89-37b7dee73f22"},{"name":"Update site backup schedule","id":"636fd340-4110-4d7d-ad3f-204ba9ef558c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"id\": {integer},\n \"bup_schedule\": \"{string}\",\n \"minute\": {integer},\n \"hour\": {integer},\n \"day\": {integer}\n}\n","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/backups/schedule/site/{site.id}","description":"

Update a sites backup schedule

\n

id - integer - required

\n

Integer of the site's backup schedule that you want to update.

\n

Use a GET site backup schedule to get the schedule id.

\n

bup_schedule - string - required

\n

The type of backup schedule to set, accepts:

\n
    \n
  • hourly
    • \n
  • daily
    • \n
  • weekly
    • \n
  • monthly
    • \n
\n

minute - integer - required

\n

The minute of the hour to run the schedule.

\n

hour - integer - required IF

\n

required if bup_schedule is daily||weekly||hourly

\n

The hour of the day to run the schedule. Accepts 0 to 23

\n

day - integer - required IF

\n

required if bup_schedule is weekly or hourly

\n

The hour of the day to run the schedule.

\n

If bup_schedule is weekly then accepts 0 to 6 with 0 being Sunday.

\n

If bup_schedule is monthly then accepts 1 to 28.

\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}},"urlObject":{"path":["oauth","api","v1","backups","schedule","site","{site.id}"],"host":["https://my.gridpane.com"],"query":[],"variable":[]}},"response":[{"id":"ec042bd9-e3b5-476a-a9f7-10a4d1e62b64","name":"Update site backup schedule to run backups at half past every hour","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"id\": 23,\n \"bup_schedule\": \"hourly\",\n \"minute\": 30\n}\n","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/backups/schedule/site/1038"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"f3c8a83a-0471-4385-88f2-3d6463f6dfe6","name":"Update site backup schedule to run backups at midnight on the 1st of the Month","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"id\": 23,\n \"bup_schedule\": \"monthly\",\n \"minute\": 0,\n \"hour\": 0,\n \"day\": 1\n}\n","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/backups/schedule/site/1038"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"636fd340-4110-4d7d-ad3f-204ba9ef558c"},{"name":"Purge a site backup","id":"86836841-7b15-423b-b0c0-775addea838a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"backup_source\": \"{string}\",\n \"backup_type\": \"{string}\",\n \"backup\": \"{string}\"\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/backups/purge/{site.id}","description":"

Purge a backup

\n

backup_source - string - required

\n

The source of the backup to be purged, accepts:

\n
    \n
  • local
    • \n
  • aws-s3
    • \n
  • backblaze
    • \n
  • dropbox
    • \n
  • wasabi
    • \n
\n

backup_type - string - required

\n

The type of backup to be purged, accepts:

\n
    \n
  • manual
    • \n
  • automatic
    • \n
\n

backup - string - required

\n

The backup that you want to purge. This will be a string composed of a date, a time, and optionally a tag.

\n

e.g
2021-11-24 08:59
2021-11-24 08:59 mytag

\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}},"urlObject":{"path":["oauth","api","v1","backups","purge","{site.id}"],"host":["https://my.gridpane.com"],"query":[],"variable":[]}},"response":[{"id":"1c3855a7-5ae2-4978-aade-3fe2593058a7","name":"Purge a tagged remote manual site backup","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"backup_source\": \"wasabi\",\n \"backup_type\": \"manual\",\n \"backup\": \"2021-12-25 08:59 mytag\"\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/backups/purge/42"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"86836841-7b15-423b-b0c0-775addea838a"},{"name":"Purge a range of site backups","id":"73f3f6c4-672a-4b61-921c-7864cf48cc7a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"backup_source\": \"{string:(local||wasabi||aws-s3||backblaze||dropbox)}\",\n \"from_backup\": \"{string}\",\n \"to_backup\": \"{string}\"\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/backups/purge-range/{site.id}","description":"

Purge a range of backups

\n

Purging a range of backups will purge any backups between that range, be they automatic or manual backups.

\n

Please be careful. If you wish to keep a backup within that range of backups you wish to remove, then perform two purges. Purge a range up to the backup you wish to keep first. Then purge a range after the backup you wish to keep up to the final backup you wish to purge.

\n

backup_source - string - required

\n

The source of the backup to be purged, accepts:

\n
    \n
  • local
    • \n
  • aws-s3
    • \n
  • backblaze
    • \n
  • dropbox
    • \n
  • wasabi
    • \n
\n

from_backup - string - required

\n

The backup from which you want the range of backups to purge to being i.e. the oldest backup in the range you want to purge

\n

This backup can be either from the manual or automatic backups

\n

This will be a string composed of a date, a time, and optionally a tag.

\n

e.g
2021-11-24 08:59
2021-11-24 08:59 mytag

\n

from_backup - string - required

\n

The backup up to which you want the range of backups to purge to i.e. the newest backup in the range you want to purge

\n

This backup can be either from the manual or automatic backups

\n

This will be a string composed of a date, a time, and optionally a tag.

\n

e.g
2021-11-25 08:59
2021-11-25 08:59 mytag

\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}},"urlObject":{"path":["oauth","api","v1","backups","purge-range","{site.id}"],"host":["https://my.gridpane.com"],"query":[],"variable":[]}},"response":[{"id":"1d5ae55a-a405-4128-8b9c-3210c996b98c","name":"Purge a year of backups from a site remote storage.","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"backup_source\": \"wasabi\",\n \"from_backup\": \"2020-11-24 08:59 mytag\",\n \"to_backup\": \"2021-11-24 09:50\"\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/backups/purge-range/{site.id}"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"73f3f6c4-672a-4b61-921c-7864cf48cc7a"},{"name":"Update site backups prune schedule","id":"215798dc-6797-4cf7-b9c0-8df8bd03d038","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"backup_type\": \"{string}\",\n \"retain_days\": {integer},\n \"prune_schedule\": {integer}\n}\n","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/backups/prune-schedule/{site.id}","description":"

Update the prune schedule for a site

\n

backup_type - string - required

\n

The type of backup for which you wish to adjust the prune schedule, accepts:

\n
    \n
  • local
    • \n
  • remote
    • \n
\n

retain_days - integer - required

\n

The maximum number of days that the backups should be kept for before pruning them out, accepts

\n
    \n
  • 0 (unlimited)
    • \n
  • 30
    • \n
  • 90
    • \n
  • 180
    • \n
  • 360
    • \n
\n

prune_schedule - integer - required

\n

The schedule that backups should be pruned by, accepts:

\n
    \n
  • 0 keep daily backups
    • \n
  • 1 keep daily backups for a week, then weekly backups
    • \n
  • 2 keep daily backups for a month, then monthly backups
    • \n
  • 3 keep daily backups for a week, then weekly backups for a month, then monthly backups
    • \n
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}},"urlObject":{"path":["oauth","api","v1","backups","prune-schedule","{site.id}"],"host":["https://my.gridpane.com"],"query":[],"variable":[]}},"response":[{"id":"162c2711-32c9-4dc6-a08e-95df6d0fe8e4","name":"Set site local backups prune schedule to daily backups with a retention of 30 days","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"backup_type\": \"local\",\n \"retain_days\": 30,\n \"prune_schedule\": 0\n}\n","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/backups/prune-schedule/{site.id}"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"215798dc-6797-4cf7-b9c0-8df8bd03d038"},{"name":"Remove remote backup integration from site","id":"652e0fb2-222e-47f9-ba43-f619bcafe7c6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"integrations_id\": {integer}\n}\n\n","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/backups/integrations/{site.id}","description":"

Detach a remote backup integration from a site

\n

integration_id - integer - required

\n

ID of the remote backup integration you wish to remove.

\n

Use a GET site backup integrations to get this ID and confirm removal.

\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}},"urlObject":{"path":["oauth","api","v1","backups","integrations","{site.id}"],"host":["https://my.gridpane.com"],"query":[],"variable":[]}},"response":[{"id":"78936051-a51c-43f6-8356-331ec928a590","name":"Remove remote backup integration 23 from a site","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{oath_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"integrations_id\": 23\n}\n\n","options":{"raw":{"language":"json"}}},"url":"https://my.gridpane.com/oauth/api/v1/backups/integrations/42"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"652e0fb2-222e-47f9-ba43-f619bcafe7c6"}],"id":"33a8dbac-2d61-44e9-bf34-31b74184142c","_postman_id":"33a8dbac-2d61-44e9-bf34-31b74184142c","description":"","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","id":"8a2ed308-3d9d-4678-a13d-b2639b9296a7","name":"gp oauth api documentation","type":"collection"}}}],"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"grant_type","value":""}]}},"event":[{"listen":"prerequest","script":{"id":"8664d3fb-0b44-45a6-91e1-8494ea7d6464","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"f4a80dd7-ac3b-4f87-81e8-e27b09e13945","type":"text/javascript","exec":[""]}}],"variable":[{"key":"gp_url","value":"https://my.gridpane.com"},{"key":"access_token","value":"{{oath_token}}"}]}