{"openapi":"3.0.0","info":{"title":"Sucuri Accounts API","description":"Central API for managing Sucuri accounts across all clients.","version":"1.5.4"},"paths":{"\/accounts":{"get":{"tags":["Accounts"],"summary":"Get a list of accounts.","operationId":"getAccounts","parameters":[{"name":"limit","in":"query","description":"Number of records to return","schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Number of records to skip","schema":{"type":"integer"}},{"name":"plan_id","in":"query","description":"Plan ID filter","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"List of records","content":{"application\/json":{"schema":{"title":"Get Account List Response Success","properties":{"total":{"description":"Total number of records","type":"integer"},"limit":{"description":"Number of records to return","type":"integer"},"offset":{"description":"Number of records to skip","type":"integer"},"accounts":{"description":"List of records","type":"array","items":{"$ref":"#\/components\/schemas\/Account"}}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]},"post":{"tags":["Accounts"],"summary":"Creates an Account.","operationId":"createAccount","requestBody":{"required":true,"content":{"application\/json":{"schema":{"title":"Create Account Request Body","required":["legacy_account_id"],"properties":{"account_id":{"description":"Account ID","type":"string","format":"uuid"},"legacy_account_id":{"description":"Legacy Account ID","type":"string"},"client_id":{"description":"Client ID, only necessary when using Master authentication","type":"string","format":"uuid"},"primary_user_id":{"description":"Primary User ID","type":"string","format":"uuid"},"shopper_id":{"description":"GoDaddy Shopper ID","type":"string"},"customer_id":{"description":"GoDaddy Customer ID","type":"string","format":"uuid"},"legacy_params":{"description":"Legacy parameters that do not fit into this schema","type":"object"},"plans":{"description":"Array of plans for this account. Each entry in the array should be an array with two values, plan_id and quantity","type":"array","items":{"$ref":"#\/components\/schemas\/NewAccountPlan"}},"servers":{"description":"List of server IDs this account should be associated with","type":"array","items":{"type":"string","format":"uuid"}},"email":{"description":"Email address","type":"string"},"display_name":{"description":"First and last (or whatever combination is applicable)","type":"string"},"locale":{"description":"Locale","type":"string"},"tzone":{"description":"Time zone","type":"string"},"created_at":{"description":"Original account creation timestamp","type":"string"},"bacchus":{"description":"Has this account been backfilled into Bacchus?","type":"boolean"},"recurly_id":{"description":"Recurly Account ID","type":"string","nullable":true}},"type":"object"}}}},"responses":{"201":{"description":"Created","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/FullAccount"}}}},"400":{"description":"Bad Request","content":{"application\/json":{"schema":{"title":"BadRequestResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"409":{"description":"Conflict","content":{"application\/json":{"schema":{"title":"ConflictResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/accounts\/{account_id}":{"get":{"tags":["Accounts"],"summary":"Get an account.","description":"Read a single Account.","operationId":"getAccount","parameters":[{"name":"account_id","in":"path","description":"ID of account to read","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/FullAccount"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"404":{"description":"Not Found","content":{"application\/json":{"schema":{"title":"Get Account Response Not Found","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]},"delete":{"tags":["Accounts"],"summary":"Deletes an Account.","operationId":"deleteAccount","parameters":[{"name":"account_id","in":"path","description":"ID of account to delete","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"No Content"},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]},"patch":{"tags":["Accounts"],"summary":"Patch an account.","description":"Update an Account, sending only the keys necessary.","operationId":"updateAccount","parameters":[{"name":"account_id","in":"path","description":"ID of account to update","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/FullAccount"}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/FullAccount"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"404":{"description":"NotFound","content":{"application\/json":{"schema":{"title":"NotFoundResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"409":{"description":"Conflict","content":{"application\/json":{"schema":{"title":"ConflictResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/accounts\/entitlements":{"post":{"tags":["Accounts"],"summary":"Creates an Entitlement record.","operationId":"createEntitlement","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Entitlement"}}}},"responses":{"201":{"description":"Created","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Entitlement"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"409":{"description":"Conflict","content":{"application\/json":{"schema":{"title":"ConflictResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/accounts\/entitlements\/{entitlement_id}":{"get":{"tags":["Accounts"],"summary":"Get an entitlement by ID.","description":"Read a single Entitlement by ID.","operationId":"getEntitlement","parameters":[{"name":"entitlement_id","in":"path","description":"ID of entitlement to read","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Entitlement"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"404":{"description":"Not Found","content":{"application\/json":{"schema":{"title":"Get Entitlement Response Not Found","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]},"delete":{"tags":["Accounts"],"summary":"Removes an entitlement.","operationId":"deleteAccountEntitlement","parameters":[{"name":"entitlement_id","in":"path","description":"ID of entitlement","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"Entitlement deleted successfully"},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]},"patch":{"tags":["Accounts"],"summary":"Patch an entitlement.","description":"Update an entitlement.","operationId":"updateEntitlement","parameters":[{"name":"entitlement_id","in":"path","description":"ID of entitlement to update","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application\/json":{"schema":{"title":"Update Entitlement Request Body","required":["account_plan_id","plan_flags"],"properties":{"account_plan_id":{"description":"Account Plan ID","type":"string","format":"uuid"},"plan_flags":{"description":"Plan flags","type":"integer"},"plan_uuid":{"description":"Plan UUID, optional","type":"string"},"entitlement_limit":{"description":"Entitlement limit, optional","type":"integer"}},"type":"object"}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Entitlement"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/accounts\/plans\/{account_plan_id}\/entitlements":{"get":{"tags":["Accounts"],"summary":"Get a list of entitlements belonging to an account plan.","operationId":"getAccountPlanEntitlements","parameters":[{"name":"account_plan_id","in":"path","description":"ID of account plan","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"limit","in":"query","description":"Number of records to return","schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Number of records to skip","schema":{"type":"integer"}}],"responses":{"200":{"description":"List of records","content":{"application\/json":{"schema":{"title":"Get Entitlements List Response Success","properties":{"total":{"description":"Total number of records","type":"integer"},"limit":{"description":"Number of records to return","type":"integer"},"offset":{"description":"Number of records to skip","type":"integer"},"entitlements":{"description":"List of records","type":"array","items":{"$ref":"#\/components\/schemas\/Entitlement"}}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/accounts\/{account_id}\/entitlements":{"get":{"tags":["Accounts"],"summary":"Get a list of entitlements belonging to an account.","operationId":"getEntitlements","parameters":[{"name":"account_id","in":"path","description":"ID of account","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"limit","in":"query","description":"Number of records to return","schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Number of records to skip","schema":{"type":"integer"}}],"responses":{"200":{"description":"List of records","content":{"application\/json":{"schema":{"title":"Get Entitlements List Response Success","properties":{"total":{"description":"Total number of records","type":"integer"},"limit":{"description":"Number of records to return","type":"integer"},"offset":{"description":"Number of records to skip","type":"integer"},"entitlements":{"description":"List of records","type":"array","items":{"$ref":"#\/components\/schemas\/Entitlement"}}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/accounts\/{account_id}\/idp":{"get":{"tags":["Identity Providers"],"summary":"Get an Identity Provider by account ID.","description":"Read a single Identity Provider.","operationId":"getIdentityProviderByAccountId","parameters":[{"name":"account_id","in":"path","description":"Account ID of Identity Provider to read","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/IdentityProvider"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"404":{"description":"Not Found","content":{"application\/json":{"schema":{"title":"NotFoundResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/accounts\/legacy\/":{"post":{"tags":["Accounts"],"summary":"Get an account by legacy ID.","description":"Read a single Account by legacy ID.","operationId":"getAccountByLegacyID","requestBody":{"required":true,"content":{"application\/json":{"schema":{"title":"Legacy Account Request Body","properties":{"legacy_account_id":{"description":"Legacy ID of account to read","type":"string"}},"type":"object"}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/FullAccount"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"404":{"description":"Not Found","content":{"application\/json":{"schema":{"title":"Get Legacy Account Response Not Found","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/accounts\/merge":{"post":{"tags":["Accounts"],"summary":"Merges two Accounts into one. This operation is non-reversible and could potentially fail if,\nfor example, the accounts do not belong to the same client or they both have Identity Providers.","description":"Use the `dry_run` parameter to commit or discard any changes that would be made.","operationId":"mergeAccounts","requestBody":{"required":true,"content":{"application\/json":{"schema":{"title":"Merge Account Request Body","required":["account_id","new_account_id"],"properties":{"account_id":{"description":"Source Account ID","type":"string","format":"uuid"},"new_account_id":{"description":"Destination Account ID","type":"string","format":"uuid"},"dry_run":{"description":"Boolean value to commit or rollback after merge is calculated","type":"boolean"}},"type":"object"}}}},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application\/json":{"schema":{"title":"BadRequestResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"409":{"description":"Conflict","content":{"application\/json":{"schema":{"title":"ConflictResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/accounts\/{account_id}\/plans":{"get":{"tags":["Accounts"],"summary":"Get a list of plans belonging to an account.","operationId":"getAccountPlans","parameters":[{"name":"account_id","in":"path","description":"ID of account","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"limit","in":"query","description":"Number of records to return","schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Number of records to skip","schema":{"type":"integer"}}],"responses":{"200":{"description":"List of records","content":{"application\/json":{"schema":{"title":"Get Account Plan List Response Success","properties":{"total":{"description":"Total number of records","type":"integer"},"limit":{"description":"Number of records to return","type":"integer"},"offset":{"description":"Number of records to skip","type":"integer"},"plans":{"description":"List of records","type":"array","items":{"$ref":"#\/components\/schemas\/AccountPlan"}}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]},"post":{"tags":["Accounts"],"summary":"Assigns a plan to an account.","description":"Associate an Account with a Plan.","operationId":"createAccountPlan","parameters":[{"name":"account_id","in":"path","description":"ID of account","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"title":"Create Account Plan Request Body","required":["plan_id","plan_limit"],"properties":{"plan_id":{"description":"Plan ID","type":"string","format":"uuid"},"plan_limit":{"description":"Plan limit","type":"integer"},"plan_uuid":{"description":"Plan UUID, optional","type":"string"},"plan_source":{"description":"Plan source (e.g., recurly), optional","type":"string"}},"type":"object"}}}},"responses":{"201":{"description":"Created","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AccountPlan"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"409":{"description":"Conflict","content":{"application\/json":{"schema":{"title":"ConflictResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/accounts\/{account_id}\/plans\/{account_plan_id}":{"delete":{"tags":["Accounts"],"summary":"Delete an account plan.","operationId":"deleteAccountPlan","parameters":[{"name":"account_id","in":"path","description":"ID of account","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"account_plan_id","in":"path","description":"ID of account plan","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"No Content"},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/accounts\/plans\/{account_plan_id}":{"get":{"tags":["Accounts"],"summary":"Get an account plan by ID.","description":"Read a single Account Plan by ID.","operationId":"getAccountPlan","parameters":[{"name":"account_plan_id","in":"path","description":"ID of account plan to read","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AccountPlan"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"404":{"description":"Not Found","content":{"application\/json":{"schema":{"title":"Get Recurly Subscription Response Not Found","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]},"delete":{"tags":["Accounts"],"summary":"Delete an account plan.","operationId":"deleteAccountPlanById","parameters":[{"name":"account_plan_id","in":"path","description":"ID of account plan","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"No Content"},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]},"patch":{"tags":["Accounts"],"summary":"Patch an account plan.","description":"Update an account plan.","operationId":"updateAccountPlan","parameters":[{"name":"account_plan_id","in":"path","description":"ID of account plan to update","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application\/json":{"schema":{"title":"Update Account Plan Request Body","required":["plan_id","plan_limit"],"properties":{"plan_id":{"description":"Plan ID","type":"string","format":"uuid"},"plan_limit":{"description":"Plan limit","type":"integer"},"plan_uuid":{"description":"Plan UUID, optional","type":"string"},"plan_source":{"description":"Plan source (e.g., recurly), optional","type":"string"}},"type":"object"}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AccountPlan"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"404":{"description":"NotFound","content":{"application\/json":{"schema":{"title":"NotFoundResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/accounts\/{account_id}\/plans\/named\/{name}":{"get":{"tags":["Accounts"],"summary":"Get a list of plans belonging to an account with a given name.","operationId":"getAccountPlansByName","parameters":[{"name":"account_id","in":"path","description":"ID of account","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"name","in":"path","description":"Name of desired Plan","required":true,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Number of records to return","schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Number of records to skip","schema":{"type":"integer"}}],"responses":{"200":{"description":"List of records","content":{"application\/json":{"schema":{"title":"Get Account Plans Named List Response Success","properties":{"total":{"description":"Total number of records","type":"integer"},"limit":{"description":"Number of records to return","type":"integer"},"offset":{"description":"Number of records to skip","type":"integer"},"plans":{"description":"List of records","type":"array","items":{"$ref":"#\/components\/schemas\/AccountPlan"}}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/accounts\/plans":{"patch":{"tags":["Accounts"],"summary":"Set an account's plans to match the payload given here.","description":"Set an account's plans to match the payload given here.","operationId":"syncAccountPlans","requestBody":{"content":{"application\/json":{"schema":{"title":"Set Account Plans Request Body","required":["legacy_account_id","plans"],"properties":{"legacy_account_id":{"description":"Legacy Account ID","type":"string"},"plans":{"description":"List of records","type":"array","items":{"$ref":"#\/components\/schemas\/NewSyncAccountPlan"}}},"type":"object"}}}},"responses":{"201":{"description":"Created","content":{"application\/json":{"schema":{"title":"AccountPlanSyncResponse","description":"List of records","type":"array","items":{"$ref":"#\/components\/schemas\/NewSyncAccountPlanResponseItem"}}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"404":{"description":"NotFound","content":{"application\/json":{"schema":{"title":"NotFoundResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/accounts\/plans\/uuid\/{uuid}":{"get":{"tags":["Accounts"],"summary":"Get an account plan by UUID.","description":"Read a single Account Plan by UUID.","operationId":"getAccountPlanByUUID","parameters":[{"name":"uuid","in":"path","description":"UUID of account plan to read","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AccountPlan"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/accounts\/{account_id}\/servers":{"get":{"tags":["Accounts"],"summary":"Get a list of servers belonging to an account.","operationId":"getAccountServers","parameters":[{"name":"account_id","in":"path","description":"ID of account","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"limit","in":"query","description":"Number of records to return","schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Number of records to skip","schema":{"type":"integer"}},{"name":"type","in":"query","description":"Which type of server is this?","schema":{"type":"string","enum":["backups","firewall","monitor","support"]}}],"responses":{"200":{"description":"List of records","content":{"application\/json":{"schema":{"title":"Get Account Servers Response Success","properties":{"total":{"description":"Total number of records","type":"integer"},"limit":{"description":"Number of records to return","type":"integer"},"offset":{"description":"Number of records to skip","type":"integer"},"servers":{"description":"List of records","type":"array","items":{"$ref":"#\/components\/schemas\/Server"}}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]},"post":{"tags":["Accounts"],"summary":"Assigns a server to an account.","description":"Associate an Account with a Server. Accounts can only be associated with Servers if the Account's Client is also associated with that Server.","operationId":"createAccountServer","parameters":[{"name":"account_id","in":"path","description":"ID of account","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"title":"Create Account Server Request Body","required":["server_id"],"properties":{"server_id":{"description":"Server ID","type":"string","format":"uuid"}},"type":"object"}}}},"responses":{"201":{"description":"Created","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Server"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"409":{"description":"Conflict","content":{"application\/json":{"schema":{"title":"ConflictResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/accounts\/{account_id}\/servers\/{server_id}":{"delete":{"tags":["Accounts"],"summary":"Removes an account from a server.","operationId":"deleteAccountServer","parameters":[{"name":"account_id","in":"path","description":"ID of account","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"server_id","in":"path","description":"ID of server","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"Server unassigned successfully"},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/accounts\/shopper\/{shopper_id}":{"get":{"tags":["Accounts"],"summary":"Get an account.","description":"Read a single Account by Shopper ID.","operationId":"getAccountByShopperID","parameters":[{"name":"shopper_id","in":"path","description":"Shopper ID of user of account to read","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/FullAccount"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"404":{"description":"Not Found","content":{"application\/json":{"schema":{"title":"Get Account Response Not Found","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/accounts\/{account_id}\/sites":{"get":{"tags":["Accounts"],"summary":"Get a list of sites belonging to an account.","operationId":"getAccountSites","parameters":[{"name":"account_id","in":"path","description":"ID of account","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"limit","in":"query","description":"Number of records to return","schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Number of records to skip","schema":{"type":"integer"}}],"responses":{"200":{"description":"List of records","content":{"application\/json":{"schema":{"title":"Get Account Sites Response Success","properties":{"total":{"description":"Total number of records","type":"integer"},"limit":{"description":"Number of records to return","type":"integer"},"offset":{"description":"Number of records to skip","type":"integer"},"sites":{"description":"List of records","type":"array","items":{"$ref":"#\/components\/schemas\/Site"}}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"deprecated":true,"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/accounts\/some":{"post":{"tags":["Accounts"],"summary":"Get a list of some accounts.","operationId":"getSomeAccounts","requestBody":{"required":true,"content":{"application\/json":{"schema":{"title":"Some Accounts Request Body","properties":{"ids":{"description":"Array of Account IDs","type":"array","items":{"type":"string","format":"uuid"}}},"type":"object"}}}},"responses":{"200":{"description":"List of records","content":{"application\/json":{"schema":{"title":"Get Some Account List Response Success","properties":{"accounts":{"description":"List of records","type":"array","items":{"$ref":"#\/components\/schemas\/Account"}}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/agency\/tokens":{"get":{"tags":["Agency Tokens"],"summary":"Get a list of agency tokens.","operationId":"getAgencyTokens","parameters":[{"name":"limit","in":"query","description":"Number of records to return","schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Number of records to skip","schema":{"type":"integer"}}],"responses":{"200":{"description":"List of records","content":{"application\/json":{"schema":{"title":"Get Agency Token List Response Success","properties":{"total":{"description":"Total number of records","type":"integer"},"limit":{"description":"Number of records to return","type":"integer"},"offset":{"description":"Number of records to skip","type":"integer"},"tokens":{"description":"List of records","type":"array","items":{"type":"object"}}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]},"post":{"tags":["Agency Tokens"],"summary":"Creates an Agency Token, used to begin an account with a \"special\" agency plan.","operationId":"createAgencyToken","requestBody":{"required":true,"content":{"application\/json":{"schema":{"title":"Create Agency Token Request Body","properties":{"email":{"description":"Email address the token will be sent to","type":"string"},"quantity":{"description":"Quantity of sites for the new Agency account","type":"integer"},"price_in_cents":{"description":"How much the plan costs the Agency account, in US cents (100 is one dollar)","type":"integer"},"price_per_site":{"description":"Determines if the price given is for all sites or per site","type":"integer"},"frequency":{"description":"How often the Agency account gets charged price_in_cents","type":"string","enum":["Monthly","Annually"]}},"type":"object"}}}},"responses":{"201":{"description":"Created","content":{"application\/json":{"schema":{"title":"Create Agency Token Response Success","type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/agency\/tokens\/{token}":{"get":{"tags":["Agency Tokens"],"summary":"Get an Agency token.","description":"Read a single Agency Token.","operationId":"getAgencyToken","parameters":[{"name":"token","in":"path","description":"Token to read","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"title":"Get Agency Token Response Success","properties":{"token":{"description":"Agency token","type":"string"},"email":{"description":"Email address the token will be sent to","type":"string"},"client_id":{"description":"Client ID for this token. If present, this token has been sent to a customer.","type":"string","format":"uuid"},"account_id":{"description":"Account ID for this token. Only set once the token has been started.","type":"string","format":"uuid"},"quantity":{"description":"Quantity of sites for the new Agency account","type":"integer"},"price_in_cents":{"description":"How much the plan costs the Agency account, in US cents (100 is one dollar)","type":"integer"},"price_per_site":{"description":"Determines if the price given is for all sites or per site","type":"integer"},"frequency":{"description":"How often the Agency account gets charged price_in_cents","type":"string","enum":["Monthly","Annually"]},"created_at":{"description":"When this token was created","type":"string"}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]},"delete":{"tags":["Agency Tokens"],"summary":"Deletes an Agency token.","operationId":"deleteAgencyToken","parameters":[{"name":"token","in":"path","description":"Token to delete","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]},"patch":{"tags":["Agency Tokens"],"summary":"Patch an agency token.","description":"Update an Agency Token, sending only the keys necessary.","operationId":"updateAgencyToken","parameters":[{"name":"token","in":"path","description":"Token to update","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"title":"Update Agency Token Request Body","properties":{"email":{"description":"Email address the token will be sent to","type":"string"},"account_id":{"description":"Account ID for this token. Only set once the token has been started.","type":"string","format":"uuid"},"quantity":{"description":"Quantity of sites for the new Agency account","type":"integer"},"price_in_cents":{"description":"How much the plan costs the Agency account, in US cents (100 is one dollar)","type":"integer"},"price_per_site":{"description":"Determines if the price given is for all sites or per site","type":"integer"},"frequency":{"description":"How often the Agency account gets charged price_in_cents","type":"string","enum":["Monthly","Annually"]}},"type":"object"}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"title":"Patch Agency Token Response Success","properties":{"token":{"description":"Updated token information","type":"object"}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"404":{"description":"NotFound","content":{"application\/json":{"schema":{"title":"NotFoundResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/authenticate":{"post":{"tags":["Authentication"],"summary":"Send client credentials via POST to retrieve a JWT authentication token.","description":"Send client credentials via POST to retrieve a JWT authentication token.","operationId":"authenticate","requestBody":{"content":{"application\/json":{"schema":{"title":"Authenticate Request Body","properties":{"public_key":{"description":"Client public key string.","type":"string"},"private_key":{"description":"Client private key string.","type":"string"}},"type":"object"}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"title":"Authenticate Response Success","properties":{"jwt":{"description":"JWT token string.","type":"string"}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"gatewayAuth":[]}]}},"\/billing\/recurly\/accounts\/{account_id}\/invoices":{"get":{"tags":["Billing"],"summary":"Get a list of Recurly invoices for an account.","operationId":"getRecurlyInvoices","parameters":[{"name":"account_id","in":"path","description":"ID of account","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"410":{"description":"Gone","content":{"application\/json":{"schema":{"title":"GoneResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}},"200":{"description":"OK","content":{"application\/json":{"schema":{"title":"Get Recurly Account Invoice List Response Success","properties":{"invoices":{"description":"List of invoices","type":"array","items":{"properties":{"invoice_number":{"description":"Invoice number","type":"integer","deprecated":true},"state":{"description":"Invoice state (paid, etc)","type":"string","deprecated":true},"created_at":{"description":"Invoice created date","type":"object","deprecated":true},"total_in_cents":{"description":"Invoice total, in cents","type":"integer","deprecated":true},"currency":{"description":"Invoice currency code","type":"string","deprecated":true}},"type":"object"},"deprecated":true}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}},"404":{"description":"Not Found","content":{"application\/json":{"schema":{"title":"Get Recurly Account Invoice List Response Not Found","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}}},"deprecated":true,"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/billing\/recurly\/account\/{account_id}":{"get":{"tags":["Billing"],"summary":"Get a single Recurly account (deprecated).","operationId":"getRecurlyAccount","parameters":[{"name":"account_id","in":"path","description":"Account ID","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"410":{"description":"Gone - This endpoint has been deprecated","content":{"application\/json":{"schema":{"title":"GoneResponse","properties":{"messages":{"description":"Error messages explaining that the endpoint is deprecated","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}}},"deprecated":true,"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/billing\/recurly\/accounts\/{account_id}":{"patch":{"tags":["Billing"],"summary":"Update a Recurly account.","description":"Update a Recurly account.","operationId":"updateRecurlyAccount","parameters":[{"name":"account_id","in":"path","description":"Account ID","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"title":"Update Recurly Account Request Body","properties":{"token":{"description":"Billing Info JS token","type":"string","deprecated":true}},"type":"object"}}}},"responses":{"410":{"description":"Gone","content":{"application\/json":{"schema":{"title":"GoneResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}},"200":{"description":"OK","content":{"application\/json":{"schema":{"title":"Patch Recurly Account Response Success","properties":{"account":{"description":"Account details","properties":{"account_code":{"description":"Account Code","type":"string","deprecated":true},"state":{"description":"State","type":"string","deprecated":true},"email":{"description":"Email address","type":"string","deprecated":true},"first_name":{"description":"First name","type":"string","deprecated":true},"last_name":{"description":"Last name","type":"string","deprecated":true},"address":{"description":"Address","type":"object","deprecated":true},"created_at":{"description":"Account creation date","type":"object","deprecated":true},"updated_at":{"description":"Account updated date","type":"object","deprecated":true},"closed_at":{"description":"Account closed date","type":"object","deprecated":true},"has_live_subscription":{"description":"Account has a live subscription","type":"boolean","deprecated":true},"has_active_subscription":{"description":"Account has an active subscription","type":"boolean","deprecated":true},"has_future_subscription":{"description":"Account has a future subscription","type":"boolean","deprecated":true},"has_canceled_subscription":{"description":"Account has a canceled subscription","type":"boolean","deprecated":true},"has_past_due_invoice":{"description":"Account has a past due invoice","type":"boolean","deprecated":true}},"type":"object","deprecated":true}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}}},"deprecated":true,"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/billing\/recurly\/accounts\/{account_id}\/subscriptions":{"get":{"tags":["Billing"],"summary":"Get a list of Recurly subscriptions for an account.","operationId":"getRecurlySubscriptions","parameters":[{"name":"account_id","in":"path","description":"ID of account","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"410":{"description":"Gone","content":{"application\/json":{"schema":{"title":"GoneResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}},"200":{"description":"OK","content":{"application\/json":{"schema":{"title":"Get Recurly Account Subscription List Response Success","properties":{"subscriptions":{"description":"List of subscriptions","type":"array","items":{"properties":{"uuid":{"description":"Subscription UUID","type":"string","deprecated":true},"plan":{"description":"Subscription Plan Code","type":"string","deprecated":true},"quantity":{"description":"Site limit","type":"integer","deprecated":true},"state":{"description":"Subscription state","type":"string","deprecated":true},"activated_at":{"description":"Subscription activation date","type":"object","deprecated":true},"canceled_at":{"description":"Subscription canceled date","type":"object","deprecated":true},"expires_at":{"description":"Subscription expires date","type":"object","deprecated":true},"updated_at":{"description":"Subscription updated date","type":"object","deprecated":true}},"type":"object"},"deprecated":true}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}},"404":{"description":"Not Found","content":{"application\/json":{"schema":{"title":"Get Recurly Account Subscription List Response Not Found","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}}},"deprecated":true,"security":[{"sucuriAuth":[],"gatewayAuth":[]}]},"post":{"tags":["Billing"],"summary":"Create a new Recurly subscription for an account (deprecated).","operationId":"createRecurlySubscription","parameters":[{"name":"account_id","in":"path","description":"ID of account","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"title":"Create Recurly Subscription Request Body","properties":{"plan_code":{"description":"Plan code","type":"string","deprecated":true},"quantity":{"description":"Quantity","type":"integer","deprecated":true}},"type":"object"}}}},"responses":{"410":{"description":"Gone - This endpoint has been deprecated","content":{"application\/json":{"schema":{"title":"GoneResponse","properties":{"messages":{"description":"Error messages explaining that the endpoint is deprecated","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}}},"deprecated":true,"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/billing\/recurly\/invoices\/{invoice_number}":{"get":{"tags":["Billing"],"summary":"Get a Recurly invoice by number.","description":"Read a single Invoice by invoice number.","operationId":"getRecurlyInvoice","parameters":[{"name":"invoice_number","in":"path","description":"Invoice number","required":true,"schema":{"type":"string"}}],"responses":{"410":{"description":"Gone","content":{"application\/json":{"schema":{"title":"GoneResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"deprecated":true,"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/billing\/recurly\/pubkey":{"get":{"tags":["Billing"],"summary":"Get the Recurly public JS key used in UI for generating forms.","operationId":"getRecurlyPubkey","responses":{"410":{"description":"Gone - This endpoint has been deprecated","content":{"application\/json":{"schema":{"title":"GoneResponse","properties":{"messages":{"description":"Error messages explaining that the endpoint is deprecated","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}}},"deprecated":true,"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/billing\/recurly\/subscriptions\/{uuid}":{"get":{"tags":["Billing"],"summary":"Get a single Recurly subscription (deprecated).","operationId":"getRecurlySubscription","parameters":[{"name":"uuid","in":"path","description":"Subscription UUID","required":true,"schema":{"type":"string"}}],"responses":{"410":{"description":"Gone - This endpoint has been deprecated","content":{"application\/json":{"schema":{"title":"GoneResponse","properties":{"messages":{"description":"Error messages explaining that the endpoint is deprecated","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}}},"deprecated":true,"security":[{"sucuriAuth":[],"gatewayAuth":[]}]},"delete":{"tags":["Billing"],"summary":"Cancel a Recurly subscription.","description":"Cancel a Subscription.","operationId":"cancelRecurlySubscription","parameters":[{"name":"uuid","in":"path","description":"Subscription UUID","required":true,"schema":{"type":"string"}}],"responses":{"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}},"410":{"description":"Gone","content":{"application\/json":{"schema":{"title":"GoneResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}}},"deprecated":true,"security":[{"sucuriAuth":[],"gatewayAuth":[]}]},"patch":{"tags":["Billing"],"summary":"Update a Recurly subscription.","description":"Update a Subscription.","operationId":"updateRecurlySubscription","parameters":[{"name":"uuid","in":"path","description":"Subscription UUID","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"title":"Update Subscription Request Body","properties":{"quantity":{"description":"New quantity","type":"integer","deprecated":true}},"type":"object"}}}},"responses":{"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}},"410":{"description":"Gone","content":{"application\/json":{"schema":{"title":"GoneResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}}},"deprecated":true,"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/billing\/recurly\/webhook\/{public_key}":{"post":{"tags":["Billing"],"summary":"Handle Recurly webhook requests. See https:\/\/developers.recurly.com\/pages\/webhooks.html for request body details.","operationId":"handleRecurlyWebhook","parameters":[{"name":"public_key","in":"path","description":"Sucuri Accounts API Public Key","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application\/xml":{"schema":{"description":"Recurly webhook XML payload","type":"object"}}}},"responses":{"410":{"description":"Gone","content":{"application\/json":{"schema":{"title":"GoneResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}},"200":{"description":"OK","content":{"application\/json":{"schema":{"title":"Recurly Webhook Response Success","type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}}},"deprecated":true}},"\/clients\/{client_id}\/auths\/{api_key}":{"delete":{"tags":["Clients"],"summary":"Removes a key from a client.","operationId":"deleteClientAuth","parameters":[{"name":"client_id","in":"path","description":"ID of client","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"api_key","in":"path","description":"Api Key to delete","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/clients\/{client_id}\/auths":{"get":{"tags":["Clients"],"summary":"Get a list of auths belonging to a client.","operationId":"getClientAuths","parameters":[{"name":"client_id","in":"path","description":"ID of client","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"limit","in":"query","description":"Number of records to return","schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Number of records to skip","schema":{"type":"integer"}}],"responses":{"200":{"description":"List of records","content":{"application\/json":{"schema":{"title":"Get Client Auths List Response Success","properties":{"total":{"description":"Total number of records","type":"integer"},"limit":{"description":"Number of records to return","type":"integer"},"offset":{"description":"Number of records to skip","type":"integer"},"auths":{"description":"List of auths","type":"array","items":{"$ref":"#\/components\/schemas\/ClientAuth"}}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]},"post":{"tags":["Clients"],"summary":"Updates a single client's API keys.","operationId":"updateClientAuths","parameters":[{"name":"client_id","in":"path","description":"ID of client","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ClientAuthBody"}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"title":"Update Client Key Response Success","properties":{"key_id":{"description":"Key ID","type":"string","format":"uuid"},"public_key":{"description":"Client public key (username)","type":"string"},"private_key":{"description":"Client private key (password)","type":"string"}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/clients":{"get":{"tags":["Clients"],"summary":"Get a list of clients.","operationId":"getClients","parameters":[{"name":"limit","in":"query","description":"Number of records to return","schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Number of records to skip","schema":{"type":"integer"}}],"responses":{"200":{"description":"List of records","content":{"application\/json":{"schema":{"title":"Get Client List Response Success","properties":{"total":{"description":"Total number of records","type":"integer"},"limit":{"description":"Number of records to return","type":"integer"},"offset":{"description":"Number of records to skip","type":"integer"},"clients":{"description":"List of records","type":"array","items":{"$ref":"#\/components\/schemas\/Client"}}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]},"post":{"tags":["Clients"],"summary":"Creates a Client.","operationId":"createClient","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Client"}}}},"responses":{"201":{"description":"Created","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Client"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"409":{"description":"Conflict","content":{"application\/json":{"schema":{"title":"ConflictResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/clients\/{client_id}":{"get":{"tags":["Clients"],"summary":"Get a Client.","description":"Read a single Client.","operationId":"getClient","parameters":[{"name":"client_id","in":"path","description":"ID of client to read","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Client"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"404":{"description":"Not Found","content":{"application\/json":{"schema":{"title":"Get Recurly Subscription Response Not Found","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]},"delete":{"tags":["Clients"],"summary":"Deletes a Client.","operationId":"deleteClient","parameters":[{"name":"client_id","in":"path","description":"ID of client to delete","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"No Content"},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]},"patch":{"tags":["Clients"],"summary":"Patch a client.","description":"Update a Client, sending only the keys necessary.","operationId":"updateClient","parameters":[{"name":"client_id","in":"path","description":"ID of client to update","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Client"}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Client"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"404":{"description":"NotFound","content":{"application\/json":{"schema":{"title":"NotFoundResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/clients\/{client_id}\/keys\/{key_id}":{"delete":{"tags":["Clients"],"summary":"Removes a key from a client.","operationId":"deleteClientKey","parameters":[{"name":"client_id","in":"path","description":"ID of client","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"key_id","in":"path","description":"ID of key","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"No Content"},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/clients\/{client_id}\/keys":{"get":{"tags":["Clients"],"summary":"Get a list of keys belonging to a client.","operationId":"getClientKeys","parameters":[{"name":"client_id","in":"path","description":"ID of client","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"limit","in":"query","description":"Number of records to return","schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Number of records to skip","schema":{"type":"integer"}}],"responses":{"200":{"description":"List of records","content":{"application\/json":{"schema":{"title":"Get Client Keys List Response Success","properties":{"total":{"description":"Total number of records","type":"integer"},"limit":{"description":"Number of records to return","type":"integer"},"offset":{"description":"Number of records to skip","type":"integer"},"keys":{"description":"List of keys","type":"array","items":{"$ref":"#\/components\/schemas\/ClientKey"}}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]},"delete":{"tags":["Clients"],"summary":"Updates a single client's API keys.","operationId":"updateClientKeys","parameters":[{"name":"client_id","in":"path","description":"ID of client","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"title":"Update Client Key Response Success","properties":{"key_id":{"description":"Key ID","type":"string","format":"uuid"},"public_key":{"description":"Client public key (username)","type":"string"},"private_key":{"description":"Client private key (password)","type":"string"}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/clients\/{client_id}\/servers":{"get":{"tags":["Clients"],"summary":"Get a list of servers belonging to a client.","operationId":"getClientServers","parameters":[{"name":"client_id","in":"path","description":"ID of client","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"limit","in":"query","description":"Number of records to return","schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Number of records to skip","schema":{"type":"integer"}}],"responses":{"200":{"description":"List of records","content":{"application\/json":{"schema":{"title":"Get Client Server List Response Success","properties":{"total":{"description":"Total number of records","type":"integer"},"limit":{"description":"Number of records to return","type":"integer"},"offset":{"description":"Number of records to skip","type":"integer"},"servers":{"description":"List of records","type":"array","items":{"$ref":"#\/components\/schemas\/Server"}}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]},"post":{"tags":["Clients"],"summary":"Assigns a server to a client.","description":"Associate a Client with a Server. Clients must be associated with a Server in order for their Accounts to be associated.","operationId":"addClientToServer","parameters":[{"name":"client_id","in":"path","description":"ID of client","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"title":"Create Client Server Request Body","properties":{"server_id":{"description":"Server ID","type":"string","format":"uuid"}},"type":"object"}}}},"responses":{"201":{"description":"Created","content":{"application\/json":{"schema":{"title":"Create Client Server Response Success","type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"409":{"description":"Conflict","content":{"application\/json":{"schema":{"title":"ConflictResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/clients\/{client_id}\/servers\/{server_id}":{"delete":{"tags":["Clients"],"summary":"Removes a server from a client.","operationId":"removeClientFromServer","parameters":[{"name":"client_id","in":"path","description":"ID of client","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"server_id","in":"path","description":"ID of server","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"No Content"},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/clients\/some":{"post":{"tags":["Clients"],"summary":"Get a list of some clients.","operationId":"getSomeClients","requestBody":{"required":true,"content":{"application\/json":{"schema":{"title":"Some Clients Request Body","properties":{"ids":{"description":"Array of Client IDs","type":"array","items":{"type":"string","format":"uuid"}}},"type":"object"}}}},"responses":{"200":{"description":"List of records","content":{"application\/json":{"schema":{"title":"Get Some Clients List Response Success","properties":{"clients":{"description":"List of records","type":"array","items":{"$ref":"#\/components\/schemas\/Client"}}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/healthcheck\/deep":{"get":{"tags":["Healthchecks"],"summary":"Deep healthcheck to verify upstream services","operationId":"healthcheckDeep","responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"properties":{"status":{"description":"Status of the request","type":"string"}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"gatewayAuth":[]}]}},"\/healthcheck\/ping":{"get":{"tags":["Healthchecks"],"summary":"Shallow health check to verify service is up","operationId":"healthcheckPing","responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"properties":{"status":{"description":"Status of the request","type":"string"}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"gatewayAuth":[]}]}},"\/idp":{"get":{"tags":["Identity Providers"],"summary":"Get a list of Identity Providers.","operationId":"getIdentityProviders","parameters":[{"name":"limit","in":"query","description":"Number of records to return","schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Number of records to skip","schema":{"type":"integer"}}],"responses":{"200":{"description":"List of records","content":{"application\/json":{"schema":{"title":"Get Identity Provider List Response Success","properties":{"total":{"description":"Total number of records","type":"integer"},"limit":{"description":"Number of records to return","type":"integer"},"offset":{"description":"Number of records to skip","type":"integer"},"idps":{"description":"List of records","type":"array","items":{"$ref":"#\/components\/schemas\/IdentityProvider"}}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]},"post":{"tags":["Identity Providers"],"summary":"Creates an Identity Provider.","operationId":"createIdentityProvider","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/IdentityProvider"}}}},"responses":{"201":{"description":"Created","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/IdentityProvider"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"409":{"description":"Conflict","content":{"application\/json":{"schema":{"title":"ConflictResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/idp\/{idp_id}":{"get":{"tags":["Identity Providers"],"summary":"Get an Identity Provider.","description":"Read a single Identity Provider.","operationId":"getIdentityProvider","parameters":[{"name":"idp_id","in":"path","description":"ID of Identity Provider to read","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/IdentityProvider"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"404":{"description":"Not Found","content":{"application\/json":{"schema":{"title":"Get Recurly Subscription Response Not Found","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]},"delete":{"tags":["Identity Providers"],"summary":"Deletes an Identity Provider.","operationId":"deleteIdentityProvider","parameters":[{"name":"idp_id","in":"path","description":"ID of Identity Provider to delete","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"No Content"},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]},"patch":{"tags":["Identity Providers"],"summary":"Patch an Identity Provider.","description":"Update an Identity Provider, sending only the keys necessary.","operationId":"updateIdentityProvider","parameters":[{"name":"idp_id","in":"path","description":"ID of Identity Provider to update","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/IdentityProvider"}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/IdentityProvider"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"404":{"description":"NotFound","content":{"application\/json":{"schema":{"title":"NotFoundResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/idp\/named\/{slug}":{"get":{"tags":["Identity Providers"],"summary":"Get an Identity Provider by slug.","description":"Read a single Identity Provider.","operationId":"getIdentityProviderBySlug","parameters":[{"name":"slug","in":"path","description":"Slug of Identity Provider to read","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/IdentityProvider"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/idp\/{idp_id}\/roles":{"get":{"tags":["Identity Providers"],"summary":"Get a list of roles belonging to an user.","description":"Get a paginated list of Identity Provider Roles.","operationId":"getIdentityProviderRoles","parameters":[{"name":"idp_id","in":"path","description":"ID of Identity Provider","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"limit","in":"query","description":"Number of records to return","schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Number of records to skip","schema":{"type":"integer"}}],"responses":{"200":{"description":"List of records","content":{"application\/json":{"schema":{"title":"Get Identity Provider Role List Response Success","properties":{"total":{"description":"Total number of records","type":"integer"},"limit":{"description":"Number of records to return","type":"integer"},"offset":{"description":"Number of records to skip","type":"integer"},"roles":{"description":"List of records","type":"array","items":{"$ref":"#\/components\/schemas\/IdentityProviderRole"}}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]},"post":{"tags":["Identity Providers"],"summary":"Maps a role to an Identity Provider memberOf value.","operationId":"addIdentityProviderToRole","parameters":[{"name":"idp_id","in":"path","description":"ID of Identity Provider","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"title":"Create Identity Provider Role Request Body","required":["role_id"],"properties":{"role_id":{"description":"Role ID","type":"string","format":"uuid"},"member_of":{"description":"Identity Provider memberOf value.","type":"string"}},"type":"object"}}}},"responses":{"201":{"description":"Created","content":{"application\/json":{"schema":{"title":"Create Identity Provider Role Response Success","type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"409":{"description":"Conflict","content":{"application\/json":{"schema":{"title":"ConflictResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/idp\/{idp_id}\/roles\/{role_id}":{"delete":{"tags":["Identity Providers"],"summary":"Removes a role from a user.","operationId":"removeIdentityProviderFromRole","parameters":[{"name":"idp_id","in":"path","description":"ID of Identity Provider","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"role_id","in":"path","description":"ID of role","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"No Content"},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/locales":{"get":{"tags":["Locales"],"summary":"Get a list of locales.","operationId":"getLocales","parameters":[{"name":"limit","in":"query","description":"Number of records to return","schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Number of records to skip","schema":{"type":"integer"}}],"responses":{"200":{"description":"List of records","content":{"application\/json":{"schema":{"title":"Get Locale List Response Success","properties":{"total":{"description":"Total number of records","type":"integer"},"limit":{"description":"Number of records to return","type":"integer"},"offset":{"description":"Number of records to skip","type":"integer"},"locales":{"description":"List of records","type":"array","items":{"$ref":"#\/components\/schemas\/Locale"}}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]},"post":{"tags":["Locales"],"summary":"Creates a Locale.","operationId":"createLocale","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Locale"}}}},"responses":{"201":{"description":"Created","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Locale"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"409":{"description":"Conflict","content":{"application\/json":{"schema":{"title":"ConflictResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/locales\/{locale_id}":{"get":{"tags":["Locales"],"summary":"Get a Locale.","description":"Read a single Locale.","operationId":"getLocale","parameters":[{"name":"locale_id","in":"path","description":"ID of locale to read","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Locale"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"404":{"description":"Not Found","content":{"application\/json":{"schema":{"title":"Get Locale Response Not Found","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]},"delete":{"tags":["Locales"],"summary":"Deletes a Locale.","operationId":"deleteLocale","parameters":[{"name":"locale_id","in":"path","description":"ID of locale to delete","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"No Content"},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]},"patch":{"tags":["Locales"],"summary":"Patch a locale.","description":"Update a Locale, sending only the keys necessary.","operationId":"updateLocale","parameters":[{"name":"locale_id","in":"path","description":"ID of locale to update","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Locale"}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Locale"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"404":{"description":"NotFound","content":{"application\/json":{"schema":{"title":"NotFoundResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/locales\/named\/{code}":{"get":{"tags":["Locales"],"summary":"Get a Locale.","description":"Read a single Locale.","operationId":"getLocaleByName","parameters":[{"name":"code","in":"path","description":"String of locale to read, e.g. en_US","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Locale"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/locales\/some":{"post":{"tags":["Locales"],"summary":"Get a list of some locales.","operationId":"getSomeLocales","requestBody":{"required":true,"content":{"application\/json":{"schema":{"title":"Some Locales Request Body","properties":{"ids":{"description":"Array of Locale IDs","type":"array","items":{"type":"string","format":"uuid"}}},"type":"object"}}}},"responses":{"200":{"description":"List of records","content":{"application\/json":{"schema":{"title":"Get Some Locales List Response Success","properties":{"locales":{"description":"List of records","type":"array","items":{"$ref":"#\/components\/schemas\/Locale"}}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/nps":{"post":{"tags":["NPS"],"summary":"Creates a new NPS record for a user. Deprecated, use PATCH \/users\/{user_id}.","operationId":"createNetPromoterScore","requestBody":{"required":true,"content":{"application\/json":{"schema":{"title":"Create NPS Request Body","required":["user_id"],"properties":{"user_id":{"description":"User ID.","type":"string","format":"uuid","deprecated":true}},"type":"object"}}}},"responses":{"201":{"description":"Created","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/User"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}},"409":{"description":"Conflict","content":{"application\/json":{"schema":{"title":"ConflictResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}}},"deprecated":true,"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/plans":{"get":{"tags":["Plans"],"summary":"Get a list of plans.","operationId":"getPlans","parameters":[{"name":"limit","in":"query","description":"Number of records to return","schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Number of records to skip","schema":{"type":"integer"}}],"responses":{"200":{"description":"List of records","content":{"application\/json":{"schema":{"title":"Get Plan List Response Success","properties":{"total":{"description":"Total number of records","type":"integer"},"limit":{"description":"Number of records to return","type":"integer"},"offset":{"description":"Number of records to skip","type":"integer"},"plans":{"description":"List of records","type":"array","items":{"$ref":"#\/components\/schemas\/Plan"}}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]},"post":{"tags":["Plans"],"summary":"Creates a Plan.","operationId":"createPlan","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Plan"}}}},"responses":{"201":{"description":"Created","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Plan"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"409":{"description":"Conflict","content":{"application\/json":{"schema":{"title":"ConflictResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/plans\/{plan_id}":{"get":{"tags":["Plans"],"summary":"Get a plan.","description":"Read a single Plan.","operationId":"getPlan","parameters":[{"name":"plan_id","in":"path","description":"ID of plan to read","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Plan"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"404":{"description":"Not Found","content":{"application\/json":{"schema":{"title":"Get Recurly Subscription Response Not Found","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]},"delete":{"tags":["Plans"],"summary":"Deletes a Plan.","operationId":"deletePlan","parameters":[{"name":"plan_id","in":"path","description":"ID of plan to delete","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"No Content"},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]},"patch":{"tags":["Plans"],"summary":"Patch a plan.","description":"Update a Plan, sending only the keys necessary.","operationId":"updatePlan","parameters":[{"name":"plan_id","in":"path","description":"ID of plan to update","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Plan"}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Plan"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"404":{"description":"NotFound","content":{"application\/json":{"schema":{"title":"NotFoundResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/plans\/flags":{"get":{"tags":["Plans"],"summary":"Get a list of plan flags.","operationId":"getPlanFlags","responses":{"200":{"description":"List of records","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/PlanFlags"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/plans\/named\/{name}":{"get":{"tags":["Plans"],"summary":"Get a plan by name.","description":"Read a single Plan by name.","operationId":"getPlanByName","parameters":[{"name":"name","in":"path","description":"Name of plan","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Plan"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/plans\/some":{"post":{"tags":["Plans"],"summary":"Get a list of some plans.","operationId":"getSomePlans","requestBody":{"required":true,"content":{"application\/json":{"schema":{"title":"Some Plans Request Body","properties":{"ids":{"description":"Array of Site IDs","type":"array","items":{"type":"string","format":"uuid"}}},"type":"object"}}}},"responses":{"200":{"description":"List of records","content":{"application\/json":{"schema":{"title":"Get Some Site List Response Success","properties":{"plans":{"description":"List of records","type":"array","items":{"$ref":"#\/components\/schemas\/Site"}}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/roles":{"get":{"tags":["Roles"],"summary":"Get a list of roles.","operationId":"getRoles","parameters":[{"name":"limit","in":"query","description":"Number of records to return","schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Number of records to skip","schema":{"type":"integer"}},{"name":"account_id","in":"query","description":"Filter by account","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"List of records","content":{"application\/json":{"schema":{"title":"Get Role List Response Success","properties":{"total":{"description":"Total number of records","type":"integer"},"limit":{"description":"Number of records to return","type":"integer"},"offset":{"description":"Number of records to skip","type":"integer"},"roles":{"description":"List of records","type":"array","items":{"$ref":"#\/components\/schemas\/Role"}}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]},"post":{"tags":["Roles"],"summary":"Creates a Role.","operationId":"createRole","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Role"}}}},"responses":{"201":{"description":"Created","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Role"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"409":{"description":"Conflict","content":{"application\/json":{"schema":{"title":"ConflictResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/roles\/{role_id}":{"get":{"tags":["Roles"],"summary":"Get a Role.","description":"Read a single Role.","operationId":"getRole","parameters":[{"name":"role_id","in":"path","description":"ID of role to read","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Role"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"404":{"description":"Not Found","content":{"application\/json":{"schema":{"title":"Get Recurly Subscription Response Not Found","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]},"delete":{"tags":["Roles"],"summary":"Deletes a Role.","operationId":"deleteRole","parameters":[{"name":"role_id","in":"path","description":"ID of role to delete","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"No Content"},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]},"patch":{"tags":["Roles"],"summary":"Patch a role.","description":"Update a Role, sending only the keys necessary.","operationId":"updateRole","parameters":[{"name":"role_id","in":"path","description":"ID of role to update","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Role"}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Role"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"404":{"description":"NotFound","content":{"application\/json":{"schema":{"title":"NotFoundResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/roles\/{role_id}\/tasks":{"get":{"tags":["Roles"],"summary":"Get a list of tasks belonging to a role.","operationId":"getRoleTasks","parameters":[{"name":"role_id","in":"path","description":"ID of role","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"limit","in":"query","description":"Number of records to return","schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Number of records to skip","schema":{"type":"integer"}}],"responses":{"200":{"description":"List of records","content":{"application\/json":{"schema":{"title":"Get Role Task List Response Success","properties":{"total":{"description":"Total number of records","type":"integer"},"limit":{"description":"Number of records to return","type":"integer"},"offset":{"description":"Number of records to skip","type":"integer"},"roles":{"description":"List of records","type":"array","items":{"$ref":"#\/components\/schemas\/Role"}}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]},"post":{"tags":["Roles"],"summary":"Creates a new task for a role.","operationId":"createRoleTask","parameters":[{"name":"role_id","in":"path","description":"ID of role","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"title":"Create Role Task Request Body","properties":{"task":{"description":"A task name using dot-delimited path formatting.","type":"string"},"permissions":{"description":"Bitmask, Create = 1, Read = 2, Update = 4, Delete = 8","type":"integer"}},"type":"object"}}}},"responses":{"201":{"description":"Created","content":{"application\/json":{"schema":{"title":"Create Role Task Response Success","type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"409":{"description":"Conflict","content":{"application\/json":{"schema":{"title":"ConflictResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/":{"get":{"tags":["Documentation"],"summary":"Generates JSON for use in Swagger to document this API.","operationId":"generateSwagger","responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"title":"Get Swagger Response Success","type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"gatewayAuth":[]}]}},"\/servers":{"get":{"tags":["Servers"],"summary":"Get a list of servers.","operationId":"getServers","parameters":[{"name":"limit","in":"query","description":"Number of records to return","schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Number of records to skip","schema":{"type":"integer"}},{"name":"type","in":"query","description":"Which type of server is this?","schema":{"type":"string","enum":["backups","firewall","monitor","support"]}},{"name":"open","in":"query","description":"Is this server accepting new accounts?","schema":{"type":"boolean"}}],"responses":{"200":{"description":"List of records","content":{"application\/json":{"schema":{"title":"Get Server List Response Success","properties":{"total":{"description":"Total number of records","type":"integer"},"limit":{"description":"Number of records to return","type":"integer"},"offset":{"description":"Number of records to skip","type":"integer"},"servers":{"description":"List of records","type":"array","items":{"$ref":"#\/components\/schemas\/Server"}}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]},"post":{"tags":["Servers"],"summary":"Creates a Server.","operationId":"createServer","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Server"}}}},"responses":{"201":{"description":"Created","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Server"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"409":{"description":"Conflict","content":{"application\/json":{"schema":{"title":"ConflictResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/servers\/{server_id}":{"get":{"tags":["Servers"],"summary":"Get a Server.","description":"Read a single Server.","operationId":"getServer","parameters":[{"name":"server_id","in":"path","description":"ID of server to read","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Server"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"404":{"description":"Not Found","content":{"application\/json":{"schema":{"title":"Get Recurly Subscription Response Not Found","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]},"delete":{"tags":["Servers"],"summary":"Deletes a Server.","operationId":"deleteServer","parameters":[{"name":"server_id","in":"path","description":"ID of server to delete","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"No Content"},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]},"patch":{"tags":["Servers"],"summary":"Patch a server.","description":"Update a Server, sending only the keys necessary.","operationId":"updateServer","parameters":[{"name":"server_id","in":"path","description":"ID of server to update","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Server"}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Server"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"404":{"description":"NotFound","content":{"application\/json":{"schema":{"title":"NotFoundResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/servers\/flags":{"get":{"tags":["Servers"],"summary":"Get a list of server flags.","operationId":"getServerFlags","responses":{"200":{"description":"List of records","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ServerFlags"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/servers\/named":{"post":{"tags":["Servers"],"summary":"Get a Server by domain name.","description":"Read a single Server by domain name.","operationId":"getServerByDomainName","requestBody":{"content":{"application\/json":{"schema":{"title":"Server Named Request Body","properties":{"domain_name":{"description":"Domain name of server to read","type":"string"}},"type":"object"}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Server"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"404":{"description":"Not Found","content":{"application\/json":{"schema":{"title":"NotFoundResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/servers\/random\/{server_type}":{"get":{"tags":["Servers"],"summary":"Assigns a random server to an account.","description":"Get a random Server ID based on type.","operationId":"getRandomServer","parameters":[{"name":"server_type","in":"path","description":"Server type","required":true,"schema":{"type":"string","enum":["backups","firewall","monitor","support"]}},{"name":"client_id","in":"query","description":"Client ID used to filter servers. This is only available when using master keys.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Server"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/servers\/some":{"post":{"tags":["Servers"],"summary":"Get a list of some sites.","operationId":"getSomeServers","requestBody":{"required":true,"content":{"application\/json":{"schema":{"title":"Some Servers Request Body","properties":{"ids":{"description":"Array of Server IDs","type":"array","items":{"type":"string","format":"uuid"}}},"type":"object"}}}},"responses":{"200":{"description":"List of records","content":{"application\/json":{"schema":{"title":"Get Some Server List Response Success","properties":{"sites":{"description":"List of records","type":"array","items":{"$ref":"#\/components\/schemas\/Server"}}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/sites":{"get":{"tags":["Sites"],"summary":"Get a list of Sites.","operationId":"getSites","parameters":[{"name":"limit","in":"query","description":"Number of records to return","schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Number of records to skip","schema":{"type":"integer"}},{"name":"domain_name","in":"query","description":"Optional domain name filter","schema":{"type":"string"}}],"responses":{"200":{"description":"List of records","content":{"application\/json":{"schema":{"title":"Get Site List Response Success","properties":{"total":{"description":"Total number of records","type":"integer","deprecated":true},"limit":{"description":"Number of records to return","type":"integer","deprecated":true},"offset":{"description":"Number of records to skip","type":"integer","deprecated":true},"sites":{"description":"List of records","type":"array","items":{"$ref":"#\/components\/schemas\/Site"},"deprecated":true}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}},"410":{"description":"Gone","content":{"application\/json":{"schema":{"title":"GoneResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}}},"deprecated":true,"security":[{"sucuriAuth":[],"gatewayAuth":[]}]},"post":{"tags":["Sites"],"summary":"Creates a Site.","operationId":"createSite","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Site"}}}},"responses":{"201":{"description":"Created","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Site"}}}},"400":{"description":"Bad Request","content":{"application\/json":{"schema":{"title":"BadRequestResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}},"409":{"description":"Conflict","content":{"application\/json":{"schema":{"title":"ConflictResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}},"410":{"description":"Gone","content":{"application\/json":{"schema":{"title":"GoneResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}}},"deprecated":true,"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/sites\/{site_id}":{"get":{"tags":["Sites"],"summary":"Get a Site.","description":"Read a single Site.","operationId":"getSite","parameters":[{"name":"site_id","in":"path","description":"ID of site to read","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Site"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}},"404":{"description":"Not Found","content":{"application\/json":{"schema":{"title":"Get Recurly Subscription Response Not Found","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}},"410":{"description":"Gone","content":{"application\/json":{"schema":{"title":"GoneResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}}},"deprecated":true,"security":[{"sucuriAuth":[],"gatewayAuth":[]}]},"delete":{"tags":["Sites"],"summary":"Deletes a Site.","operationId":"deleteSite","parameters":[{"name":"site_id","in":"path","description":"ID of site to delete","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"No Content"},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}},"410":{"description":"Gone","content":{"application\/json":{"schema":{"title":"GoneResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}}},"deprecated":true,"security":[{"sucuriAuth":[],"gatewayAuth":[]}]},"patch":{"tags":["Sites"],"summary":"Patch a site.","description":"Update a Site, sending only the keys necessary.","operationId":"updateSite","parameters":[{"name":"site_id","in":"path","description":"ID of site to update","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Site"}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Site"}}}},"400":{"description":"Bad Request","content":{"application\/json":{"schema":{"title":"BadRequestResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}},"404":{"description":"NotFound","content":{"application\/json":{"schema":{"title":"NotFoundResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}},"410":{"description":"Gone","content":{"application\/json":{"schema":{"title":"GoneResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}}},"deprecated":true,"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/sites\/some":{"post":{"tags":["Sites"],"summary":"Get a list of some sites.","operationId":"getSomeSites","requestBody":{"required":true,"content":{"application\/json":{"schema":{"title":"Some Sites Request Body","properties":{"ids":{"description":"Array of Site IDs","type":"array","items":{"type":"string","format":"uuid"},"deprecated":true}},"type":"object"}}}},"responses":{"200":{"description":"List of records","content":{"application\/json":{"schema":{"title":"Get Some Site List Response Success","properties":{"sites":{"description":"List of records","type":"array","items":{"$ref":"#\/components\/schemas\/Site"},"deprecated":true}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}},"410":{"description":"Gone","content":{"application\/json":{"schema":{"title":"GoneResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}}},"deprecated":true,"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/users\/analytics\/":{"post":{"tags":["Users"],"summary":"Find users based on their analytics hash.","description":"Find users based on their analytics hash.","operationId":"getUsersByAnalyticsHash","requestBody":{"required":true,"content":{"application\/json":{"schema":{"title":"Find User By Analytics Hash Request Body","properties":{"analytics_hash":{"description":"Analytics hash, used briefly to associate Sucuri customers with 3rd party analytics services.","type":"string"},"limit":{"description":"Number of records to return","type":"integer"},"offset":{"description":"Number of records to skip","type":"integer"}},"type":"object"}}}},"responses":{"200":{"description":"List of records","content":{"application\/json":{"schema":{"title":"Find User By Analytics Hash Response Success","properties":{"total":{"description":"Total number of records","type":"integer"},"limit":{"description":"Number of records to return","type":"integer"},"offset":{"description":"Number of records to skip","type":"integer"},"users":{"description":"List of records","type":"array","items":{"$ref":"#\/components\/schemas\/User"}}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/users":{"get":{"tags":["Users"],"summary":"Get a list of users.","description":"Get a paginated list of Users.","operationId":"getUsers","parameters":[{"name":"limit","in":"query","description":"Number of records to return","schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Number of records to skip","schema":{"type":"integer"}},{"name":"account_id","in":"query","description":"Account ID filter","schema":{"type":"string","format":"uuid"}},{"name":"has_2fa","in":"query","description":"Filter users by whether they have 2FA enabled (1 for true, 0 for false)","schema":{"type":"integer","enum":[0,1]}}],"responses":{"200":{"description":"List of records","content":{"application\/json":{"schema":{"title":"Get User List Response Success","properties":{"total":{"description":"Total number of records","type":"integer"},"limit":{"description":"Number of records to return","type":"integer"},"offset":{"description":"Number of records to skip","type":"integer"},"users":{"description":"List of records","type":"array","items":{"$ref":"#\/components\/schemas\/User"}}},"type":"object"}}}},"400":{"description":"Bad Request","content":{"application\/json":{"schema":{"title":"BadRequestResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]},"post":{"tags":["Users"],"summary":"Creates a User.","operationId":"createUser","requestBody":{"required":true,"content":{"application\/json":{"schema":{"title":"Create User Request Body","properties":{"user_id":{"description":"User ID","type":"string","format":"uuid"},"account_id":{"description":"Account ID","type":"string","format":"uuid"},"shopper_id":{"description":"GoDaddy Shopper ID","type":"string"},"customer_id":{"description":"Customer ID","type":"string","format":"uuid"},"email":{"description":"Email address","type":"string"},"display_name":{"description":"First and last (or whatever combination is applicable)","type":"string"},"locale":{"description":"Locale","type":"string"},"tzone":{"description":"Time zone","type":"string"},"enabled":{"description":"Can the user log in","type":"boolean"},"nps_collected":{"description":"Has this user submitted NPS?","type":"boolean"},"created_at":{"description":"Original user creation timestamp","type":"string"}},"type":"object"}}}},"responses":{"201":{"description":"Created","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/FullUser"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"409":{"description":"Conflict","content":{"application\/json":{"schema":{"title":"ConflictResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/users\/customer\/{customer_id}":{"get":{"tags":["Users"],"summary":"Get a User by Customer ID.","description":"Read a single User by Customer ID.","operationId":"getUserByCustomerID","parameters":[{"name":"customer_id","in":"path","description":"Customer ID of user to read","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/FullUser"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"404":{"description":"Not Found","content":{"application\/json":{"schema":{"title":"Get User By Customer Response Not Found","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/users\/{user_id}":{"get":{"tags":["Users"],"summary":"Get a User.","description":"Read a single User.","operationId":"getUser","parameters":[{"name":"user_id","in":"path","description":"ID of user to read","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/FullUser"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"404":{"description":"Not Found","content":{"application\/json":{"schema":{"title":"Get Recurly Subscription Response Not Found","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]},"delete":{"tags":["Users"],"summary":"Deletes a User.","operationId":"deleteUser","parameters":[{"name":"user_id","in":"path","description":"ID of user to delete","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"No Content"},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]},"patch":{"tags":["Users"],"summary":"Patch a user.","description":"Update a User, sending only the keys necessary.","operationId":"updateUser","parameters":[{"name":"user_id","in":"path","description":"ID of user to update","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"title":"Patch User Request Body","properties":{"user_id":{"description":"User ID","type":"string","format":"uuid"},"account_id":{"description":"Account ID","type":"string","format":"uuid"},"shopper_id":{"description":"GoDaddy Shopper ID","type":"string"},"customer_id":{"description":"Customer ID","type":"string","format":"uuid"},"email":{"description":"Email address","type":"string"},"display_name":{"description":"First and last (or whatever combination is applicable)","type":"string"},"locale":{"description":"Locale","type":"string"},"tzone":{"description":"Time zone","type":"string"},"enabled":{"description":"Can the user log in","type":"boolean"},"nps_collected":{"description":"Has this user submitted NPS?","type":"boolean"}},"type":"object"}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/FullUser"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"404":{"description":"NotFound","content":{"application\/json":{"schema":{"title":"NotFoundResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/users\/find\/":{"post":{"tags":["Users"],"summary":"Find users based on their email address.","description":"Find users based on their email address.","operationId":"getUsersByEmail","requestBody":{"required":true,"content":{"application\/json":{"schema":{"title":"Find User Request Body","properties":{"email":{"description":"Email address","type":"string"},"limit":{"description":"Number of records to return","type":"integer"},"offset":{"description":"Number of records to skip","type":"integer"}},"type":"object"}}}},"responses":{"200":{"description":"List of records","content":{"application\/json":{"schema":{"title":"Find User Response Success","properties":{"total":{"description":"Total number of records","type":"integer"},"limit":{"description":"Number of records to return","type":"integer"},"offset":{"description":"Number of records to skip","type":"integer"},"users":{"description":"List of records","type":"array","items":{"$ref":"#\/components\/schemas\/User"}}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/login":{"post":{"tags":["Users"],"summary":"Use POST data to check login credentials (email + password) against the user database.","description":"Compares a given email and password combination with the ones stored in the database.","operationId":"login","requestBody":{"content":{"application\/json":{"schema":{"title":"Login Request Body","properties":{"email":{"description":"Email address","type":"string","deprecated":true},"password":{"description":"Password","type":"string","deprecated":true}},"type":"object"}}}},"responses":{"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}},"410":{"description":"Gone","content":{"application\/json":{"schema":{"title":"GoneResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}}},"deprecated":true,"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/users\/{user_id}\/roles":{"get":{"tags":["Users"],"summary":"Get a list of roles belonging to an user.","operationId":"getUserRoles","parameters":[{"name":"user_id","in":"path","description":"ID of user","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"limit","in":"query","description":"Number of records to return","schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Number of records to skip","schema":{"type":"integer"}}],"responses":{"200":{"description":"List of records","content":{"application\/json":{"schema":{"title":"Get User Roles List Response Success","properties":{"total":{"description":"Total number of records","type":"integer"},"limit":{"description":"Number of records to return","type":"integer"},"offset":{"description":"Number of records to skip","type":"integer"},"roles":{"description":"List of records","type":"array","items":{"$ref":"#\/components\/schemas\/Role"}}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]},"post":{"tags":["Users"],"summary":"Assigns a role to a user.","operationId":"addUserToRole","parameters":[{"name":"user_id","in":"path","description":"ID of user","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"title":"Create User Role Request Body","required":["role_id"],"properties":{"role_id":{"description":"Role ID","type":"string","format":"uuid"}},"type":"object"}}}},"responses":{"201":{"description":"Created","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Role"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"409":{"description":"Conflict","content":{"application\/json":{"schema":{"title":"ConflictResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/users\/{user_id}\/roles\/{role_id}":{"delete":{"tags":["Users"],"summary":"Removes a role from a user.","operationId":"removeUserFromRole","parameters":[{"name":"user_id","in":"path","description":"ID of user","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"role_id","in":"path","description":"ID of role","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"No Content"},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/users\/{user_id}\/session":{"get":{"tags":["Users"],"summary":"Get a User Session array.","description":"Generate a data structure to be used in a session. This endpoint DOES NOT START A LOGIN SESSION.","operationId":"getSession","parameters":[{"name":"user_id","in":"path","description":"ID of the user","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Session"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/users\/shopper\/{shopper_id}":{"get":{"tags":["Users"],"summary":"Get a User by Shopper ID.","description":"Read a single User by Shopper ID.","operationId":"getUserByShopperID","parameters":[{"name":"shopper_id","in":"path","description":"Shopper ID of user to read","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/FullUser"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"404":{"description":"Not Found","content":{"application\/json":{"schema":{"title":"Get Recurly Subscription Response Not Found","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/users\/some":{"post":{"tags":["Users"],"summary":"Get a list of some users.","operationId":"getSomeUsers","requestBody":{"required":true,"content":{"application\/json":{"schema":{"title":"Some Users Request Body","properties":{"ids":{"description":"Array of User IDs","type":"array","items":{"type":"string","format":"uuid"}}},"type":"object"}}}},"responses":{"200":{"description":"List of records","content":{"application\/json":{"schema":{"title":"Get Some User List Response Success","properties":{"users":{"description":"List of records","type":"array","items":{"$ref":"#\/components\/schemas\/User"}}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/users\/{user_id}\/tokens":{"post":{"tags":["Users"],"summary":"Creates a User Token, used to log in via whitelabel (where no password is stored).","operationId":"createLoginToken","parameters":[{"name":"user_id","in":"path","description":"ID of user","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application\/json":{"schema":{"title":"Create Login Token Request Body","properties":{"type":{"description":"Token type","type":"string","enum":["1time","1day","1hour"],"deprecated":true}},"type":"object"}}}},"responses":{"201":{"description":"Created","content":{"application\/json":{"schema":{"title":"Create Login Token Response Success","properties":{"token":{"description":"Login Token","type":"string","deprecated":true}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}}},"deprecated":true,"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/token":{"post":{"tags":["Users"],"summary":"Read login information from a token. This action may cause the token to be removed.","operationId":"useLoginToken","requestBody":{"required":true,"content":{"application\/json":{"schema":{"title":"User Login Token Request Body","required":["token"],"properties":{"token":{"description":"Login Token","type":"string","deprecated":true}},"type":"object"}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"title":"User Login Token Response Success","properties":{"user_id":{"description":"User ID associated with token","type":"string","format":"uuid","deprecated":true}},"type":"object"}}}},"400":{"description":"Invalid token","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}}},"deprecated":true,"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/users\/{user_id}\/2fa\/otp\/cookie":{"post":{"tags":["Users"],"summary":"Creates a new 2FA OTP cookie record.","operationId":"createTwoFactorAuthCookie","parameters":[{"name":"user_id","in":"path","description":"User ID","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"title":"Create User 2FA OTP Cookie Request Body","required":["otp_id","code"],"properties":{"otp_id":{"description":"2FA OTP ID","type":"string","format":"uuid"},"code":{"description":"2FA OTP code","type":"string"}},"type":"object"}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"title":"OKResponse","properties":{"cookie":{"description":"The 2FA OTP cookie","type":"string"}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/users\/{user_id}\/2fa\/otp\/cookie\/{cookie}":{"get":{"tags":["Users"],"summary":"Verify a 2FA OTP cookie.","description":"Read a single 2FA OTP Cookie.","operationId":"getTwoFactorAuthCookie","parameters":[{"name":"user_id","in":"path","description":"User ID","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"cookie","in":"path","description":"OTP Cookie","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"title":"OKResponse","properties":{"cookie":{"description":"The 2FA OTP cookie","type":"string","deprecated":true}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/users\/{user_id}\/2fa\/otp":{"get":{"tags":["Users"],"summary":"Get a list of 2FA configurations for a user.","description":"Get a paginated list of 2FA configurations for a User.","operationId":"getTwoFactorAuth","parameters":[{"name":"user_id","in":"path","description":"ID of user","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"limit","in":"query","description":"Number of records to return","schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Number of records to skip","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"title":"OKResponse","properties":{"total":{"description":"Total number of records","type":"integer"},"limit":{"description":"Number of records to return","type":"integer"},"offset":{"description":"Number of records to skip","type":"integer"},"otp":{"description":"List of records","type":"array","items":{"$ref":"#\/components\/schemas\/UserOtp"}}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]},"post":{"tags":["Users"],"summary":"Enables 2FA for an account.","operationId":"createTwoFactorAuth","parameters":[{"name":"user_id","in":"path","description":"ID of user","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"title":"Create User 2FA OTP Request Body","required":["domain","path"],"properties":{"otp_id":{"description":"OTP ID","type":"string","format":"uuid"},"otp_type":{"description":"2FA Type, one of: hotp, totp","type":"string","enum":["hotp","totp"]},"domain":{"description":"2FA Domain","type":"string"},"password":{"description":"2FA Password","type":"string"},"path":{"description":"2FA Path","type":"string"}},"type":"object"}}}},"responses":{"201":{"description":"Created","content":{"application\/json":{"schema":{"title":"CreatedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]},"delete":{"tags":["Users"],"summary":"Deletes User 2FA.","operationId":"deleteTwoFactorAuth","parameters":[{"name":"user_id","in":"path","description":"ID of user","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"No Content"},"410":{"description":"Gone","content":{"application\/json":{"schema":{"title":"GoneResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/users\/{user_id}\/2fa\/otp\/{otp_id}":{"patch":{"tags":["Users"],"summary":"Patch a user's OTP.","description":"Update a user's OTP, sending only the keys necessary.","operationId":"updateUserOTP","parameters":[{"name":"user_id","in":"path","description":"ID of user to update","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"otp_id","in":"path","description":"ID of OTP to update","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"title":"Patch User OTP Request Body","properties":{"otp_type":{"description":"OTP Type, either 'totp' or 'hotp'","type":"string","enum":["totp","hotp"]},"counter":{"description":"Counter, for HOTP only","type":"integer"},"domain":{"description":"Domain, for display purposes only","type":"string"},"path":{"description":"Path, for display purposes only","type":"string"},"password":{"description":"The base32 encoded secret","type":"string"}},"type":"object"}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/UserOtp"}}}},"400":{"description":"Bad Request","content":{"application\/json":{"schema":{"title":"BadRequestResponse","properties":{"messages":{"type":"array","items":{"type":"string"}}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"type":"array","items":{"type":"string"}}},"type":"object"}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"title":"ForbiddenResponse","properties":{"messages":{"type":"array","items":{"type":"string"}}},"type":"object"}}}},"404":{"description":"Not Found","content":{"application\/json":{"schema":{"title":"NotFoundResponse","properties":{"messages":{"type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/v1\/accounts":{"get":{"tags":["Accounts"],"summary":"Get a list of accounts.","operationId":"v1_getAccounts","parameters":[{"name":"limit","in":"query","description":"Number of records to return","schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Number of records to skip","schema":{"type":"integer"}},{"name":"plan_id","in":"query","description":"Plan ID filter","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"List of records","content":{"application\/json":{"schema":{"title":"Get Account List Response Success","properties":{"total":{"description":"Total number of records","type":"integer"},"limit":{"description":"Number of records to return","type":"integer"},"offset":{"description":"Number of records to skip","type":"integer"},"accounts":{"description":"List of records","type":"array","items":{"$ref":"#\/components\/schemas\/Account"}}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]},"post":{"tags":["Accounts"],"summary":"Creates an Account.","operationId":"v1_createAccount","requestBody":{"required":true,"content":{"application\/json":{"schema":{"title":"Create Account Request Body","required":["legacy_account_id"],"properties":{"account_id":{"description":"Account ID","type":"string","format":"uuid"},"legacy_account_id":{"description":"Legacy Account ID","type":"string"},"client_id":{"description":"Client ID, only necessary when using Master authentication","type":"string","format":"uuid"},"primary_user_id":{"description":"Primary User ID","type":"string","format":"uuid"},"shopper_id":{"description":"GoDaddy Shopper ID","type":"string"},"customer_id":{"description":"GoDaddy Customer ID","type":"string","format":"uuid"},"legacy_params":{"description":"Legacy parameters that do not fit into this schema","type":"object"},"plans":{"description":"Array of plans for this account. Each entry in the array should be an array with two values, plan_id and quantity","type":"array","items":{"$ref":"#\/components\/schemas\/NewAccountPlan"}},"servers":{"description":"List of server IDs this account should be associated with","type":"array","items":{"type":"string","format":"uuid"}},"email":{"description":"Email address","type":"string"},"display_name":{"description":"First and last (or whatever combination is applicable)","type":"string"},"locale":{"description":"Locale","type":"string"},"tzone":{"description":"Time zone","type":"string"},"created_at":{"description":"Original account creation timestamp","type":"string"},"bacchus":{"description":"Has this account been backfilled into Bacchus?","type":"boolean"},"recurly_id":{"description":"Recurly Account ID","type":"string","nullable":true}},"type":"object"}}}},"responses":{"201":{"description":"Created","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/FullAccount"}}}},"400":{"description":"Bad Request","content":{"application\/json":{"schema":{"title":"BadRequestResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"409":{"description":"Conflict","content":{"application\/json":{"schema":{"title":"ConflictResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/v1\/accounts\/{account_id}":{"get":{"tags":["Accounts"],"summary":"Get an account.","description":"Read a single Account.","operationId":"v1_getAccount","parameters":[{"name":"account_id","in":"path","description":"ID of account to read","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/FullAccount"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"404":{"description":"Not Found","content":{"application\/json":{"schema":{"title":"Get Account Response Not Found","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]},"delete":{"tags":["Accounts"],"summary":"Deletes an Account.","operationId":"v1_deleteAccount","parameters":[{"name":"account_id","in":"path","description":"ID of account to delete","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"No Content"},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]},"patch":{"tags":["Accounts"],"summary":"Patch an account.","description":"Update an Account, sending only the keys necessary.","operationId":"v1_updateAccount","parameters":[{"name":"account_id","in":"path","description":"ID of account to update","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/FullAccount"}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/FullAccount"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"404":{"description":"NotFound","content":{"application\/json":{"schema":{"title":"NotFoundResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"409":{"description":"Conflict","content":{"application\/json":{"schema":{"title":"ConflictResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/v1\/accounts\/entitlements":{"post":{"tags":["Accounts"],"summary":"Creates an Entitlement record.","operationId":"v1_createEntitlement","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Entitlement"}}}},"responses":{"201":{"description":"Created","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Entitlement"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"409":{"description":"Conflict","content":{"application\/json":{"schema":{"title":"ConflictResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/v1\/accounts\/entitlements\/{entitlement_id}":{"get":{"tags":["Accounts"],"summary":"Get an entitlement by ID.","description":"Read a single Entitlement by ID.","operationId":"v1_getEntitlement","parameters":[{"name":"entitlement_id","in":"path","description":"ID of entitlement to read","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Entitlement"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"404":{"description":"Not Found","content":{"application\/json":{"schema":{"title":"Get Entitlement Response Not Found","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]},"delete":{"tags":["Accounts"],"summary":"Removes an entitlement.","operationId":"v1_deleteAccountEntitlement","parameters":[{"name":"entitlement_id","in":"path","description":"ID of entitlement","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"Entitlement deleted successfully"},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]},"patch":{"tags":["Accounts"],"summary":"Patch an entitlement.","description":"Update an entitlement.","operationId":"v1_updateEntitlement","parameters":[{"name":"entitlement_id","in":"path","description":"ID of entitlement to update","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application\/json":{"schema":{"title":"Update Entitlement Request Body","required":["account_plan_id","plan_flags"],"properties":{"account_plan_id":{"description":"Account Plan ID","type":"string","format":"uuid"},"plan_flags":{"description":"Plan flags","type":"integer"},"plan_uuid":{"description":"Plan UUID, optional","type":"string"},"entitlement_limit":{"description":"Entitlement limit, optional","type":"integer"}},"type":"object"}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Entitlement"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/v1\/accounts\/plans\/{account_plan_id}\/entitlements":{"get":{"tags":["Accounts"],"summary":"Get a list of entitlements belonging to an account plan.","operationId":"v1_getAccountPlanEntitlements","parameters":[{"name":"account_plan_id","in":"path","description":"ID of account plan","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"limit","in":"query","description":"Number of records to return","schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Number of records to skip","schema":{"type":"integer"}}],"responses":{"200":{"description":"List of records","content":{"application\/json":{"schema":{"title":"Get Entitlements List Response Success","properties":{"total":{"description":"Total number of records","type":"integer"},"limit":{"description":"Number of records to return","type":"integer"},"offset":{"description":"Number of records to skip","type":"integer"},"entitlements":{"description":"List of records","type":"array","items":{"$ref":"#\/components\/schemas\/Entitlement"}}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/v1\/accounts\/{account_id}\/entitlements":{"get":{"tags":["Accounts"],"summary":"Get a list of entitlements belonging to an account.","operationId":"v1_getEntitlements","parameters":[{"name":"account_id","in":"path","description":"ID of account","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"limit","in":"query","description":"Number of records to return","schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Number of records to skip","schema":{"type":"integer"}}],"responses":{"200":{"description":"List of records","content":{"application\/json":{"schema":{"title":"Get Entitlements List Response Success","properties":{"total":{"description":"Total number of records","type":"integer"},"limit":{"description":"Number of records to return","type":"integer"},"offset":{"description":"Number of records to skip","type":"integer"},"entitlements":{"description":"List of records","type":"array","items":{"$ref":"#\/components\/schemas\/Entitlement"}}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/v1\/accounts\/{account_id}\/idp":{"get":{"tags":["Identity Providers"],"summary":"Get an Identity Provider by account ID.","description":"Read a single Identity Provider.","operationId":"v1_getIdentityProviderByAccountId","parameters":[{"name":"account_id","in":"path","description":"Account ID of Identity Provider to read","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/IdentityProvider"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"404":{"description":"Not Found","content":{"application\/json":{"schema":{"title":"NotFoundResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/v1\/accounts\/legacy\/":{"post":{"tags":["Accounts"],"summary":"Get an account by legacy ID.","description":"Read a single Account by legacy ID.","operationId":"v1_getAccountByLegacyID","requestBody":{"required":true,"content":{"application\/json":{"schema":{"title":"Legacy Account Request Body","properties":{"legacy_account_id":{"description":"Legacy ID of account to read","type":"string"}},"type":"object"}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/FullAccount"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"404":{"description":"Not Found","content":{"application\/json":{"schema":{"title":"Get Legacy Account Response Not Found","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/v1\/accounts\/merge":{"post":{"tags":["Accounts"],"summary":"Merges two Accounts into one. This operation is non-reversible and could potentially fail if,\nfor example, the accounts do not belong to the same client or they both have Identity Providers.","description":"Use the `dry_run` parameter to commit or discard any changes that would be made.","operationId":"v1_mergeAccounts","requestBody":{"required":true,"content":{"application\/json":{"schema":{"title":"Merge Account Request Body","required":["account_id","new_account_id"],"properties":{"account_id":{"description":"Source Account ID","type":"string","format":"uuid"},"new_account_id":{"description":"Destination Account ID","type":"string","format":"uuid"},"dry_run":{"description":"Boolean value to commit or rollback after merge is calculated","type":"boolean"}},"type":"object"}}}},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application\/json":{"schema":{"title":"BadRequestResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"409":{"description":"Conflict","content":{"application\/json":{"schema":{"title":"ConflictResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/v1\/accounts\/{account_id}\/plans":{"get":{"tags":["Accounts"],"summary":"Get a list of plans belonging to an account.","operationId":"v1_getAccountPlans","parameters":[{"name":"account_id","in":"path","description":"ID of account","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"limit","in":"query","description":"Number of records to return","schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Number of records to skip","schema":{"type":"integer"}}],"responses":{"200":{"description":"List of records","content":{"application\/json":{"schema":{"title":"Get Account Plan List Response Success","properties":{"total":{"description":"Total number of records","type":"integer"},"limit":{"description":"Number of records to return","type":"integer"},"offset":{"description":"Number of records to skip","type":"integer"},"plans":{"description":"List of records","type":"array","items":{"$ref":"#\/components\/schemas\/AccountPlan"}}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]},"post":{"tags":["Accounts"],"summary":"Assigns a plan to an account.","description":"Associate an Account with a Plan.","operationId":"v1_createAccountPlan","parameters":[{"name":"account_id","in":"path","description":"ID of account","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"title":"Create Account Plan Request Body","required":["plan_id","plan_limit"],"properties":{"plan_id":{"description":"Plan ID","type":"string","format":"uuid"},"plan_limit":{"description":"Plan limit","type":"integer"},"plan_uuid":{"description":"Plan UUID, optional","type":"string"},"plan_source":{"description":"Plan source (e.g., recurly), optional","type":"string"}},"type":"object"}}}},"responses":{"201":{"description":"Created","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AccountPlan"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"409":{"description":"Conflict","content":{"application\/json":{"schema":{"title":"ConflictResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/v1\/accounts\/{account_id}\/plans\/{account_plan_id}":{"delete":{"tags":["Accounts"],"summary":"Delete an account plan.","operationId":"v1_deleteAccountPlan","parameters":[{"name":"account_id","in":"path","description":"ID of account","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"account_plan_id","in":"path","description":"ID of account plan","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"No Content"},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/v1\/accounts\/plans\/{account_plan_id}":{"get":{"tags":["Accounts"],"summary":"Get an account plan by ID.","description":"Read a single Account Plan by ID.","operationId":"v1_getAccountPlan","parameters":[{"name":"account_plan_id","in":"path","description":"ID of account plan to read","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AccountPlan"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"404":{"description":"Not Found","content":{"application\/json":{"schema":{"title":"Get Recurly Subscription Response Not Found","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]},"delete":{"tags":["Accounts"],"summary":"Delete an account plan.","operationId":"v1_deleteAccountPlanById","parameters":[{"name":"account_plan_id","in":"path","description":"ID of account plan","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"No Content"},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]},"patch":{"tags":["Accounts"],"summary":"Patch an account plan.","description":"Update an account plan.","operationId":"v1_updateAccountPlan","parameters":[{"name":"account_plan_id","in":"path","description":"ID of account plan to update","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application\/json":{"schema":{"title":"Update Account Plan Request Body","required":["plan_id","plan_limit"],"properties":{"plan_id":{"description":"Plan ID","type":"string","format":"uuid"},"plan_limit":{"description":"Plan limit","type":"integer"},"plan_uuid":{"description":"Plan UUID, optional","type":"string"},"plan_source":{"description":"Plan source (e.g., recurly), optional","type":"string"}},"type":"object"}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AccountPlan"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"404":{"description":"NotFound","content":{"application\/json":{"schema":{"title":"NotFoundResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/v1\/accounts\/{account_id}\/plans\/named\/{name}":{"get":{"tags":["Accounts"],"summary":"Get a list of plans belonging to an account with a given name.","operationId":"v1_getAccountPlansByName","parameters":[{"name":"account_id","in":"path","description":"ID of account","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"name","in":"path","description":"Name of desired Plan","required":true,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Number of records to return","schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Number of records to skip","schema":{"type":"integer"}}],"responses":{"200":{"description":"List of records","content":{"application\/json":{"schema":{"title":"Get Account Plans Named List Response Success","properties":{"total":{"description":"Total number of records","type":"integer"},"limit":{"description":"Number of records to return","type":"integer"},"offset":{"description":"Number of records to skip","type":"integer"},"plans":{"description":"List of records","type":"array","items":{"$ref":"#\/components\/schemas\/AccountPlan"}}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/v1\/accounts\/plans":{"patch":{"tags":["Accounts"],"summary":"Set an account's plans to match the payload given here.","description":"Set an account's plans to match the payload given here.","operationId":"v1_syncAccountPlans","requestBody":{"content":{"application\/json":{"schema":{"title":"Set Account Plans Request Body","required":["legacy_account_id","plans"],"properties":{"legacy_account_id":{"description":"Legacy Account ID","type":"string"},"plans":{"description":"List of records","type":"array","items":{"$ref":"#\/components\/schemas\/NewSyncAccountPlan"}}},"type":"object"}}}},"responses":{"201":{"description":"Created","content":{"application\/json":{"schema":{"title":"AccountPlanSyncResponse","description":"List of records","type":"array","items":{"$ref":"#\/components\/schemas\/NewSyncAccountPlanResponseItem"}}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"404":{"description":"NotFound","content":{"application\/json":{"schema":{"title":"NotFoundResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/v1\/accounts\/plans\/uuid\/{uuid}":{"get":{"tags":["Accounts"],"summary":"Get an account plan by UUID.","description":"Read a single Account Plan by UUID.","operationId":"v1_getAccountPlanByUUID","parameters":[{"name":"uuid","in":"path","description":"UUID of account plan to read","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AccountPlan"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/v1\/accounts\/{account_id}\/servers":{"get":{"tags":["Accounts"],"summary":"Get a list of servers belonging to an account.","operationId":"v1_getAccountServers","parameters":[{"name":"account_id","in":"path","description":"ID of account","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"limit","in":"query","description":"Number of records to return","schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Number of records to skip","schema":{"type":"integer"}},{"name":"type","in":"query","description":"Which type of server is this?","schema":{"type":"string","enum":["backups","firewall","monitor","support"]}}],"responses":{"200":{"description":"List of records","content":{"application\/json":{"schema":{"title":"Get Account Servers Response Success","properties":{"total":{"description":"Total number of records","type":"integer"},"limit":{"description":"Number of records to return","type":"integer"},"offset":{"description":"Number of records to skip","type":"integer"},"servers":{"description":"List of records","type":"array","items":{"$ref":"#\/components\/schemas\/Server"}}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]},"post":{"tags":["Accounts"],"summary":"Assigns a server to an account.","description":"Associate an Account with a Server. Accounts can only be associated with Servers if the Account's Client is also associated with that Server.","operationId":"v1_createAccountServer","parameters":[{"name":"account_id","in":"path","description":"ID of account","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"title":"Create Account Server Request Body","required":["server_id"],"properties":{"server_id":{"description":"Server ID","type":"string","format":"uuid"}},"type":"object"}}}},"responses":{"201":{"description":"Created","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Server"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"409":{"description":"Conflict","content":{"application\/json":{"schema":{"title":"ConflictResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/v1\/accounts\/{account_id}\/servers\/{server_id}":{"delete":{"tags":["Accounts"],"summary":"Removes an account from a server.","operationId":"v1_deleteAccountServer","parameters":[{"name":"account_id","in":"path","description":"ID of account","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"server_id","in":"path","description":"ID of server","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"Server unassigned successfully"},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/v1\/accounts\/shopper\/{shopper_id}":{"get":{"tags":["Accounts"],"summary":"Get an account.","description":"Read a single Account by Shopper ID.","operationId":"v1_getAccountByShopperID","parameters":[{"name":"shopper_id","in":"path","description":"Shopper ID of user of account to read","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/FullAccount"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"404":{"description":"Not Found","content":{"application\/json":{"schema":{"title":"Get Account Response Not Found","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/v1\/accounts\/{account_id}\/sites":{"get":{"tags":["Accounts"],"summary":"Get a list of sites belonging to an account.","operationId":"v1_getAccountSites","parameters":[{"name":"account_id","in":"path","description":"ID of account","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"limit","in":"query","description":"Number of records to return","schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Number of records to skip","schema":{"type":"integer"}}],"responses":{"200":{"description":"List of records","content":{"application\/json":{"schema":{"title":"Get Account Sites Response Success","properties":{"total":{"description":"Total number of records","type":"integer"},"limit":{"description":"Number of records to return","type":"integer"},"offset":{"description":"Number of records to skip","type":"integer"},"sites":{"description":"List of records","type":"array","items":{"$ref":"#\/components\/schemas\/Site"}}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"deprecated":true,"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/v1\/accounts\/some":{"post":{"tags":["Accounts"],"summary":"Get a list of some accounts.","operationId":"v1_getSomeAccounts","requestBody":{"required":true,"content":{"application\/json":{"schema":{"title":"Some Accounts Request Body","properties":{"ids":{"description":"Array of Account IDs","type":"array","items":{"type":"string","format":"uuid"}}},"type":"object"}}}},"responses":{"200":{"description":"List of records","content":{"application\/json":{"schema":{"title":"Get Some Account List Response Success","properties":{"accounts":{"description":"List of records","type":"array","items":{"$ref":"#\/components\/schemas\/Account"}}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/v1\/agency\/tokens":{"get":{"tags":["Agency Tokens"],"summary":"Get a list of agency tokens.","operationId":"v1_getAgencyTokens","parameters":[{"name":"limit","in":"query","description":"Number of records to return","schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Number of records to skip","schema":{"type":"integer"}}],"responses":{"200":{"description":"List of records","content":{"application\/json":{"schema":{"title":"Get Agency Token List Response Success","properties":{"total":{"description":"Total number of records","type":"integer"},"limit":{"description":"Number of records to return","type":"integer"},"offset":{"description":"Number of records to skip","type":"integer"},"tokens":{"description":"List of records","type":"array","items":{"type":"object"}}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]},"post":{"tags":["Agency Tokens"],"summary":"Creates an Agency Token, used to begin an account with a \"special\" agency plan.","operationId":"v1_createAgencyToken","requestBody":{"required":true,"content":{"application\/json":{"schema":{"title":"Create Agency Token Request Body","properties":{"email":{"description":"Email address the token will be sent to","type":"string"},"quantity":{"description":"Quantity of sites for the new Agency account","type":"integer"},"price_in_cents":{"description":"How much the plan costs the Agency account, in US cents (100 is one dollar)","type":"integer"},"price_per_site":{"description":"Determines if the price given is for all sites or per site","type":"integer"},"frequency":{"description":"How often the Agency account gets charged price_in_cents","type":"string","enum":["Monthly","Annually"]}},"type":"object"}}}},"responses":{"201":{"description":"Created","content":{"application\/json":{"schema":{"title":"Create Agency Token Response Success","type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/v1\/agency\/tokens\/{token}":{"get":{"tags":["Agency Tokens"],"summary":"Get an Agency token.","description":"Read a single Agency Token.","operationId":"v1_getAgencyToken","parameters":[{"name":"token","in":"path","description":"Token to read","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"title":"Get Agency Token Response Success","properties":{"token":{"description":"Agency token","type":"string"},"email":{"description":"Email address the token will be sent to","type":"string"},"client_id":{"description":"Client ID for this token. If present, this token has been sent to a customer.","type":"string","format":"uuid"},"account_id":{"description":"Account ID for this token. Only set once the token has been started.","type":"string","format":"uuid"},"quantity":{"description":"Quantity of sites for the new Agency account","type":"integer"},"price_in_cents":{"description":"How much the plan costs the Agency account, in US cents (100 is one dollar)","type":"integer"},"price_per_site":{"description":"Determines if the price given is for all sites or per site","type":"integer"},"frequency":{"description":"How often the Agency account gets charged price_in_cents","type":"string","enum":["Monthly","Annually"]},"created_at":{"description":"When this token was created","type":"string"}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]},"delete":{"tags":["Agency Tokens"],"summary":"Deletes an Agency token.","operationId":"v1_deleteAgencyToken","parameters":[{"name":"token","in":"path","description":"Token to delete","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]},"patch":{"tags":["Agency Tokens"],"summary":"Patch an agency token.","description":"Update an Agency Token, sending only the keys necessary.","operationId":"v1_updateAgencyToken","parameters":[{"name":"token","in":"path","description":"Token to update","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"title":"Update Agency Token Request Body","properties":{"email":{"description":"Email address the token will be sent to","type":"string"},"account_id":{"description":"Account ID for this token. Only set once the token has been started.","type":"string","format":"uuid"},"quantity":{"description":"Quantity of sites for the new Agency account","type":"integer"},"price_in_cents":{"description":"How much the plan costs the Agency account, in US cents (100 is one dollar)","type":"integer"},"price_per_site":{"description":"Determines if the price given is for all sites or per site","type":"integer"},"frequency":{"description":"How often the Agency account gets charged price_in_cents","type":"string","enum":["Monthly","Annually"]}},"type":"object"}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"title":"Patch Agency Token Response Success","properties":{"token":{"description":"Updated token information","type":"object"}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"404":{"description":"NotFound","content":{"application\/json":{"schema":{"title":"NotFoundResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/v1\/authenticate":{"post":{"tags":["Authentication"],"summary":"Send client credentials via POST to retrieve a JWT authentication token.","description":"Send client credentials via POST to retrieve a JWT authentication token.","operationId":"v1_authenticate","requestBody":{"content":{"application\/json":{"schema":{"title":"Authenticate Request Body","properties":{"public_key":{"description":"Client public key string.","type":"string"},"private_key":{"description":"Client private key string.","type":"string"}},"type":"object"}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"title":"Authenticate Response Success","properties":{"jwt":{"description":"JWT token string.","type":"string"}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"gatewayAuth":[]}]}},"\/v1\/billing\/recurly\/accounts\/{account_id}\/invoices":{"get":{"tags":["Billing"],"summary":"Get a list of Recurly invoices for an account.","operationId":"v1_getRecurlyInvoices","parameters":[{"name":"account_id","in":"path","description":"ID of account","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"410":{"description":"Gone","content":{"application\/json":{"schema":{"title":"GoneResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}},"200":{"description":"OK","content":{"application\/json":{"schema":{"title":"Get Recurly Account Invoice List Response Success","properties":{"invoices":{"description":"List of invoices","type":"array","items":{"properties":{"invoice_number":{"description":"Invoice number","type":"integer","deprecated":true},"state":{"description":"Invoice state (paid, etc)","type":"string","deprecated":true},"created_at":{"description":"Invoice created date","type":"object","deprecated":true},"total_in_cents":{"description":"Invoice total, in cents","type":"integer","deprecated":true},"currency":{"description":"Invoice currency code","type":"string","deprecated":true}},"type":"object"},"deprecated":true}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}},"404":{"description":"Not Found","content":{"application\/json":{"schema":{"title":"Get Recurly Account Invoice List Response Not Found","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}}},"deprecated":true,"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/v1\/billing\/recurly\/account\/{account_id}":{"get":{"tags":["Billing"],"summary":"Get a single Recurly account (deprecated).","operationId":"v1_getRecurlyAccount","parameters":[{"name":"account_id","in":"path","description":"Account ID","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"410":{"description":"Gone - This endpoint has been deprecated","content":{"application\/json":{"schema":{"title":"GoneResponse","properties":{"messages":{"description":"Error messages explaining that the endpoint is deprecated","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}}},"deprecated":true,"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/v1\/billing\/recurly\/accounts\/{account_id}":{"patch":{"tags":["Billing"],"summary":"Update a Recurly account.","description":"Update a Recurly account.","operationId":"v1_updateRecurlyAccount","parameters":[{"name":"account_id","in":"path","description":"Account ID","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"title":"Update Recurly Account Request Body","properties":{"token":{"description":"Billing Info JS token","type":"string","deprecated":true}},"type":"object"}}}},"responses":{"410":{"description":"Gone","content":{"application\/json":{"schema":{"title":"GoneResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}},"200":{"description":"OK","content":{"application\/json":{"schema":{"title":"Patch Recurly Account Response Success","properties":{"account":{"description":"Account details","properties":{"account_code":{"description":"Account Code","type":"string","deprecated":true},"state":{"description":"State","type":"string","deprecated":true},"email":{"description":"Email address","type":"string","deprecated":true},"first_name":{"description":"First name","type":"string","deprecated":true},"last_name":{"description":"Last name","type":"string","deprecated":true},"address":{"description":"Address","type":"object","deprecated":true},"created_at":{"description":"Account creation date","type":"object","deprecated":true},"updated_at":{"description":"Account updated date","type":"object","deprecated":true},"closed_at":{"description":"Account closed date","type":"object","deprecated":true},"has_live_subscription":{"description":"Account has a live subscription","type":"boolean","deprecated":true},"has_active_subscription":{"description":"Account has an active subscription","type":"boolean","deprecated":true},"has_future_subscription":{"description":"Account has a future subscription","type":"boolean","deprecated":true},"has_canceled_subscription":{"description":"Account has a canceled subscription","type":"boolean","deprecated":true},"has_past_due_invoice":{"description":"Account has a past due invoice","type":"boolean","deprecated":true}},"type":"object","deprecated":true}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}}},"deprecated":true,"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/v1\/billing\/recurly\/accounts\/{account_id}\/subscriptions":{"get":{"tags":["Billing"],"summary":"Get a list of Recurly subscriptions for an account.","operationId":"v1_getRecurlySubscriptions","parameters":[{"name":"account_id","in":"path","description":"ID of account","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"410":{"description":"Gone","content":{"application\/json":{"schema":{"title":"GoneResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}},"200":{"description":"OK","content":{"application\/json":{"schema":{"title":"Get Recurly Account Subscription List Response Success","properties":{"subscriptions":{"description":"List of subscriptions","type":"array","items":{"properties":{"uuid":{"description":"Subscription UUID","type":"string","deprecated":true},"plan":{"description":"Subscription Plan Code","type":"string","deprecated":true},"quantity":{"description":"Site limit","type":"integer","deprecated":true},"state":{"description":"Subscription state","type":"string","deprecated":true},"activated_at":{"description":"Subscription activation date","type":"object","deprecated":true},"canceled_at":{"description":"Subscription canceled date","type":"object","deprecated":true},"expires_at":{"description":"Subscription expires date","type":"object","deprecated":true},"updated_at":{"description":"Subscription updated date","type":"object","deprecated":true}},"type":"object"},"deprecated":true}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}},"404":{"description":"Not Found","content":{"application\/json":{"schema":{"title":"Get Recurly Account Subscription List Response Not Found","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}}},"deprecated":true,"security":[{"sucuriAuth":[],"gatewayAuth":[]}]},"post":{"tags":["Billing"],"summary":"Create a new Recurly subscription for an account (deprecated).","operationId":"v1_createRecurlySubscription","parameters":[{"name":"account_id","in":"path","description":"ID of account","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"title":"Create Recurly Subscription Request Body","properties":{"plan_code":{"description":"Plan code","type":"string","deprecated":true},"quantity":{"description":"Quantity","type":"integer","deprecated":true}},"type":"object"}}}},"responses":{"410":{"description":"Gone - This endpoint has been deprecated","content":{"application\/json":{"schema":{"title":"GoneResponse","properties":{"messages":{"description":"Error messages explaining that the endpoint is deprecated","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}}},"deprecated":true,"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/v1\/billing\/recurly\/invoices\/{invoice_number}":{"get":{"tags":["Billing"],"summary":"Get a Recurly invoice by number.","description":"Read a single Invoice by invoice number.","operationId":"v1_getRecurlyInvoice","parameters":[{"name":"invoice_number","in":"path","description":"Invoice number","required":true,"schema":{"type":"string"}}],"responses":{"410":{"description":"Gone","content":{"application\/json":{"schema":{"title":"GoneResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"deprecated":true,"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/v1\/billing\/recurly\/pubkey":{"get":{"tags":["Billing"],"summary":"Get the Recurly public JS key used in UI for generating forms.","operationId":"v1_getRecurlyPubkey","responses":{"410":{"description":"Gone - This endpoint has been deprecated","content":{"application\/json":{"schema":{"title":"GoneResponse","properties":{"messages":{"description":"Error messages explaining that the endpoint is deprecated","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}}},"deprecated":true,"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/v1\/billing\/recurly\/subscriptions\/{uuid}":{"get":{"tags":["Billing"],"summary":"Get a single Recurly subscription (deprecated).","operationId":"v1_getRecurlySubscription","parameters":[{"name":"uuid","in":"path","description":"Subscription UUID","required":true,"schema":{"type":"string"}}],"responses":{"410":{"description":"Gone - This endpoint has been deprecated","content":{"application\/json":{"schema":{"title":"GoneResponse","properties":{"messages":{"description":"Error messages explaining that the endpoint is deprecated","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}}},"deprecated":true,"security":[{"sucuriAuth":[],"gatewayAuth":[]}]},"delete":{"tags":["Billing"],"summary":"Cancel a Recurly subscription.","description":"Cancel a Subscription.","operationId":"v1_cancelRecurlySubscription","parameters":[{"name":"uuid","in":"path","description":"Subscription UUID","required":true,"schema":{"type":"string"}}],"responses":{"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}},"410":{"description":"Gone","content":{"application\/json":{"schema":{"title":"GoneResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}}},"deprecated":true,"security":[{"sucuriAuth":[],"gatewayAuth":[]}]},"patch":{"tags":["Billing"],"summary":"Update a Recurly subscription.","description":"Update a Subscription.","operationId":"v1_updateRecurlySubscription","parameters":[{"name":"uuid","in":"path","description":"Subscription UUID","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"title":"Update Subscription Request Body","properties":{"quantity":{"description":"New quantity","type":"integer","deprecated":true}},"type":"object"}}}},"responses":{"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}},"410":{"description":"Gone","content":{"application\/json":{"schema":{"title":"GoneResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}}},"deprecated":true,"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/v1\/billing\/recurly\/webhook\/{public_key}":{"post":{"tags":["Billing"],"summary":"Handle Recurly webhook requests. See https:\/\/developers.recurly.com\/pages\/webhooks.html for request body details.","operationId":"v1_handleRecurlyWebhook","parameters":[{"name":"public_key","in":"path","description":"Sucuri Accounts API Public Key","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application\/xml":{"schema":{"description":"Recurly webhook XML payload","type":"object"}}}},"responses":{"410":{"description":"Gone","content":{"application\/json":{"schema":{"title":"GoneResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}},"200":{"description":"OK","content":{"application\/json":{"schema":{"title":"Recurly Webhook Response Success","type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}}},"deprecated":true}},"\/v1\/clients\/{client_id}\/auths\/{api_key}":{"delete":{"tags":["Clients"],"summary":"Removes a key from a client.","operationId":"v1_deleteClientAuth","parameters":[{"name":"client_id","in":"path","description":"ID of client","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"api_key","in":"path","description":"Api Key to delete","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/v1\/clients\/{client_id}\/auths":{"get":{"tags":["Clients"],"summary":"Get a list of auths belonging to a client.","operationId":"v1_getClientAuths","parameters":[{"name":"client_id","in":"path","description":"ID of client","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"limit","in":"query","description":"Number of records to return","schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Number of records to skip","schema":{"type":"integer"}}],"responses":{"200":{"description":"List of records","content":{"application\/json":{"schema":{"title":"Get Client Auths List Response Success","properties":{"total":{"description":"Total number of records","type":"integer"},"limit":{"description":"Number of records to return","type":"integer"},"offset":{"description":"Number of records to skip","type":"integer"},"auths":{"description":"List of auths","type":"array","items":{"$ref":"#\/components\/schemas\/ClientAuth"}}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]},"post":{"tags":["Clients"],"summary":"Updates a single client's API keys.","operationId":"v1_updateClientAuths","parameters":[{"name":"client_id","in":"path","description":"ID of client","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ClientAuthBody"}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"title":"Update Client Key Response Success","properties":{"key_id":{"description":"Key ID","type":"string","format":"uuid"},"public_key":{"description":"Client public key (username)","type":"string"},"private_key":{"description":"Client private key (password)","type":"string"}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/v1\/clients":{"get":{"tags":["Clients"],"summary":"Get a list of clients.","operationId":"v1_getClients","parameters":[{"name":"limit","in":"query","description":"Number of records to return","schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Number of records to skip","schema":{"type":"integer"}}],"responses":{"200":{"description":"List of records","content":{"application\/json":{"schema":{"title":"Get Client List Response Success","properties":{"total":{"description":"Total number of records","type":"integer"},"limit":{"description":"Number of records to return","type":"integer"},"offset":{"description":"Number of records to skip","type":"integer"},"clients":{"description":"List of records","type":"array","items":{"$ref":"#\/components\/schemas\/Client"}}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]},"post":{"tags":["Clients"],"summary":"Creates a Client.","operationId":"v1_createClient","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Client"}}}},"responses":{"201":{"description":"Created","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Client"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"409":{"description":"Conflict","content":{"application\/json":{"schema":{"title":"ConflictResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/v1\/clients\/{client_id}":{"get":{"tags":["Clients"],"summary":"Get a Client.","description":"Read a single Client.","operationId":"v1_getClient","parameters":[{"name":"client_id","in":"path","description":"ID of client to read","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Client"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"404":{"description":"Not Found","content":{"application\/json":{"schema":{"title":"Get Recurly Subscription Response Not Found","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]},"delete":{"tags":["Clients"],"summary":"Deletes a Client.","operationId":"v1_deleteClient","parameters":[{"name":"client_id","in":"path","description":"ID of client to delete","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"No Content"},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]},"patch":{"tags":["Clients"],"summary":"Patch a client.","description":"Update a Client, sending only the keys necessary.","operationId":"v1_updateClient","parameters":[{"name":"client_id","in":"path","description":"ID of client to update","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Client"}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Client"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"404":{"description":"NotFound","content":{"application\/json":{"schema":{"title":"NotFoundResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/v1\/clients\/{client_id}\/keys\/{key_id}":{"delete":{"tags":["Clients"],"summary":"Removes a key from a client.","operationId":"v1_deleteClientKey","parameters":[{"name":"client_id","in":"path","description":"ID of client","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"key_id","in":"path","description":"ID of key","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"No Content"},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/v1\/clients\/{client_id}\/keys":{"get":{"tags":["Clients"],"summary":"Get a list of keys belonging to a client.","operationId":"v1_getClientKeys","parameters":[{"name":"client_id","in":"path","description":"ID of client","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"limit","in":"query","description":"Number of records to return","schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Number of records to skip","schema":{"type":"integer"}}],"responses":{"200":{"description":"List of records","content":{"application\/json":{"schema":{"title":"Get Client Keys List Response Success","properties":{"total":{"description":"Total number of records","type":"integer"},"limit":{"description":"Number of records to return","type":"integer"},"offset":{"description":"Number of records to skip","type":"integer"},"keys":{"description":"List of keys","type":"array","items":{"$ref":"#\/components\/schemas\/ClientKey"}}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]},"delete":{"tags":["Clients"],"summary":"Updates a single client's API keys.","operationId":"v1_updateClientKeys","parameters":[{"name":"client_id","in":"path","description":"ID of client","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"title":"Update Client Key Response Success","properties":{"key_id":{"description":"Key ID","type":"string","format":"uuid"},"public_key":{"description":"Client public key (username)","type":"string"},"private_key":{"description":"Client private key (password)","type":"string"}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/v1\/clients\/{client_id}\/servers":{"get":{"tags":["Clients"],"summary":"Get a list of servers belonging to a client.","operationId":"v1_getClientServers","parameters":[{"name":"client_id","in":"path","description":"ID of client","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"limit","in":"query","description":"Number of records to return","schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Number of records to skip","schema":{"type":"integer"}}],"responses":{"200":{"description":"List of records","content":{"application\/json":{"schema":{"title":"Get Client Server List Response Success","properties":{"total":{"description":"Total number of records","type":"integer"},"limit":{"description":"Number of records to return","type":"integer"},"offset":{"description":"Number of records to skip","type":"integer"},"servers":{"description":"List of records","type":"array","items":{"$ref":"#\/components\/schemas\/Server"}}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]},"post":{"tags":["Clients"],"summary":"Assigns a server to a client.","description":"Associate a Client with a Server. Clients must be associated with a Server in order for their Accounts to be associated.","operationId":"v1_addClientToServer","parameters":[{"name":"client_id","in":"path","description":"ID of client","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"title":"Create Client Server Request Body","properties":{"server_id":{"description":"Server ID","type":"string","format":"uuid"}},"type":"object"}}}},"responses":{"201":{"description":"Created","content":{"application\/json":{"schema":{"title":"Create Client Server Response Success","type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"409":{"description":"Conflict","content":{"application\/json":{"schema":{"title":"ConflictResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/v1\/clients\/{client_id}\/servers\/{server_id}":{"delete":{"tags":["Clients"],"summary":"Removes a server from a client.","operationId":"v1_removeClientFromServer","parameters":[{"name":"client_id","in":"path","description":"ID of client","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"server_id","in":"path","description":"ID of server","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"No Content"},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/v1\/clients\/some":{"post":{"tags":["Clients"],"summary":"Get a list of some clients.","operationId":"v1_getSomeClients","requestBody":{"required":true,"content":{"application\/json":{"schema":{"title":"Some Clients Request Body","properties":{"ids":{"description":"Array of Client IDs","type":"array","items":{"type":"string","format":"uuid"}}},"type":"object"}}}},"responses":{"200":{"description":"List of records","content":{"application\/json":{"schema":{"title":"Get Some Clients List Response Success","properties":{"clients":{"description":"List of records","type":"array","items":{"$ref":"#\/components\/schemas\/Client"}}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/v1\/healthcheck\/deep":{"get":{"tags":["Healthchecks"],"summary":"Deep healthcheck to verify upstream services","operationId":"v1_healthcheckDeep","responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"properties":{"status":{"description":"Status of the request","type":"string"}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"gatewayAuth":[]}]}},"\/v1\/healthcheck\/ping":{"get":{"tags":["Healthchecks"],"summary":"Shallow health check to verify service is up","operationId":"v1_healthcheckPing","responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"properties":{"status":{"description":"Status of the request","type":"string"}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"gatewayAuth":[]}]}},"\/v1\/idp":{"get":{"tags":["Identity Providers"],"summary":"Get a list of Identity Providers.","operationId":"v1_getIdentityProviders","parameters":[{"name":"limit","in":"query","description":"Number of records to return","schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Number of records to skip","schema":{"type":"integer"}}],"responses":{"200":{"description":"List of records","content":{"application\/json":{"schema":{"title":"Get Identity Provider List Response Success","properties":{"total":{"description":"Total number of records","type":"integer"},"limit":{"description":"Number of records to return","type":"integer"},"offset":{"description":"Number of records to skip","type":"integer"},"idps":{"description":"List of records","type":"array","items":{"$ref":"#\/components\/schemas\/IdentityProvider"}}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]},"post":{"tags":["Identity Providers"],"summary":"Creates an Identity Provider.","operationId":"v1_createIdentityProvider","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/IdentityProvider"}}}},"responses":{"201":{"description":"Created","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/IdentityProvider"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"409":{"description":"Conflict","content":{"application\/json":{"schema":{"title":"ConflictResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/v1\/idp\/{idp_id}":{"get":{"tags":["Identity Providers"],"summary":"Get an Identity Provider.","description":"Read a single Identity Provider.","operationId":"v1_getIdentityProvider","parameters":[{"name":"idp_id","in":"path","description":"ID of Identity Provider to read","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/IdentityProvider"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"404":{"description":"Not Found","content":{"application\/json":{"schema":{"title":"Get Recurly Subscription Response Not Found","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]},"delete":{"tags":["Identity Providers"],"summary":"Deletes an Identity Provider.","operationId":"v1_deleteIdentityProvider","parameters":[{"name":"idp_id","in":"path","description":"ID of Identity Provider to delete","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"No Content"},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]},"patch":{"tags":["Identity Providers"],"summary":"Patch an Identity Provider.","description":"Update an Identity Provider, sending only the keys necessary.","operationId":"v1_updateIdentityProvider","parameters":[{"name":"idp_id","in":"path","description":"ID of Identity Provider to update","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/IdentityProvider"}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/IdentityProvider"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"404":{"description":"NotFound","content":{"application\/json":{"schema":{"title":"NotFoundResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/v1\/idp\/named\/{slug}":{"get":{"tags":["Identity Providers"],"summary":"Get an Identity Provider by slug.","description":"Read a single Identity Provider.","operationId":"v1_getIdentityProviderBySlug","parameters":[{"name":"slug","in":"path","description":"Slug of Identity Provider to read","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/IdentityProvider"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/v1\/idp\/{idp_id}\/roles":{"get":{"tags":["Identity Providers"],"summary":"Get a list of roles belonging to an user.","description":"Get a paginated list of Identity Provider Roles.","operationId":"v1_getIdentityProviderRoles","parameters":[{"name":"idp_id","in":"path","description":"ID of Identity Provider","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"limit","in":"query","description":"Number of records to return","schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Number of records to skip","schema":{"type":"integer"}}],"responses":{"200":{"description":"List of records","content":{"application\/json":{"schema":{"title":"Get Identity Provider Role List Response Success","properties":{"total":{"description":"Total number of records","type":"integer"},"limit":{"description":"Number of records to return","type":"integer"},"offset":{"description":"Number of records to skip","type":"integer"},"roles":{"description":"List of records","type":"array","items":{"$ref":"#\/components\/schemas\/IdentityProviderRole"}}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]},"post":{"tags":["Identity Providers"],"summary":"Maps a role to an Identity Provider memberOf value.","operationId":"v1_addIdentityProviderToRole","parameters":[{"name":"idp_id","in":"path","description":"ID of Identity Provider","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"title":"Create Identity Provider Role Request Body","required":["role_id"],"properties":{"role_id":{"description":"Role ID","type":"string","format":"uuid"},"member_of":{"description":"Identity Provider memberOf value.","type":"string"}},"type":"object"}}}},"responses":{"201":{"description":"Created","content":{"application\/json":{"schema":{"title":"Create Identity Provider Role Response Success","type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"409":{"description":"Conflict","content":{"application\/json":{"schema":{"title":"ConflictResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/v1\/idp\/{idp_id}\/roles\/{role_id}":{"delete":{"tags":["Identity Providers"],"summary":"Removes a role from a user.","operationId":"v1_removeIdentityProviderFromRole","parameters":[{"name":"idp_id","in":"path","description":"ID of Identity Provider","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"role_id","in":"path","description":"ID of role","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"No Content"},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/v1\/locales":{"get":{"tags":["Locales"],"summary":"Get a list of locales.","operationId":"v1_getLocales","parameters":[{"name":"limit","in":"query","description":"Number of records to return","schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Number of records to skip","schema":{"type":"integer"}}],"responses":{"200":{"description":"List of records","content":{"application\/json":{"schema":{"title":"Get Locale List Response Success","properties":{"total":{"description":"Total number of records","type":"integer"},"limit":{"description":"Number of records to return","type":"integer"},"offset":{"description":"Number of records to skip","type":"integer"},"locales":{"description":"List of records","type":"array","items":{"$ref":"#\/components\/schemas\/Locale"}}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]},"post":{"tags":["Locales"],"summary":"Creates a Locale.","operationId":"v1_createLocale","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Locale"}}}},"responses":{"201":{"description":"Created","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Locale"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"409":{"description":"Conflict","content":{"application\/json":{"schema":{"title":"ConflictResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/v1\/locales\/{locale_id}":{"get":{"tags":["Locales"],"summary":"Get a Locale.","description":"Read a single Locale.","operationId":"v1_getLocale","parameters":[{"name":"locale_id","in":"path","description":"ID of locale to read","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Locale"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"404":{"description":"Not Found","content":{"application\/json":{"schema":{"title":"Get Locale Response Not Found","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]},"delete":{"tags":["Locales"],"summary":"Deletes a Locale.","operationId":"v1_deleteLocale","parameters":[{"name":"locale_id","in":"path","description":"ID of locale to delete","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"No Content"},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]},"patch":{"tags":["Locales"],"summary":"Patch a locale.","description":"Update a Locale, sending only the keys necessary.","operationId":"v1_updateLocale","parameters":[{"name":"locale_id","in":"path","description":"ID of locale to update","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Locale"}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Locale"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"404":{"description":"NotFound","content":{"application\/json":{"schema":{"title":"NotFoundResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/v1\/locales\/named\/{code}":{"get":{"tags":["Locales"],"summary":"Get a Locale.","description":"Read a single Locale.","operationId":"v1_getLocaleByName","parameters":[{"name":"code","in":"path","description":"String of locale to read, e.g. en_US","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Locale"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/v1\/locales\/some":{"post":{"tags":["Locales"],"summary":"Get a list of some locales.","operationId":"v1_getSomeLocales","requestBody":{"required":true,"content":{"application\/json":{"schema":{"title":"Some Locales Request Body","properties":{"ids":{"description":"Array of Locale IDs","type":"array","items":{"type":"string","format":"uuid"}}},"type":"object"}}}},"responses":{"200":{"description":"List of records","content":{"application\/json":{"schema":{"title":"Get Some Locales List Response Success","properties":{"locales":{"description":"List of records","type":"array","items":{"$ref":"#\/components\/schemas\/Locale"}}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/v1\/nps":{"post":{"tags":["NPS"],"summary":"Creates a new NPS record for a user. Deprecated, use PATCH \/users\/{user_id}.","operationId":"v1_createNetPromoterScore","requestBody":{"required":true,"content":{"application\/json":{"schema":{"title":"Create NPS Request Body","required":["user_id"],"properties":{"user_id":{"description":"User ID.","type":"string","format":"uuid","deprecated":true}},"type":"object"}}}},"responses":{"201":{"description":"Created","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/User"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}},"409":{"description":"Conflict","content":{"application\/json":{"schema":{"title":"ConflictResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}}},"deprecated":true,"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/v1\/plans":{"get":{"tags":["Plans"],"summary":"Get a list of plans.","operationId":"v1_getPlans","parameters":[{"name":"limit","in":"query","description":"Number of records to return","schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Number of records to skip","schema":{"type":"integer"}}],"responses":{"200":{"description":"List of records","content":{"application\/json":{"schema":{"title":"Get Plan List Response Success","properties":{"total":{"description":"Total number of records","type":"integer"},"limit":{"description":"Number of records to return","type":"integer"},"offset":{"description":"Number of records to skip","type":"integer"},"plans":{"description":"List of records","type":"array","items":{"$ref":"#\/components\/schemas\/Plan"}}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]},"post":{"tags":["Plans"],"summary":"Creates a Plan.","operationId":"v1_createPlan","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Plan"}}}},"responses":{"201":{"description":"Created","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Plan"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"409":{"description":"Conflict","content":{"application\/json":{"schema":{"title":"ConflictResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/v1\/plans\/{plan_id}":{"get":{"tags":["Plans"],"summary":"Get a plan.","description":"Read a single Plan.","operationId":"v1_getPlan","parameters":[{"name":"plan_id","in":"path","description":"ID of plan to read","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Plan"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"404":{"description":"Not Found","content":{"application\/json":{"schema":{"title":"Get Recurly Subscription Response Not Found","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]},"delete":{"tags":["Plans"],"summary":"Deletes a Plan.","operationId":"v1_deletePlan","parameters":[{"name":"plan_id","in":"path","description":"ID of plan to delete","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"No Content"},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]},"patch":{"tags":["Plans"],"summary":"Patch a plan.","description":"Update a Plan, sending only the keys necessary.","operationId":"v1_updatePlan","parameters":[{"name":"plan_id","in":"path","description":"ID of plan to update","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Plan"}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Plan"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"404":{"description":"NotFound","content":{"application\/json":{"schema":{"title":"NotFoundResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/v1\/plans\/flags":{"get":{"tags":["Plans"],"summary":"Get a list of plan flags.","operationId":"v1_getPlanFlags","responses":{"200":{"description":"List of records","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/PlanFlags"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/v1\/plans\/named\/{name}":{"get":{"tags":["Plans"],"summary":"Get a plan by name.","description":"Read a single Plan by name.","operationId":"v1_getPlanByName","parameters":[{"name":"name","in":"path","description":"Name of plan","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Plan"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/v1\/plans\/some":{"post":{"tags":["Plans"],"summary":"Get a list of some plans.","operationId":"v1_getSomePlans","requestBody":{"required":true,"content":{"application\/json":{"schema":{"title":"Some Plans Request Body","properties":{"ids":{"description":"Array of Site IDs","type":"array","items":{"type":"string","format":"uuid"}}},"type":"object"}}}},"responses":{"200":{"description":"List of records","content":{"application\/json":{"schema":{"title":"Get Some Site List Response Success","properties":{"plans":{"description":"List of records","type":"array","items":{"$ref":"#\/components\/schemas\/Site"}}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/v1\/roles":{"get":{"tags":["Roles"],"summary":"Get a list of roles.","operationId":"v1_getRoles","parameters":[{"name":"limit","in":"query","description":"Number of records to return","schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Number of records to skip","schema":{"type":"integer"}},{"name":"account_id","in":"query","description":"Filter by account","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"List of records","content":{"application\/json":{"schema":{"title":"Get Role List Response Success","properties":{"total":{"description":"Total number of records","type":"integer"},"limit":{"description":"Number of records to return","type":"integer"},"offset":{"description":"Number of records to skip","type":"integer"},"roles":{"description":"List of records","type":"array","items":{"$ref":"#\/components\/schemas\/Role"}}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]},"post":{"tags":["Roles"],"summary":"Creates a Role.","operationId":"v1_createRole","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Role"}}}},"responses":{"201":{"description":"Created","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Role"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"409":{"description":"Conflict","content":{"application\/json":{"schema":{"title":"ConflictResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/v1\/roles\/{role_id}":{"get":{"tags":["Roles"],"summary":"Get a Role.","description":"Read a single Role.","operationId":"v1_getRole","parameters":[{"name":"role_id","in":"path","description":"ID of role to read","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Role"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"404":{"description":"Not Found","content":{"application\/json":{"schema":{"title":"Get Recurly Subscription Response Not Found","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]},"delete":{"tags":["Roles"],"summary":"Deletes a Role.","operationId":"v1_deleteRole","parameters":[{"name":"role_id","in":"path","description":"ID of role to delete","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"No Content"},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]},"patch":{"tags":["Roles"],"summary":"Patch a role.","description":"Update a Role, sending only the keys necessary.","operationId":"v1_updateRole","parameters":[{"name":"role_id","in":"path","description":"ID of role to update","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Role"}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Role"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"404":{"description":"NotFound","content":{"application\/json":{"schema":{"title":"NotFoundResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/v1\/roles\/{role_id}\/tasks":{"get":{"tags":["Roles"],"summary":"Get a list of tasks belonging to a role.","operationId":"v1_getRoleTasks","parameters":[{"name":"role_id","in":"path","description":"ID of role","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"limit","in":"query","description":"Number of records to return","schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Number of records to skip","schema":{"type":"integer"}}],"responses":{"200":{"description":"List of records","content":{"application\/json":{"schema":{"title":"Get Role Task List Response Success","properties":{"total":{"description":"Total number of records","type":"integer"},"limit":{"description":"Number of records to return","type":"integer"},"offset":{"description":"Number of records to skip","type":"integer"},"roles":{"description":"List of records","type":"array","items":{"$ref":"#\/components\/schemas\/Role"}}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]},"post":{"tags":["Roles"],"summary":"Creates a new task for a role.","operationId":"v1_createRoleTask","parameters":[{"name":"role_id","in":"path","description":"ID of role","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"title":"Create Role Task Request Body","properties":{"task":{"description":"A task name using dot-delimited path formatting.","type":"string"},"permissions":{"description":"Bitmask, Create = 1, Read = 2, Update = 4, Delete = 8","type":"integer"}},"type":"object"}}}},"responses":{"201":{"description":"Created","content":{"application\/json":{"schema":{"title":"Create Role Task Response Success","type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"409":{"description":"Conflict","content":{"application\/json":{"schema":{"title":"ConflictResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/v1\/":{"get":{"tags":["Documentation"],"summary":"Generates JSON for use in Swagger to document this API.","operationId":"v1_generateSwagger","responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"title":"Get Swagger Response Success","type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"gatewayAuth":[]}]}},"\/v1\/servers":{"get":{"tags":["Servers"],"summary":"Get a list of servers.","operationId":"v1_getServers","parameters":[{"name":"limit","in":"query","description":"Number of records to return","schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Number of records to skip","schema":{"type":"integer"}},{"name":"type","in":"query","description":"Which type of server is this?","schema":{"type":"string","enum":["backups","firewall","monitor","support"]}},{"name":"open","in":"query","description":"Is this server accepting new accounts?","schema":{"type":"boolean"}}],"responses":{"200":{"description":"List of records","content":{"application\/json":{"schema":{"title":"Get Server List Response Success","properties":{"total":{"description":"Total number of records","type":"integer"},"limit":{"description":"Number of records to return","type":"integer"},"offset":{"description":"Number of records to skip","type":"integer"},"servers":{"description":"List of records","type":"array","items":{"$ref":"#\/components\/schemas\/Server"}}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]},"post":{"tags":["Servers"],"summary":"Creates a Server.","operationId":"v1_createServer","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Server"}}}},"responses":{"201":{"description":"Created","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Server"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"409":{"description":"Conflict","content":{"application\/json":{"schema":{"title":"ConflictResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/v1\/servers\/{server_id}":{"get":{"tags":["Servers"],"summary":"Get a Server.","description":"Read a single Server.","operationId":"v1_getServer","parameters":[{"name":"server_id","in":"path","description":"ID of server to read","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Server"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"404":{"description":"Not Found","content":{"application\/json":{"schema":{"title":"Get Recurly Subscription Response Not Found","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]},"delete":{"tags":["Servers"],"summary":"Deletes a Server.","operationId":"v1_deleteServer","parameters":[{"name":"server_id","in":"path","description":"ID of server to delete","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"No Content"},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]},"patch":{"tags":["Servers"],"summary":"Patch a server.","description":"Update a Server, sending only the keys necessary.","operationId":"v1_updateServer","parameters":[{"name":"server_id","in":"path","description":"ID of server to update","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Server"}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Server"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"404":{"description":"NotFound","content":{"application\/json":{"schema":{"title":"NotFoundResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/v1\/servers\/flags":{"get":{"tags":["Servers"],"summary":"Get a list of server flags.","operationId":"v1_getServerFlags","responses":{"200":{"description":"List of records","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ServerFlags"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/v1\/servers\/named":{"post":{"tags":["Servers"],"summary":"Get a Server by domain name.","description":"Read a single Server by domain name.","operationId":"v1_getServerByDomainName","requestBody":{"content":{"application\/json":{"schema":{"title":"Server Named Request Body","properties":{"domain_name":{"description":"Domain name of server to read","type":"string"}},"type":"object"}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Server"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"404":{"description":"Not Found","content":{"application\/json":{"schema":{"title":"NotFoundResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/v1\/servers\/random\/{server_type}":{"get":{"tags":["Servers"],"summary":"Assigns a random server to an account.","description":"Get a random Server ID based on type.","operationId":"v1_getRandomServer","parameters":[{"name":"server_type","in":"path","description":"Server type","required":true,"schema":{"type":"string","enum":["backups","firewall","monitor","support"]}},{"name":"client_id","in":"query","description":"Client ID used to filter servers. This is only available when using master keys.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Server"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/v1\/servers\/some":{"post":{"tags":["Servers"],"summary":"Get a list of some sites.","operationId":"v1_getSomeServers","requestBody":{"required":true,"content":{"application\/json":{"schema":{"title":"Some Servers Request Body","properties":{"ids":{"description":"Array of Server IDs","type":"array","items":{"type":"string","format":"uuid"}}},"type":"object"}}}},"responses":{"200":{"description":"List of records","content":{"application\/json":{"schema":{"title":"Get Some Server List Response Success","properties":{"sites":{"description":"List of records","type":"array","items":{"$ref":"#\/components\/schemas\/Server"}}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/v1\/sites":{"get":{"tags":["Sites"],"summary":"Get a list of Sites.","operationId":"v1_getSites","parameters":[{"name":"limit","in":"query","description":"Number of records to return","schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Number of records to skip","schema":{"type":"integer"}},{"name":"domain_name","in":"query","description":"Optional domain name filter","schema":{"type":"string"}}],"responses":{"200":{"description":"List of records","content":{"application\/json":{"schema":{"title":"Get Site List Response Success","properties":{"total":{"description":"Total number of records","type":"integer","deprecated":true},"limit":{"description":"Number of records to return","type":"integer","deprecated":true},"offset":{"description":"Number of records to skip","type":"integer","deprecated":true},"sites":{"description":"List of records","type":"array","items":{"$ref":"#\/components\/schemas\/Site"},"deprecated":true}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}},"410":{"description":"Gone","content":{"application\/json":{"schema":{"title":"GoneResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}}},"deprecated":true,"security":[{"sucuriAuth":[],"gatewayAuth":[]}]},"post":{"tags":["Sites"],"summary":"Creates a Site.","operationId":"v1_createSite","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Site"}}}},"responses":{"201":{"description":"Created","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Site"}}}},"400":{"description":"Bad Request","content":{"application\/json":{"schema":{"title":"BadRequestResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}},"409":{"description":"Conflict","content":{"application\/json":{"schema":{"title":"ConflictResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}},"410":{"description":"Gone","content":{"application\/json":{"schema":{"title":"GoneResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}}},"deprecated":true,"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/v1\/sites\/{site_id}":{"get":{"tags":["Sites"],"summary":"Get a Site.","description":"Read a single Site.","operationId":"v1_getSite","parameters":[{"name":"site_id","in":"path","description":"ID of site to read","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Site"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}},"404":{"description":"Not Found","content":{"application\/json":{"schema":{"title":"Get Recurly Subscription Response Not Found","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}},"410":{"description":"Gone","content":{"application\/json":{"schema":{"title":"GoneResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}}},"deprecated":true,"security":[{"sucuriAuth":[],"gatewayAuth":[]}]},"delete":{"tags":["Sites"],"summary":"Deletes a Site.","operationId":"v1_deleteSite","parameters":[{"name":"site_id","in":"path","description":"ID of site to delete","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"No Content"},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}},"410":{"description":"Gone","content":{"application\/json":{"schema":{"title":"GoneResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}}},"deprecated":true,"security":[{"sucuriAuth":[],"gatewayAuth":[]}]},"patch":{"tags":["Sites"],"summary":"Patch a site.","description":"Update a Site, sending only the keys necessary.","operationId":"v1_updateSite","parameters":[{"name":"site_id","in":"path","description":"ID of site to update","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Site"}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Site"}}}},"400":{"description":"Bad Request","content":{"application\/json":{"schema":{"title":"BadRequestResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}},"404":{"description":"NotFound","content":{"application\/json":{"schema":{"title":"NotFoundResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}},"410":{"description":"Gone","content":{"application\/json":{"schema":{"title":"GoneResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}}},"deprecated":true,"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/v1\/sites\/some":{"post":{"tags":["Sites"],"summary":"Get a list of some sites.","operationId":"v1_getSomeSites","requestBody":{"required":true,"content":{"application\/json":{"schema":{"title":"Some Sites Request Body","properties":{"ids":{"description":"Array of Site IDs","type":"array","items":{"type":"string","format":"uuid"},"deprecated":true}},"type":"object"}}}},"responses":{"200":{"description":"List of records","content":{"application\/json":{"schema":{"title":"Get Some Site List Response Success","properties":{"sites":{"description":"List of records","type":"array","items":{"$ref":"#\/components\/schemas\/Site"},"deprecated":true}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}},"410":{"description":"Gone","content":{"application\/json":{"schema":{"title":"GoneResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}}},"deprecated":true,"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/v1\/users\/analytics\/":{"post":{"tags":["Users"],"summary":"Find users based on their analytics hash.","description":"Find users based on their analytics hash.","operationId":"v1_getUsersByAnalyticsHash","requestBody":{"required":true,"content":{"application\/json":{"schema":{"title":"Find User By Analytics Hash Request Body","properties":{"analytics_hash":{"description":"Analytics hash, used briefly to associate Sucuri customers with 3rd party analytics services.","type":"string"},"limit":{"description":"Number of records to return","type":"integer"},"offset":{"description":"Number of records to skip","type":"integer"}},"type":"object"}}}},"responses":{"200":{"description":"List of records","content":{"application\/json":{"schema":{"title":"Find User By Analytics Hash Response Success","properties":{"total":{"description":"Total number of records","type":"integer"},"limit":{"description":"Number of records to return","type":"integer"},"offset":{"description":"Number of records to skip","type":"integer"},"users":{"description":"List of records","type":"array","items":{"$ref":"#\/components\/schemas\/User"}}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/v1\/users":{"get":{"tags":["Users"],"summary":"Get a list of users.","description":"Get a paginated list of Users.","operationId":"v1_getUsers","parameters":[{"name":"limit","in":"query","description":"Number of records to return","schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Number of records to skip","schema":{"type":"integer"}},{"name":"account_id","in":"query","description":"Account ID filter","schema":{"type":"string","format":"uuid"}},{"name":"has_2fa","in":"query","description":"Filter users by whether they have 2FA enabled (1 for true, 0 for false)","schema":{"type":"integer","enum":[0,1]}}],"responses":{"200":{"description":"List of records","content":{"application\/json":{"schema":{"title":"Get User List Response Success","properties":{"total":{"description":"Total number of records","type":"integer"},"limit":{"description":"Number of records to return","type":"integer"},"offset":{"description":"Number of records to skip","type":"integer"},"users":{"description":"List of records","type":"array","items":{"$ref":"#\/components\/schemas\/User"}}},"type":"object"}}}},"400":{"description":"Bad Request","content":{"application\/json":{"schema":{"title":"BadRequestResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]},"post":{"tags":["Users"],"summary":"Creates a User.","operationId":"v1_createUser","requestBody":{"required":true,"content":{"application\/json":{"schema":{"title":"Create User Request Body","properties":{"user_id":{"description":"User ID","type":"string","format":"uuid"},"account_id":{"description":"Account ID","type":"string","format":"uuid"},"shopper_id":{"description":"GoDaddy Shopper ID","type":"string"},"customer_id":{"description":"Customer ID","type":"string","format":"uuid"},"email":{"description":"Email address","type":"string"},"display_name":{"description":"First and last (or whatever combination is applicable)","type":"string"},"locale":{"description":"Locale","type":"string"},"tzone":{"description":"Time zone","type":"string"},"enabled":{"description":"Can the user log in","type":"boolean"},"nps_collected":{"description":"Has this user submitted NPS?","type":"boolean"},"created_at":{"description":"Original user creation timestamp","type":"string"}},"type":"object"}}}},"responses":{"201":{"description":"Created","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/FullUser"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"409":{"description":"Conflict","content":{"application\/json":{"schema":{"title":"ConflictResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/v1\/users\/customer\/{customer_id}":{"get":{"tags":["Users"],"summary":"Get a User by Customer ID.","description":"Read a single User by Customer ID.","operationId":"v1_getUserByCustomerID","parameters":[{"name":"customer_id","in":"path","description":"Customer ID of user to read","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/FullUser"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"404":{"description":"Not Found","content":{"application\/json":{"schema":{"title":"Get User By Customer Response Not Found","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/v1\/users\/{user_id}":{"get":{"tags":["Users"],"summary":"Get a User.","description":"Read a single User.","operationId":"v1_getUser","parameters":[{"name":"user_id","in":"path","description":"ID of user to read","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/FullUser"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"404":{"description":"Not Found","content":{"application\/json":{"schema":{"title":"Get Recurly Subscription Response Not Found","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]},"delete":{"tags":["Users"],"summary":"Deletes a User.","operationId":"v1_deleteUser","parameters":[{"name":"user_id","in":"path","description":"ID of user to delete","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"No Content"},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]},"patch":{"tags":["Users"],"summary":"Patch a user.","description":"Update a User, sending only the keys necessary.","operationId":"v1_updateUser","parameters":[{"name":"user_id","in":"path","description":"ID of user to update","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"title":"Patch User Request Body","properties":{"user_id":{"description":"User ID","type":"string","format":"uuid"},"account_id":{"description":"Account ID","type":"string","format":"uuid"},"shopper_id":{"description":"GoDaddy Shopper ID","type":"string"},"customer_id":{"description":"Customer ID","type":"string","format":"uuid"},"email":{"description":"Email address","type":"string"},"display_name":{"description":"First and last (or whatever combination is applicable)","type":"string"},"locale":{"description":"Locale","type":"string"},"tzone":{"description":"Time zone","type":"string"},"enabled":{"description":"Can the user log in","type":"boolean"},"nps_collected":{"description":"Has this user submitted NPS?","type":"boolean"}},"type":"object"}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/FullUser"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"404":{"description":"NotFound","content":{"application\/json":{"schema":{"title":"NotFoundResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/v1\/users\/find\/":{"post":{"tags":["Users"],"summary":"Find users based on their email address.","description":"Find users based on their email address.","operationId":"v1_getUsersByEmail","requestBody":{"required":true,"content":{"application\/json":{"schema":{"title":"Find User Request Body","properties":{"email":{"description":"Email address","type":"string"},"limit":{"description":"Number of records to return","type":"integer"},"offset":{"description":"Number of records to skip","type":"integer"}},"type":"object"}}}},"responses":{"200":{"description":"List of records","content":{"application\/json":{"schema":{"title":"Find User Response Success","properties":{"total":{"description":"Total number of records","type":"integer"},"limit":{"description":"Number of records to return","type":"integer"},"offset":{"description":"Number of records to skip","type":"integer"},"users":{"description":"List of records","type":"array","items":{"$ref":"#\/components\/schemas\/User"}}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/v1\/login":{"post":{"tags":["Users"],"summary":"Use POST data to check login credentials (email + password) against the user database.","description":"Compares a given email and password combination with the ones stored in the database.","operationId":"v1_login","requestBody":{"content":{"application\/json":{"schema":{"title":"Login Request Body","properties":{"email":{"description":"Email address","type":"string","deprecated":true},"password":{"description":"Password","type":"string","deprecated":true}},"type":"object"}}}},"responses":{"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}},"410":{"description":"Gone","content":{"application\/json":{"schema":{"title":"GoneResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}}},"deprecated":true,"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/v1\/users\/{user_id}\/roles":{"get":{"tags":["Users"],"summary":"Get a list of roles belonging to an user.","operationId":"v1_getUserRoles","parameters":[{"name":"user_id","in":"path","description":"ID of user","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"limit","in":"query","description":"Number of records to return","schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Number of records to skip","schema":{"type":"integer"}}],"responses":{"200":{"description":"List of records","content":{"application\/json":{"schema":{"title":"Get User Roles List Response Success","properties":{"total":{"description":"Total number of records","type":"integer"},"limit":{"description":"Number of records to return","type":"integer"},"offset":{"description":"Number of records to skip","type":"integer"},"roles":{"description":"List of records","type":"array","items":{"$ref":"#\/components\/schemas\/Role"}}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]},"post":{"tags":["Users"],"summary":"Assigns a role to a user.","operationId":"v1_addUserToRole","parameters":[{"name":"user_id","in":"path","description":"ID of user","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"title":"Create User Role Request Body","required":["role_id"],"properties":{"role_id":{"description":"Role ID","type":"string","format":"uuid"}},"type":"object"}}}},"responses":{"201":{"description":"Created","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Role"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"409":{"description":"Conflict","content":{"application\/json":{"schema":{"title":"ConflictResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/v1\/users\/{user_id}\/roles\/{role_id}":{"delete":{"tags":["Users"],"summary":"Removes a role from a user.","operationId":"v1_removeUserFromRole","parameters":[{"name":"user_id","in":"path","description":"ID of user","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"role_id","in":"path","description":"ID of role","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"No Content"},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/v1\/users\/{user_id}\/session":{"get":{"tags":["Users"],"summary":"Get a User Session array.","description":"Generate a data structure to be used in a session. This endpoint DOES NOT START A LOGIN SESSION.","operationId":"v1_getSession","parameters":[{"name":"user_id","in":"path","description":"ID of the user","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Session"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/v1\/users\/shopper\/{shopper_id}":{"get":{"tags":["Users"],"summary":"Get a User by Shopper ID.","description":"Read a single User by Shopper ID.","operationId":"v1_getUserByShopperID","parameters":[{"name":"shopper_id","in":"path","description":"Shopper ID of user to read","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/FullUser"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"404":{"description":"Not Found","content":{"application\/json":{"schema":{"title":"Get Recurly Subscription Response Not Found","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/v1\/users\/some":{"post":{"tags":["Users"],"summary":"Get a list of some users.","operationId":"v1_getSomeUsers","requestBody":{"required":true,"content":{"application\/json":{"schema":{"title":"Some Users Request Body","properties":{"ids":{"description":"Array of User IDs","type":"array","items":{"type":"string","format":"uuid"}}},"type":"object"}}}},"responses":{"200":{"description":"List of records","content":{"application\/json":{"schema":{"title":"Get Some User List Response Success","properties":{"users":{"description":"List of records","type":"array","items":{"$ref":"#\/components\/schemas\/User"}}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/v1\/users\/{user_id}\/tokens":{"post":{"tags":["Users"],"summary":"Creates a User Token, used to log in via whitelabel (where no password is stored).","operationId":"v1_createLoginToken","parameters":[{"name":"user_id","in":"path","description":"ID of user","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application\/json":{"schema":{"title":"Create Login Token Request Body","properties":{"type":{"description":"Token type","type":"string","enum":["1time","1day","1hour"],"deprecated":true}},"type":"object"}}}},"responses":{"201":{"description":"Created","content":{"application\/json":{"schema":{"title":"Create Login Token Response Success","properties":{"token":{"description":"Login Token","type":"string","deprecated":true}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}}},"deprecated":true,"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/v1\/token":{"post":{"tags":["Users"],"summary":"Read login information from a token. This action may cause the token to be removed.","operationId":"v1_useLoginToken","requestBody":{"required":true,"content":{"application\/json":{"schema":{"title":"User Login Token Request Body","required":["token"],"properties":{"token":{"description":"Login Token","type":"string","deprecated":true}},"type":"object"}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"title":"User Login Token Response Success","properties":{"user_id":{"description":"User ID associated with token","type":"string","format":"uuid","deprecated":true}},"type":"object"}}}},"400":{"description":"Invalid token","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}}},"deprecated":true,"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/v1\/users\/{user_id}\/2fa\/otp\/cookie":{"post":{"tags":["Users"],"summary":"Creates a new 2FA OTP cookie record.","operationId":"v1_createTwoFactorAuthCookie","parameters":[{"name":"user_id","in":"path","description":"User ID","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"title":"Create User 2FA OTP Cookie Request Body","required":["otp_id","code"],"properties":{"otp_id":{"description":"2FA OTP ID","type":"string","format":"uuid"},"code":{"description":"2FA OTP code","type":"string"}},"type":"object"}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"title":"OKResponse","properties":{"cookie":{"description":"The 2FA OTP cookie","type":"string"}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/v1\/users\/{user_id}\/2fa\/otp\/cookie\/{cookie}":{"get":{"tags":["Users"],"summary":"Verify a 2FA OTP cookie.","description":"Read a single 2FA OTP Cookie.","operationId":"v1_getTwoFactorAuthCookie","parameters":[{"name":"user_id","in":"path","description":"User ID","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"cookie","in":"path","description":"OTP Cookie","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"title":"OKResponse","properties":{"cookie":{"description":"The 2FA OTP cookie","type":"string","deprecated":true}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"},"deprecated":true}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/v1\/users\/{user_id}\/2fa\/otp":{"get":{"tags":["Users"],"summary":"Get a list of 2FA configurations for a user.","description":"Get a paginated list of 2FA configurations for a User.","operationId":"v1_getTwoFactorAuth","parameters":[{"name":"user_id","in":"path","description":"ID of user","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"limit","in":"query","description":"Number of records to return","schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Number of records to skip","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"title":"OKResponse","properties":{"total":{"description":"Total number of records","type":"integer"},"limit":{"description":"Number of records to return","type":"integer"},"offset":{"description":"Number of records to skip","type":"integer"},"otp":{"description":"List of records","type":"array","items":{"$ref":"#\/components\/schemas\/UserOtp"}}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]},"post":{"tags":["Users"],"summary":"Enables 2FA for an account.","operationId":"v1_createTwoFactorAuth","parameters":[{"name":"user_id","in":"path","description":"ID of user","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"title":"Create User 2FA OTP Request Body","required":["domain","path"],"properties":{"otp_id":{"description":"OTP ID","type":"string","format":"uuid"},"otp_type":{"description":"2FA Type, one of: hotp, totp","type":"string","enum":["hotp","totp"]},"domain":{"description":"2FA Domain","type":"string"},"password":{"description":"2FA Password","type":"string"},"path":{"description":"2FA Path","type":"string"}},"type":"object"}}}},"responses":{"201":{"description":"Created","content":{"application\/json":{"schema":{"title":"CreatedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]},"delete":{"tags":["Users"],"summary":"Deletes User 2FA.","operationId":"v1_deleteTwoFactorAuth","parameters":[{"name":"user_id","in":"path","description":"ID of user","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"No Content"},"410":{"description":"Gone","content":{"application\/json":{"schema":{"title":"GoneResponse","properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}},"\/v1\/users\/{user_id}\/2fa\/otp\/{otp_id}":{"patch":{"tags":["Users"],"summary":"Patch a user's OTP.","description":"Update a user's OTP, sending only the keys necessary.","operationId":"v1_updateUserOTP","parameters":[{"name":"user_id","in":"path","description":"ID of user to update","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"otp_id","in":"path","description":"ID of OTP to update","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"title":"Patch User OTP Request Body","properties":{"otp_type":{"description":"OTP Type, either 'totp' or 'hotp'","type":"string","enum":["totp","hotp"]},"counter":{"description":"Counter, for HOTP only","type":"integer"},"domain":{"description":"Domain, for display purposes only","type":"string"},"path":{"description":"Path, for display purposes only","type":"string"},"password":{"description":"The base32 encoded secret","type":"string"}},"type":"object"}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/UserOtp"}}}},"400":{"description":"Bad Request","content":{"application\/json":{"schema":{"title":"BadRequestResponse","properties":{"messages":{"type":"array","items":{"type":"string"}}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"UnauthorizedResponse","properties":{"messages":{"type":"array","items":{"type":"string"}}},"type":"object"}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"title":"ForbiddenResponse","properties":{"messages":{"type":"array","items":{"type":"string"}}},"type":"object"}}}},"404":{"description":"Not Found","content":{"application\/json":{"schema":{"title":"NotFoundResponse","properties":{"messages":{"type":"array","items":{"type":"string"}}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"properties":{"messages":{"description":"Error messages explaining what went wrong","type":"array","items":{"type":"string"}}},"type":"object"}}}}},"security":[{"sucuriAuth":[],"gatewayAuth":[]}]}}},"components":{"schemas":{"PlanFlags":{"description":"Plan constants.","properties":{"BACKUPS":{"description":"Plan flag for backups product.","type":"integer"},"FIREWALL":{"description":"Plan flag for firewall product.","type":"integer"},"FIREWALL_BUSINESS":{"description":"Plan flag for firewall business product.","type":"integer"},"FIREWALL_PRO":{"description":"Plan flag for firewall professional product.","type":"integer"},"MONITORING":{"description":"Plan flag for monitoring product.","type":"integer"},"MONITORING_BUSINESS":{"description":"Plan flag for monitoring rapid scans product.","type":"integer"},"MONITORING_FREQUENCY":{"description":"Default monitoring frequency for basic plans.","type":"integer"},"MONITORING_FREQUENCY_BUSINESS":{"description":"Default monitoring frequency for rapid plans.","type":"integer"},"MONITORING_FREQUENCY_PRO":{"description":"Default monitoring frequency for 6 hour plans.","type":"integer"},"MONITORING_PRO":{"description":"Plan flag for monitoring 6 hour scans product.","type":"integer"},"REMEDIATION":{"description":"Plan flag for remediation product.","type":"integer"},"REMEDIATION_PRIORITY":{"description":"Plan flag for remediation priority product.","type":"integer"},"REMEDIATION_LIMITED":{"description":"Plan flag for remediation limitations.","type":"integer"},"SUCURI_SSO":{"description":"Plan flag for Sucuri SSO product.","type":"integer"}},"type":"object"},"NewSyncAccountPlan":{"description":"Simple Plan information, used when syncing an Account's plans.","properties":{"name":{"description":"Plan name.","type":"string"},"limit":{"description":"Plan quantity.","type":"integer"}},"type":"object"},"NewSyncAccountPlanResponseItem":{"description":"Simple Plan information, used when syncing an Account's plans.","properties":{"name":{"description":"Plan name.","type":"string"},"account_plan_id":{"description":"Account Plan ID","type":"string","format":"uuid"}},"type":"object"},"ClientAuth":{"description":"Client key results.","properties":{"client_id":{"description":"Client ID","type":"string","format":"uuid"},"common_name":{"description":"Cert Common Name","type":"string"},"api_key":{"description":"API Key","type":"string"}},"type":"object"},"ClientKey":{"description":"Client key results.","properties":{"key_id":{"description":"Key ID","type":"string","format":"uuid"},"client_id":{"description":"Client ID","type":"string","format":"uuid"},"public_key":{"description":"Public key","type":"string"}},"type":"object"},"Account":{"description":"Accounts represent our customers, and can have multiple plans and users.","properties":{"account_id":{"description":"Account ID","type":"string","format":"uuid"},"client_id":{"description":"Client ID, only available when using Master authentication","type":"string","format":"uuid"},"enabled":{"description":"Is the account enabled?","type":"boolean"},"primary_user_id":{"description":"User ID for the primary user.","type":"string","format":"uuid"},"primary_shopper_id":{"description":"GoDaddy Shopper ID of the primary User","type":"string"},"primary_customer_id":{"description":"GoDaddy Customer ID for the primary user.","type":"string","format":"uuid"},"brand":{"description":"User whitelabel","type":"string"},"bacchus":{"description":"Has the account been backfilled in Bacchus?","type":"boolean"},"recurly_id":{"description":"Recurly Account ID","type":"string","nullable":true},"created_at":{"description":"Account creation time","type":"string"},"closed_at":{"description":"Account closed time","type":"string"}},"type":"object"},"AccountPlan":{"description":"Account plan relationship.","properties":{"account_plan_id":{"description":"Account Plan ID","type":"string","format":"uuid"},"account_id":{"description":"Account ID","type":"string","format":"uuid"},"plan_id":{"description":"Plan ID","type":"string","format":"uuid"},"plan_limit":{"description":"Site limit for this account plan","type":"integer"},"plan_flags":{"description":"Bitmask containing all the plan flags.","type":"integer"},"plan_name":{"description":"Plan name","type":"string"},"plan_uuid":{"description":"Optional Plan UUID, usually from 3rd party.","type":"string"},"plan_source":{"description":"Optional Plan Source, to record where plan comes from.","type":"string"},"has_backups":{"description":"Plan has backups.","type":"boolean"},"has_firewall":{"description":"Plan has firewall.","type":"boolean"},"has_monitoring":{"description":"Plan has monitoring.","type":"boolean"},"has_remediation":{"description":"Plan has remediation.","type":"boolean"},"has_remediation_priority":{"description":"Plan has remediation priority and should be pushed to the top of the queue.","type":"boolean"},"is_remediation_limited":{"description":"Plan is limited to X number of remediation tickets instead of unlimited.","type":"boolean"},"firewall_business":{"description":"Plan is a firewall business plan.","type":"boolean"},"firewall_pro":{"description":"Plan is a firewall professional plan.","type":"boolean"},"monitoring_business":{"description":"Plan is a monitoring business plan.","type":"boolean"},"monitoring_pro":{"description":"Plan is a monitoring professional plan.","type":"boolean"},"has_sso":{"description":"Plan has Single Sign-On (SSO) capability.","type":"boolean"}},"type":"object"},"Client":{"description":"A client is an entity that has accounts - Sucuri, GoDaddy, etc.","properties":{"client_id":{"description":"Client ID","type":"string","format":"uuid"},"display_name":{"description":"Display a human-readable label for this client","type":"string"},"brand":{"description":"User whitelabel","type":"string"},"id_append":{"description":"Used to ensure uniqueness in account IDs from different systems, leave blank for Sucuri and use the fake email suffix @brand.partner","type":"string"},"triggers_entitlement_changes":{"description":"Does this client trigger entitlement changes?","type":"boolean"}},"type":"object"},"ClientAuthBody":{"description":"The request body for Client Auth operations","properties":{"common_name":{"description":"Certificate Common Name","type":"string"}},"type":"object"},"Entitlement":{"description":"Account entitlements, for mocking GoDaddy entitlements.","properties":{"entitlement_id":{"description":"Entitlement ID","type":"string","format":"uuid"},"account_id":{"description":"Account ID","type":"string","format":"uuid"},"account_plan_id":{"description":"Account Plan ID","type":"string","format":"uuid"},"plan_id":{"description":"Plan ID","type":"string","format":"uuid"},"shopper_id":{"description":"GoDaddy Shopper ID","type":"string"},"plan_name":{"description":"Unique plan slug, like 'ultimate' or 'cloudproxy'.","type":"string"},"plan_flags":{"description":"Bitmask for different plan combinations (contains services, pro or business, etc)","type":"integer"},"entitlement_limit":{"description":"Number of slots for this entitlement record. In most cases, this will be 1.","type":"integer"},"plan_uuid":{"description":"Unique plan ID from the client, if applicable.","type":"string"},"plan_source":{"description":"Where plan was sourced from, if applicable.","type":"string"},"backups":{"description":"Plan has backups.","type":"string"},"waf":{"description":"Plan has firewall.","type":"string"},"monitoring":{"description":"Plan has monitoring.","type":"string"},"remediation":{"description":"Plan has remediation.","type":"string"}},"type":"object"},"FullAccount":{"description":"Accounts represent our customers, and can have multiple plans and users. A FullAccount may contain sensitive information.","properties":{"account_id":{"description":"Account ID","type":"string","format":"uuid"},"legacy_account_id":{"description":"Legacy Account ID","type":"string"},"client_id":{"description":"Client ID, only necessary when using Master authentication","type":"string","format":"uuid"},"legacy_params":{"description":"Legacy parameters that do not fit into this schema","type":"object"},"enabled":{"description":"Is the account enabled?","type":"boolean"},"primary_user_id":{"description":"User ID for the primary user.","type":"string","format":"uuid"},"primary_shopper_id":{"description":"GoDaddy Shopper ID of the primary User","type":"string"},"primary_customer_id":{"description":"GoDaddy Customer ID for the primary user.","type":"string","format":"uuid"},"brand":{"description":"User whitelabel","type":"string"},"bacchus":{"description":"Has the account been backfilled in Bacchus?","type":"boolean"},"recurly_id":{"description":"Recurly Account ID","type":"string","nullable":true},"created_at":{"description":"Account creation time","type":"string"},"closed_at":{"description":"Account closed time","type":"string"},"account_plan_ids":{"description":"List of plans for this account.","type":"array","items":{"type":"string","format":"uuid"}}},"type":"object"},"FullUser":{"description":"Users log in with credentials or SSO and can be assigned to roles. A FullUser may contain sensitive information.","properties":{"user_id":{"description":"User ID","type":"string","format":"uuid"},"account_id":{"description":"Account ID","type":"string","format":"uuid"},"email":{"description":"Email address","type":"string"},"shopper_id":{"description":"GoDaddy Shopper ID","type":"string"},"customer_id":{"description":"GoDaddy Customer ID","type":"string","format":"uuid"},"analytics_hash":{"description":"Analytics hash, used briefly to associate Sucuri customers with 3rd party analytics services.","type":"string"},"display_name":{"description":"First and last (or whatever combination is applicable)","type":"string"},"locale":{"description":"Locale","type":"string"},"tzone":{"description":"Time zone","type":"string"},"enabled":{"description":"Can the user log in","type":"boolean"},"nps_collected":{"description":"User has submitted an NPS","type":"boolean"},"created_at":{"description":"User creation time","type":"string"},"otp_type":{"description":"User's OTP type(s). When multiple types are configured, they are comma-separated (e.g., 'hotp,totp')","type":"string","nullable":true}},"type":"object"},"IdentityProvider":{"description":"Available Identity Providers for accounts.","properties":{"idp_id":{"description":"Identity Provider ID","type":"string","format":"uuid"},"slug":{"description":"Unique text label for this IdP, used to look up the IdP by the end users.","type":"string"},"normalized_slug":{"description":"Normalized slug for this IdP, used to prevent duplicates with dots.","type":"string"},"account_id":{"description":"Account ID.","type":"string","format":"uuid"},"entity_id":{"description":"Entity ID.","type":"string"},"sso_url":{"description":"SSO URL.","type":"string"},"slo_url":{"description":"SLO URL.","type":"string"},"slo_response_url":{"description":"SLO Response URL.","type":"string"},"x509cert":{"description":"Public x509 certificate of the IdP.","type":"string"},"x509cert_new":{"description":"New public x509 certificate of the IdP, only used when transitioning to a new cert.","type":"string"},"allow_provisioning":{"description":"Determines if users can be provisioned automatically by this Identity Provider.","type":"boolean"},"requests_insecure":{"description":"Optional. If set to true, signatures will not be added to any XML. Defaults to false.","type":"boolean"},"assertions_insecure":{"description":"Optional. If set to true, assertions will not be encrypted. Defaults to false.","type":"boolean"},"nameid_insecure":{"description":"Optional. If set to true, the NameID will not be encrypted. Defaults to false.","type":"boolean"}},"type":"object"},"IdentityProviderRole":{"description":"Maps an arbitrary Identity Provider group name to a Sucuri Role.","properties":{"role_id":{"description":"Role ID","type":"string","format":"uuid"},"idp_id":{"description":"Identity Provider ID","type":"string","format":"uuid"},"member_of":{"description":"Remote name for this role, for mapping","type":"string"}},"type":"object"},"Locale":{"description":"Available locales (or languages) for users.","properties":{"locale_id":{"description":"Locale ID","type":"string","format":"uuid"},"code":{"description":"Code is the locale code (e.g., en_US) string for this locale.","type":"string"},"label":{"description":"Label is a human-readable English string for this locale.","type":"string"},"encoding":{"description":"Type of encoding for this locale.","type":"string"}},"type":"object"},"LoginUserOtp":{"description":"One-time password (OTP) used during login.","properties":{"otp_id":{"description":"OTP ID","type":"string","format":"uuid"},"counter":{"description":"Counter","type":"integer"},"domain":{"description":"Domain","type":"string"},"password":{"description":"Password","type":"string"},"path":{"description":"Path","type":"string"},"cookies":{"description":"Cookies","type":"array","items":{"$ref":"#\/components\/schemas\/LoginUserOtpCookie"}}},"type":"object"},"LoginUserOtpCookie":{"description":"One-time password (OTP) Cookie.","properties":{"cookie":{"description":"Cookie ID","type":"string"},"created_at":{"description":"Cookie creation time","type":"string"},"expires_at":{"description":"Cookie expiration time","type":"string"}},"type":"object"},"NewAccountPlan":{"description":"Simple Plan information, used when creating a new Account.","properties":{"plan_id":{"description":"Plan ID.","type":"string","format":"uuid"},"plan_limit":{"description":"Plan quantity.","type":"integer"}},"type":"object"},"Plan":{"description":"Available plans for accounts.","properties":{"plan_id":{"description":"Plan ID","type":"string","format":"uuid"},"plan_name":{"description":"Unique plan slug, like 'ultimate' or 'cloudproxy'.","type":"string"},"modifier":{"description":"Limit modifier, used in legacy cases like '5sites' that allow one 'plan' to encompass multiple sites","type":"integer"},"plan_flags":{"description":"Bitmask for different plan combinations (contains services, pro or business, etc)","type":"integer"},"has_backups":{"description":"Plan has backups.","type":"boolean"},"has_firewall":{"description":"Plan has firewall.","type":"boolean"},"has_monitoring":{"description":"Plan has monitoring.","type":"boolean"},"has_remediation":{"description":"Plan has remediation.","type":"boolean"},"has_remediation_priority":{"description":"Plan has remediation priority and should be pushed to the top of the queue.","type":"boolean"},"is_remediation_limited":{"description":"Plan is limited to X number of remediation tickets instead of unlimited.","type":"boolean"},"firewall_business":{"description":"Plan is a firewall business plan.","type":"boolean"},"firewall_pro":{"description":"Plan is a firewall professional plan.","type":"boolean"},"monitoring_business":{"description":"Plan is a monitoring business plan.","type":"boolean"},"monitoring_pro":{"description":"Plan is a monitoring professional plan.","type":"boolean"},"has_sso":{"description":"Plan has Single Sign-On (SSO) capability.","type":"boolean"}},"type":"object"},"RecurlyWebhookAccount":{"description":"Found in Recurly billing webhooks.","properties":{"account_code":{"description":"Account code","type":"string"},"username":{"description":"Username","type":"string"},"email":{"description":"Email","type":"string"},"first_name":{"description":"First Name","type":"string"},"last_name":{"description":"Last Name","type":"string"},"company_name":{"description":"Company Name","type":"string"}},"type":"object"},"RecurlyWebhookSubscriptionPlan":{"description":"Found in Recurly billing webhooks.","properties":{"plan_code":{"description":"Subscription plan code","type":"string"}},"type":"object"},"RecurlyWebhookSubscription":{"description":"Found in Recurly billing webhooks.","properties":{"plan":{"$ref":"#\/components\/schemas\/RecurlyWebhookSubscriptionPlan"},"uuid":{"description":"Subscription UUID","type":"string"},"quantity":{"description":"Subscription quantity","type":"integer"}},"type":"object"},"RecurlyWebhookTransaction":{"description":"Found in Recurly billing webhooks.","properties":{"subscription_id":{"description":"Transaction subscription id","type":"string"}},"type":"object"},"RecurlyWebhookCanceledAccountNotificationRequestBody":{"properties":{"account":{"$ref":"#\/components\/schemas\/RecurlyWebhookAccount"}},"type":"object","xml":{"name":"canceled_account_notification"}},"RecurlyWebhookNewAccountNotificationRequestBody":{"properties":{"account":{"$ref":"#\/components\/schemas\/RecurlyWebhookAccount"}},"type":"object","xml":{"name":"new_account_notification"}},"Role":{"description":"A simple RBAC system for Accounts. Each role can have any number of tasks with permissions set in a bitmask.","properties":{"role_id":{"description":"Role ID","type":"string","format":"uuid"},"role_name":{"description":"Display name for this role","type":"string"},"account_id":{"description":"Account ID","type":"string","format":"uuid"}},"type":"object"},"Server":{"description":"Legacy Sucuri systems like Monitors and Backups rely on numbered servers, with some separation based on clients.","properties":{"server_id":{"description":"Server ID","type":"string","format":"uuid"},"server_url":{"description":"Server URL, include protocol and domain","type":"string"},"server_type":{"description":"Server type","type":"string","enum":["backups","firewall","monitor","support"]},"server_state":{"description":"Server state","type":"string","enum":["prod","test","dev"]},"allow_accounts":{"description":"Server is accepting new accounts","type":"boolean"},"priority":{"description":"Server priority (for sorting)","type":"integer"},"flags":{"description":"Server flags (for features)","type":"integer"}},"type":"object"},"ServerFlags":{"description":"Server constants.","properties":{"FLAG_NO_API":{"description":"Server flag for servers with no API.","type":"integer"}},"type":"object"},"Session":{"description":"User Session.","properties":{"account_id":{"description":"Account ID","type":"string","format":"uuid"},"legacy_account_id":{"description":"Legacy Account ID","type":"string"},"user_id":{"description":"User ID","type":"string","format":"uuid"},"shopper_id":{"description":"GoDaddy Shopper ID","type":"string"},"customer_id":{"description":"GoDaddy Customer ID","type":"string","format":"uuid"},"email":{"description":"User email","type":"string"},"locale":{"description":"User locale","type":"string"},"brand":{"description":"User whitelabel","type":"string"},"display_name":{"description":"User display name","type":"string"},"account_created_at":{"description":"Account creation time","type":"string"},"user_created_at":{"description":"User creation time","type":"string"},"account_enabled":{"description":"Is the account enabled?","type":"boolean"},"user_enabled":{"description":"Is the user enabled?","type":"boolean"},"analytics_hash":{"description":"Analytics hash, used briefly to associate Sucuri customers with 3rd party analytics services.","type":"string"},"backupservers":{"description":"Account Backups servers","type":"array","items":{"$ref":"#\/components\/schemas\/SessionServer"}},"firewallservers":{"description":"Account Firewall servers","type":"array","items":{"$ref":"#\/components\/schemas\/SessionServer"}},"monitorservers":{"description":"Account Monitoring servers","type":"array","items":{"$ref":"#\/components\/schemas\/SessionServer"}},"supportservers":{"description":"Account Support servers","type":"array","items":{"$ref":"#\/components\/schemas\/SessionServer"}},"plans":{"description":"Account plans","type":"array","items":{"$ref":"#\/components\/schemas\/SessionPlan"}},"roles":{"description":"Account roles","type":"array","items":{"$ref":"#\/components\/schemas\/SessionRole"}},"backups":{"description":"Backups max limit","type":"integer"},"firewall":{"description":"Firewall max limit","type":"integer"},"monitoring":{"description":"Monitoring max limit","type":"integer"},"remediation":{"description":"Remediation max limit","type":"integer"},"bacchus":{"description":"Has the account been backfilled in Bacchus?","type":"boolean"},"recurly_id":{"description":"Recurly Account ID","type":"string","nullable":true},"otp_type":{"description":"User's OTP type(s). When multiple types are configured, they are comma-separated (e.g., 'hotp,totp')","type":"string","nullable":true}},"type":"object"},"SessionPlan":{"description":"Plans for accounts as they appear in the Session.","properties":{"account_plan_id":{"description":"Account Plan ID","type":"string","format":"uuid"},"plan_name":{"description":"Unique plan slug, like 'ultimate' or 'cloudproxy'.","type":"string"},"modifier":{"description":"Limit modifier, used in legacy cases like '5sites' that allow one 'plan' to encompass multiple sites","type":"integer"},"plan_flags":{"description":"Bitmask for different plan combinations (contains services, pro or business, etc)","type":"integer"},"plan_limit":{"description":"Domain limit for this account plan.","type":"integer"},"plan_uuid":{"description":"Unique plan ID from the client, if applicable.","type":"string"},"plan_source":{"description":"Where plan was sourced from, if applicable.","type":"string"},"has_backups":{"description":"Plan has backups.","type":"boolean"},"has_firewall":{"description":"Plan has firewall.","type":"boolean"},"has_monitoring":{"description":"Plan has monitoring.","type":"boolean"},"has_remediation":{"description":"Plan has remediation.","type":"boolean"},"has_remediation_priority":{"description":"Plan has remediation priority and should be pushed to the top of the queue.","type":"boolean"},"is_remediation_limited":{"description":"Plan is limited to X number of remediation tickets instead of unlimited.","type":"boolean"},"firewall_business":{"description":"Plan is a firewall business plan.","type":"boolean"},"firewall_pro":{"description":"Plan is a firewall professional plan.","type":"boolean"},"monitoring_business":{"description":"Plan is a monitoring business plan.","type":"boolean"},"monitoring_pro":{"description":"Plan is a monitoring professional plan.","type":"boolean"},"has_sso":{"description":"Plan has Single Sign-On (SSO) capability.","type":"boolean"}},"type":"object"},"SessionRole":{"description":"Role object returned in Session.","properties":{"role_id":{"description":"Role ID","type":"string","format":"uuid"},"role_name":{"description":"Display name for this role","type":"string"},"tasks":{"description":"Role tasks","type":"array","items":{"$ref":"#\/components\/schemas\/Task"}}},"type":"object"},"SessionServer":{"description":"Server object returned in Session.","properties":{"server_url":{"description":"Server URL","type":"string"},"server_state":{"description":"Server state","type":"string","enum":["prod","test","dev"]}},"type":"object"},"Site":{"description":"Central list of Sucuri sites.","properties":{"account_plan_id":{"description":"Account Plan ID","type":"string","format":"uuid"},"site_id":{"description":"Site ID","type":"string","format":"uuid"},"domain_name":{"description":"Domain name for this site","type":"string"},"enabled":{"description":"Is the site operational in Sucuri?","type":"boolean"}},"type":"object"},"Task":{"description":"Role Task.","properties":{"task":{"description":"Task, period delimited string.","type":"string"},"permissions":{"description":"Task permissions bitmask.","type":"integer"}},"type":"object"},"User":{"description":"Users log in with credentials or SSO and can be assigned to roles. Distinct from accounts to allow for multitenancy.","properties":{"user_id":{"description":"User ID","type":"string","format":"uuid"},"account_id":{"description":"Account ID","type":"string","format":"uuid"},"shopper_id":{"description":"GoDaddy Shopper ID","type":"string"},"customer_id":{"description":"GoDaddy Customer ID","type":"string","format":"uuid"},"analytics_hash":{"description":"Analytics hash, used briefly to associate Sucuri customers with 3rd party analytics services.","type":"string"},"locale":{"description":"Locale","type":"string"},"tzone":{"description":"Time zone","type":"string"},"enabled":{"description":"Can the user log in","type":"boolean"},"nps_collected":{"description":"User has submitted an NPS","type":"boolean"},"created_at":{"description":"User creation time","type":"string"},"otp_type":{"description":"User's OTP type(s). When multiple types are configured, they are comma-separated (e.g., 'hotp,totp')","type":"string","nullable":true}},"type":"object"},"UserOtp":{"description":"One-time password (OTP) configuration for a user.","properties":{"otp_id":{"description":"OTP ID","type":"string","format":"uuid"},"user_id":{"description":"User ID","type":"string","format":"uuid"},"otp_type":{"description":"OTP Type","type":"string","enum":["hotp","totp"]},"counter":{"description":"Counter","type":"integer"},"domain":{"description":"Domain","type":"string"},"password":{"description":"Password","type":"string"},"path":{"description":"Path","type":"string"}},"type":"object"}},"securitySchemes":{"gatewayAuth":{"type":"apiKey","name":"Authorization","in":"header"},"sucuriAuth":{"type":"apiKey","name":"X-API-Authorization","in":"header"},"certJwtAuth":{"type":"apiKey","name":"Authorization","in":"header"},"clientKeyAuth":{"type":"apiKey","name":"X-API-Key","in":"header"}}},"tags":[{"name":"Accounts","description":"Manage Accounts"},{"name":"Agency Tokens","description":"Manage Agency Tokens"},{"name":"Billing","description":"Manage Account Billing"},{"name":"Clients","description":"Manage Clients"},{"name":"Identity Providers","description":"Manage Identity Providers"},{"name":"Locales","description":"Manage Locales"},{"name":"NPS","description":"Manage NPS Scores"},{"name":"Plans","description":"Manage Plans"},{"name":"Roles","description":"Manage Roles"},{"name":"Servers","description":"Manage Servers"},{"name":"Sites","description":"Manage Sites"},{"name":"Users","description":"Manage Users"},{"name":"Documentation","description":"API Documentation"},{"name":"Authentication","description":"API Authentication"},{"name":"Healthchecks","description":"Healthchecks"}],"servers":[{"url":"https:\/\/accounts.api.sec.godaddy.com\/","description":"Accounts API"}]}