Site Live
v1.0.0 Get your sites GET
https://my.sitebay.org/f/api/v1/site_live
Get details about all of your live sites. SiteBot Enabled.
Authorizations OAuth2PasswordBearer APIKeyCookie
Query Parameters team_id Type:
Default: page Type: integer
>=
1Default:
1
Default: 1 Page number
size Type: integer
1..100Default:
50
Default: 50 Page size
Response Samples
200
422
{
"count" : null ,
"limit" : null ,
"next" : null ,
"offset" : null ,
"previous" : null ,
"results" : [
{
"active" : null ,
"busy" : null ,
"code_server_enabled" : null ,
"code_server_password" : null ,
"created_at" : null ,
"created_by" : {
"created_at" : null ,
"email" : null ,
"first_name" : null ,
"full_name" : null ,
"id" : null ,
"is_active" : null ,
"is_payment_verified" : null ,
"is_superuser" : null ,
"is_verified" : null ,
"last_name" : null ,
"posthog_user_id" : null
},
"current_cycle_visits" : null ,
"current_storage" : null ,
"db_prefix" : null ,
"dkim_key" : null ,
"domain_option" : null ,
"external_paths" : [
{
"created_at" : null ,
"external_name" : null ,
"id" : null ,
"path" : null
}
],
"favicon_url" : null ,
"fqdn" : null ,
"git_last_sync_hash" : null ,
"git_url" : null ,
"http_auth_enabled" : null ,
"http_auth_password" : null ,
"id" : null ,
"is_free" : null ,
"is_ns_root" : null ,
"is_sleeping" : null ,
"is_testing" : null ,
"max_restore_point" : null ,
"min_restore_point" : null ,
"properties" : null ,
"region_id" : null ,
"site_stage" : null ,
"team" : {
"additional_sites" : null ,
"cancel_at" : null ,
"cancel_at_period_end" : null ,
"created_at" : null ,
"currency" : null ,
"current_cycle_bandwidth" : null ,
"current_cycle_visits" : null ,
"cycle_end" : null ,
"cycle_start" : null ,
"grafana_org_id" : null ,
"id" : null ,
"interval" : null ,
"is_active" : null ,
"is_default" : null ,
"is_expired" : null ,
"name" : null ,
"plan_type" : null ,
"plan_type_name" : null ,
"posthog_team_id" : null ,
"should_allow_shopify_payment" : null ,
"storage_usage" : null ,
"storage_usage_percentage" : null ,
"sub_id" : null ,
"tenant_id" : null ,
"timezone" : null ,
"trial_ends_on" : null ,
"user" : {
"created_at" : null ,
"email" : null ,
"first_name" : null ,
"full_name" : null ,
"id" : null ,
"is_active" : null ,
"is_payment_verified" : null ,
"is_superuser" : null ,
"is_verified" : null ,
"last_name" : null ,
"posthog_user_id" : null
},
"user_id" : null ,
"visits_usage_percentage" : null
},
"team_id" : null ,
"tenant_id" : null ,
"tracked_tables" : [
null
],
"untracked_tables" : [
null
],
"user_id" : null
}
]
}
{
"detail" : [
{
"loc" : [
null
],
"msg" : null ,
"type" : null
}
]
}
Responses
200
422
Successful Response
integer
integer
>=
1
integer
>=
0
array
of objects
boolean
boolean
string
string<date-time>
object
string<date-time>
string<email>
string
string<uuid4>
booleanDefault:
true
is_payment_verified
Required
boolean
booleanDefault:
false
booleanDefault:
false
integer
integer
string
string
array
of objects
string<date-time>
string
string<uuid4>
string
string
string
boolean
string
string<uuid4>
boolean
boolean
boolean
boolean
string<date-time>
string<date-time>
object
integer
object
cancel_at_period_end
Required
boolean
string<date-time>
current_cycle_bandwidth
Required
integer
current_cycle_visits
Required
integer
string<uuid4>
boolean
boolean
boolean
string
object
string
should_allow_shopify_payment
Required
boolean
integer
storage_usage_percentage
Required
integer
string
string
object
string<date-time>
string<email>
string
string<uuid4>
booleanDefault:
true
is_payment_verified
Required
boolean
booleanDefault:
false
booleanDefault:
false
string<uuid4>
visits_usage_percentage
Required
integer
string<uuid4>
string
array
of strings
array
of strings
string<uuid4>
Create a site POST
https://my.sitebay.org/f/api/v1/site_live
Create a new site by providing your domain and your site’s WordPress details. If you don’t include a region_name, your default region will be used. SiteBot Enabled.
Authorizations OAuth2PasswordBearer APIKeyCookie
Request Body Schema string
Default:
false
string<uuid4>
wordpress_blog_name
Required
string
string
wordpress_first_name
Required
string
wordpress_last_name
Required
string
wordpress_password
Required
string
wordpress_username
Required
string
Response Samples
201
422
{
"active" : null ,
"busy" : null ,
"code_server_enabled" : null ,
"code_server_password" : null ,
"created_at" : null ,
"created_by" : {
"created_at" : null ,
"email" : null ,
"first_name" : null ,
"full_name" : null ,
"id" : null ,
"is_active" : null ,
"is_payment_verified" : null ,
"is_superuser" : null ,
"is_verified" : null ,
"last_name" : null ,
"posthog_user_id" : null
},
"current_cycle_visits" : null ,
"current_storage" : null ,
"db_prefix" : null ,
"dkim_key" : null ,
"domain_option" : null ,
"external_paths" : [
{
"created_at" : null ,
"external_name" : null ,
"id" : null ,
"path" : null
}
],
"favicon_url" : null ,
"fqdn" : null ,
"git_last_sync_hash" : null ,
"git_url" : null ,
"http_auth_enabled" : null ,
"http_auth_password" : null ,
"id" : null ,
"is_free" : null ,
"is_ns_root" : null ,
"is_sleeping" : null ,
"is_testing" : null ,
"max_restore_point" : null ,
"min_restore_point" : null ,
"properties" : null ,
"region_id" : null ,
"site_stage" : null ,
"team" : {
"additional_sites" : null ,
"cancel_at" : null ,
"cancel_at_period_end" : null ,
"created_at" : null ,
"currency" : null ,
"current_cycle_bandwidth" : null ,
"current_cycle_visits" : null ,
"cycle_end" : null ,
"cycle_start" : null ,
"grafana_org_id" : null ,
"id" : null ,
"interval" : null ,
"is_active" : null ,
"is_default" : null ,
"is_expired" : null ,
"name" : null ,
"plan_type" : null ,
"plan_type_name" : null ,
"posthog_team_id" : null ,
"should_allow_shopify_payment" : null ,
"storage_usage" : null ,
"storage_usage_percentage" : null ,
"sub_id" : null ,
"tenant_id" : null ,
"timezone" : null ,
"trial_ends_on" : null ,
"user" : {
"created_at" : null ,
"email" : null ,
"first_name" : null ,
"full_name" : null ,
"id" : null ,
"is_active" : null ,
"is_payment_verified" : null ,
"is_superuser" : null ,
"is_verified" : null ,
"last_name" : null ,
"posthog_user_id" : null
},
"user_id" : null ,
"visits_usage_percentage" : null
},
"team_id" : null ,
"tenant_id" : null ,
"tracked_tables" : [
null
],
"untracked_tables" : [
null
],
"user_id" : null
}
{
"detail" : [
{
"loc" : [
null
],
"msg" : null ,
"type" : null
}
]
}
Responses
201
422
Your new site's details
boolean
code_server_enabled
Required
boolean
code_server_password
Required
string
string<date-time>
object
string<date-time>
string<email>
string
string<uuid4>
booleanDefault:
true
is_payment_verified
Required
boolean
booleanDefault:
false
booleanDefault:
false
current_cycle_visits
Required
integer
integer
string
string
array
of objects
string<date-time>
string
string<uuid4>
string
string
string
http_auth_enabled
Required
boolean
http_auth_password
Required
string
string<uuid4>
boolean
boolean
boolean
boolean
max_restore_point
Required
string<date-time>
min_restore_point
Required
string<date-time>
object
integer
object
cancel_at_period_end
Required
boolean
string<date-time>
current_cycle_bandwidth
Required
integer
current_cycle_visits
Required
integer
string<uuid4>
boolean
boolean
boolean
string
object
string
should_allow_shopify_payment
Required
boolean
integer
storage_usage_percentage
Required
integer
string
string
object
string<date-time>
string<email>
string
string<uuid4>
booleanDefault:
true
is_payment_verified
Required
boolean
booleanDefault:
false
booleanDefault:
false
string<uuid4>
visits_usage_percentage
Required
integer
string<uuid4>
string
array
of strings
array
of strings
string<uuid4>
Delete your live site DELETE
https://my.sitebay.org/f/api/v1/site_live/{fqdn}
This permanently deletes your site, and its stage site if one exists. SiteBot Enabled.
Authorizations OAuth2PasswordBearer APIKeyCookie
Query Parameters Response Samples
200
422
{
"detail" : [
{
"loc" : [
null
],
"msg" : null ,
"type" : null
}
]
}
Responses Get your live site GET
https://my.sitebay.org/f/api/v1/site_live/{fqdn}
Get details about your live site. SiteBot Enabled.
Authorizations OAuth2PasswordBearer APIKeyCookie
Query Parameters Response Samples
200
422
{
"active" : null ,
"busy" : null ,
"code_server_enabled" : null ,
"code_server_password" : null ,
"created_at" : null ,
"created_by" : {
"created_at" : null ,
"email" : null ,
"first_name" : null ,
"full_name" : null ,
"id" : null ,
"is_active" : null ,
"is_payment_verified" : null ,
"is_superuser" : null ,
"is_verified" : null ,
"last_name" : null ,
"posthog_user_id" : null
},
"current_cycle_visits" : null ,
"current_storage" : null ,
"db_prefix" : null ,
"dkim_key" : null ,
"domain_option" : null ,
"external_paths" : [
{
"created_at" : null ,
"external_name" : null ,
"id" : null ,
"path" : null
}
],
"favicon_url" : null ,
"fqdn" : null ,
"git_last_sync_hash" : null ,
"git_url" : null ,
"http_auth_enabled" : null ,
"http_auth_password" : null ,
"id" : null ,
"is_free" : null ,
"is_ns_root" : null ,
"is_sleeping" : null ,
"is_testing" : null ,
"max_restore_point" : null ,
"min_restore_point" : null ,
"properties" : null ,
"region_id" : null ,
"site_stage" : null ,
"team" : {
"additional_sites" : null ,
"cancel_at" : null ,
"cancel_at_period_end" : null ,
"created_at" : null ,
"currency" : null ,
"current_cycle_bandwidth" : null ,
"current_cycle_visits" : null ,
"cycle_end" : null ,
"cycle_start" : null ,
"grafana_org_id" : null ,
"id" : null ,
"interval" : null ,
"is_active" : null ,
"is_default" : null ,
"is_expired" : null ,
"name" : null ,
"plan_type" : null ,
"plan_type_name" : null ,
"posthog_team_id" : null ,
"should_allow_shopify_payment" : null ,
"storage_usage" : null ,
"storage_usage_percentage" : null ,
"sub_id" : null ,
"tenant_id" : null ,
"timezone" : null ,
"trial_ends_on" : null ,
"user" : {
"created_at" : null ,
"email" : null ,
"first_name" : null ,
"full_name" : null ,
"id" : null ,
"is_active" : null ,
"is_payment_verified" : null ,
"is_superuser" : null ,
"is_verified" : null ,
"last_name" : null ,
"posthog_user_id" : null
},
"user_id" : null ,
"visits_usage_percentage" : null
},
"team_id" : null ,
"tenant_id" : null ,
"tracked_tables" : [
null
],
"untracked_tables" : [
null
],
"user_id" : null
}
{
"detail" : [
{
"loc" : [
null
],
"msg" : null ,
"type" : null
}
]
}
Responses
200
422
Successful Response
boolean
code_server_enabled
Required
boolean
code_server_password
Required
string
string<date-time>
object
string<date-time>
string<email>
string
string<uuid4>
booleanDefault:
true
is_payment_verified
Required
boolean
booleanDefault:
false
booleanDefault:
false
current_cycle_visits
Required
integer
integer
string
string
array
of objects
string<date-time>
string
string<uuid4>
string
string
string
http_auth_enabled
Required
boolean
http_auth_password
Required
string
string<uuid4>
boolean
boolean
boolean
boolean
max_restore_point
Required
string<date-time>
min_restore_point
Required
string<date-time>
object
integer
object
cancel_at_period_end
Required
boolean
string<date-time>
current_cycle_bandwidth
Required
integer
current_cycle_visits
Required
integer
string<uuid4>
boolean
boolean
boolean
string
object
string
should_allow_shopify_payment
Required
boolean
integer
storage_usage_percentage
Required
integer
string
string
object
string<date-time>
string<email>
string
string<uuid4>
booleanDefault:
true
is_payment_verified
Required
boolean
booleanDefault:
false
booleanDefault:
false
string<uuid4>
visits_usage_percentage
Required
integer
string<uuid4>
string
array
of strings
array
of strings
string<uuid4>
Update a site PATCH
https://my.sitebay.org/f/api/v1/site_live/{fqdn}
Update a site’s details. SiteBot Enabled.
Authorizations OAuth2PasswordBearer APIKeyCookie
Query Parameters Request Body Schema Response Samples
200
422
{
"active" : null ,
"busy" : null ,
"code_server_enabled" : null ,
"code_server_password" : null ,
"created_at" : null ,
"created_by" : {
"created_at" : null ,
"email" : null ,
"first_name" : null ,
"full_name" : null ,
"id" : null ,
"is_active" : null ,
"is_payment_verified" : null ,
"is_superuser" : null ,
"is_verified" : null ,
"last_name" : null ,
"posthog_user_id" : null
},
"current_cycle_visits" : null ,
"current_storage" : null ,
"db_prefix" : null ,
"dkim_key" : null ,
"domain_option" : null ,
"external_paths" : [
{
"created_at" : null ,
"external_name" : null ,
"id" : null ,
"path" : null
}
],
"favicon_url" : null ,
"fqdn" : null ,
"git_last_sync_hash" : null ,
"git_url" : null ,
"http_auth_enabled" : null ,
"http_auth_password" : null ,
"id" : null ,
"is_free" : null ,
"is_ns_root" : null ,
"is_sleeping" : null ,
"is_testing" : null ,
"max_restore_point" : null ,
"min_restore_point" : null ,
"properties" : null ,
"region_id" : null ,
"site_stage" : null ,
"team" : {
"additional_sites" : null ,
"cancel_at" : null ,
"cancel_at_period_end" : null ,
"created_at" : null ,
"currency" : null ,
"current_cycle_bandwidth" : null ,
"current_cycle_visits" : null ,
"cycle_end" : null ,
"cycle_start" : null ,
"grafana_org_id" : null ,
"id" : null ,
"interval" : null ,
"is_active" : null ,
"is_default" : null ,
"is_expired" : null ,
"name" : null ,
"plan_type" : null ,
"plan_type_name" : null ,
"posthog_team_id" : null ,
"should_allow_shopify_payment" : null ,
"storage_usage" : null ,
"storage_usage_percentage" : null ,
"sub_id" : null ,
"tenant_id" : null ,
"timezone" : null ,
"trial_ends_on" : null ,
"user" : {
"created_at" : null ,
"email" : null ,
"first_name" : null ,
"full_name" : null ,
"id" : null ,
"is_active" : null ,
"is_payment_verified" : null ,
"is_superuser" : null ,
"is_verified" : null ,
"last_name" : null ,
"posthog_user_id" : null
},
"user_id" : null ,
"visits_usage_percentage" : null
},
"team_id" : null ,
"tenant_id" : null ,
"tracked_tables" : [
null
],
"untracked_tables" : [
null
],
"user_id" : null
}
{
"detail" : [
{
"loc" : [
null
],
"msg" : null ,
"type" : null
}
]
}
Responses
200
422
Your site's details
boolean
code_server_enabled
Required
boolean
code_server_password
Required
string
string<date-time>
object
string<date-time>
string<email>
string
string<uuid4>
booleanDefault:
true
is_payment_verified
Required
boolean
booleanDefault:
false
booleanDefault:
false
current_cycle_visits
Required
integer
integer
string
string
array
of objects
string<date-time>
string
string<uuid4>
string
string
string
http_auth_enabled
Required
boolean
http_auth_password
Required
string
string<uuid4>
boolean
boolean
boolean
boolean
max_restore_point
Required
string<date-time>
min_restore_point
Required
string<date-time>
object
integer
object
cancel_at_period_end
Required
boolean
string<date-time>
current_cycle_bandwidth
Required
integer
current_cycle_visits
Required
integer
string<uuid4>
boolean
boolean
boolean
string
object
string
should_allow_shopify_payment
Required
boolean
integer
storage_usage_percentage
Required
integer
string
string
object
string<date-time>
string<email>
string
string<uuid4>
booleanDefault:
true
is_payment_verified
Required
boolean
booleanDefault:
false
booleanDefault:
false
string<uuid4>
visits_usage_percentage
Required
integer
string<uuid4>
string
array
of strings
array
of strings
string<uuid4>
Execute shell command POST
https://my.sitebay.org/f/api/v1/site_live/{fqdn}/cmd
Send a bash shell command to your site, such as a WP-CLI command. SiteBot Enabled.
Authorizations OAuth2PasswordBearer APIKeyCookie
Query Parameters fqdn Type: string
Default: cmd Type: string
Default: cwd Type: stringDefault:
/bitnami/wordpress/wp-content
Default: /bitnami/wordpress/wp-content auto_track_dir Type: booleanDefault:
false
Default: false stage Type: booleanDefault:
false
Default: false
Response Samples
200
422
{
"detail" : [
{
"loc" : [
null
],
"msg" : null ,
"type" : null
}
]
}
Responses Get Site Events GET
https://my.sitebay.org/f/api/v1/site_live/{fqdn}/event
Get events, such as restores, updates, stage creations, etc. SiteBot Enabled.
Authorizations OAuth2PasswordBearer APIKeyCookie
Query Parameters fqdn Type: string
Default: after_datetime Type:
Default: page Type: integer
>=
1Default:
1
Default: 1 Page number
size Type: integer
1..100Default:
50
Default: 50 Page size
Response Samples
200
422
{
"count" : null ,
"limit" : null ,
"next" : null ,
"offset" : null ,
"previous" : null ,
"results" : [
{
"activity" : null ,
"created_at" : null ,
"description" : null ,
"detail" : null ,
"event_type" : null ,
"finished_at" : null ,
"fqdn" : null ,
"id" : null ,
"item_id" : null ,
"scope" : null ,
"site_live_id" : null ,
"unread" : null ,
"user" : null ,
"user_id" : null
}
]
}
{
"detail" : [
{
"loc" : [
null
],
"msg" : null ,
"type" : null
}
]
}
Responses
200
422
JSON
integer
integer
>=
1
integer
>=
0
array
of objects
string
string<date-time>
object
string<uuid4>
integerDefault:
1
stringDefault:
Site
booleanDefault:
false
Get External Paths GET
https://my.sitebay.org/f/api/v1/site_live/{fqdn}/external_path
Get details about your site’s external path configs. SiteBot Enabled.
Authorizations OAuth2PasswordBearer APIKeyCookie
Query Parameters fqdn Type: string
Default: page Type: integer
>=
1Default:
1
Default: 1 Page number
size Type: integer
1..100Default:
50
Default: 50 Page size
Response Samples
200
422
{
"count" : null ,
"limit" : null ,
"next" : null ,
"offset" : null ,
"previous" : null ,
"results" : [
{
"created_at" : null ,
"external_name" : null ,
"id" : null ,
"path" : null
}
]
}
{
"detail" : [
{
"loc" : [
null
],
"msg" : null ,
"type" : null
}
]
}
Responses
200
422
List of ExternalPathSchema
integer
integer
>=
1
integer
>=
0
array
of objects
string<date-time>
string
string<uuid4>
string
Create External Path POST
https://my.sitebay.org/f/api/v1/site_live/{fqdn}/external_path
Connect an external URL to your site on a subpath. SiteBot Enabled.
Authorizations OAuth2PasswordBearer APIKeyCookie
Query Parameters Request Body Schema Response Samples
201
422
{
"created_at" : null ,
"external_name" : null ,
"id" : null ,
"path" : null
}
{
"detail" : [
{
"loc" : [
null
],
"msg" : null ,
"type" : null
}
]
}
Responses
201
422
ExternalPathSchema
string<date-time>
string
string<uuid4>
string
Delete External Path DELETE
https://my.sitebay.org/f/api/v1/site_live/{fqdn}/external_path/{external_path_id}
Delete the link between an external URL and your site. SiteBot Enabled.
Authorizations OAuth2PasswordBearer APIKeyCookie
Query Parameters external_path_id Type: string<uuid4>
Default: fqdn Type: string
Default:
Response Samples
200
422
{
"detail" : [
{
"loc" : [
null
],
"msg" : null ,
"type" : null
}
]
}
Responses Get External Path GET
https://my.sitebay.org/f/api/v1/site_live/{fqdn}/external_path/{external_path_id}
Get an external path for your site
Authorizations OAuth2PasswordBearer APIKeyCookie
Query Parameters external_path_id Type: string<uuid4>
Default: fqdn Type: string
Default:
Response Samples
200
422
{
"created_at" : null ,
"external_name" : null ,
"id" : null ,
"path" : null
}
{
"detail" : [
{
"loc" : [
null
],
"msg" : null ,
"type" : null
}
]
}
Responses
200
422
Successful Response
string<date-time>
string
string<uuid4>
string
Update External Path PATCH
https://my.sitebay.org/f/api/v1/site_live/{fqdn}/external_path/{external_path_id}
Update your site’s external path configs. SiteBot Enabled.
Authorizations OAuth2PasswordBearer APIKeyCookie
Query Parameters external_path_id Type: string<uuid4>
Default: fqdn Type: string
Default:
Request Body Schema Response Samples
200
422
{
"created_at" : null ,
"external_name" : null ,
"id" : null ,
"path" : null
}
{
"detail" : [
{
"loc" : [
null
],
"msg" : null ,
"type" : null
}
]
}
Responses
200
422
ExternalPathSchema
string<date-time>
string
string<uuid4>
string
Get Blob Urls POST
https://my.sitebay.org/f/api/v1/site_live/{fqdn}/get_download_urls
Authorizations OAuth2PasswordBearer APIKeyCookie
Query Parameters fqdn Type: string
Default: at_date Type:
Default:
Request Body Schema Response Samples
200
422
{
"detail" : [
{
"loc" : [
null
],
"msg" : null ,
"type" : null
}
]
}
Responses Get PIT Restores GET
https://my.sitebay.org/f/api/v1/site_live/{fqdn}/pit_restore
Get all the results of a site’s restores to a previous point in time. SiteBot Enabled.
Authorizations OAuth2PasswordBearer APIKeyCookie
Query Parameters fqdn Type: string
Default: page Type: integer
>=
1Default:
1
Default: 1 Page number
size Type: integer
1..100Default:
50
Default: 50 Page size
Response Samples
200
422
{
"count" : null ,
"limit" : null ,
"next" : null ,
"offset" : null ,
"previous" : null ,
"results" : [
{
"backup_point" : null ,
"created_at" : null ,
"delete_extra_files" : null ,
"failed_reason" : null ,
"finished_at" : null ,
"git_restore_hash" : null ,
"id" : null ,
"num_files_added" : null ,
"num_files_deleted" : null ,
"num_files_restored" : null ,
"num_folders_added" : null ,
"num_tables_deleted" : null ,
"num_tables_failed" : null ,
"num_tables_restored" : null ,
"num_tables_skipped" : null ,
"passed_dry_run" : null ,
"restore_db" : null ,
"restore_point" : null ,
"restore_wp_content" : null ,
"site_live_id" : null
}
]
}
{
"detail" : [
{
"loc" : [
null
],
"msg" : null ,
"type" : null
}
]
}
Responses
200
422
PIT Restores details
integer
integer
>=
1
integer
>=
0
array
of objects
string<date-time>
boolean
string<uuid4>
boolean
string<date-time>
boolean
string<uuid4>
Create PIT Restore POST
https://my.sitebay.org/f/api/v1/site_live/{fqdn}/pit_restore
Restore your site to a previous point in time, down to the minute. SiteBot Enabled.
Authorizations OAuth2PasswordBearer APIKeyCookie
Query Parameters Request Body Schema booleanDefault:
false
booleanDefault:
false
booleanDefault:
false
booleanDefault:
true
booleanDefault:
true
Response Samples
200
422
{
"backup_point" : null ,
"created_at" : null ,
"delete_extra_files" : null ,
"failed_reason" : null ,
"finished_at" : null ,
"git_restore_hash" : null ,
"id" : null ,
"num_files_added" : null ,
"num_files_deleted" : null ,
"num_files_restored" : null ,
"num_folders_added" : null ,
"num_tables_deleted" : null ,
"num_tables_failed" : null ,
"num_tables_restored" : null ,
"num_tables_skipped" : null ,
"passed_dry_run" : null ,
"restore_db" : null ,
"restore_point" : null ,
"restore_wp_content" : null ,
"site_live_id" : null
}
{
"detail" : [
{
"loc" : [
null
],
"msg" : null ,
"type" : null
}
]
}
Responses
200
422
PIT Restore details
string<date-time>
delete_extra_files
Required
boolean
string<uuid4>
boolean
string<date-time>
restore_wp_content
Required
boolean
string<uuid4>
Get backups to create PIT Restore GET
https://my.sitebay.org/f/api/v1/site_live/{fqdn}/pit_restore/commits
Give a restore point to get your closest minutely backup details. SiteBot Enabled.
Authorizations OAuth2PasswordBearer APIKeyCookie
Query Parameters fqdn Type: string
Default: number_to_fetch Type: integerDefault:
1
Default: 1
Response Samples
200
422
{
"commit_hash" : null ,
"created_at" : null ,
"finished_at" : null ,
"id" : null ,
"tables_saved" : [
null
],
"tables_skipped" : [
null
]
}
{
"detail" : [
{
"loc" : [
null
],
"msg" : null ,
"type" : null
}
]
}
Responses
200
422
Successful Response
string<date-time>
string<uuid4>
array
of strings
array
of strings
PIT Files GET
https://my.sitebay.org/f/api/v1/site_live/{fqdn}/pit_restore/files
Get a list of wp-content files at a point in time
Authorizations OAuth2PasswordBearer APIKeyCookie
Query Parameters fqdn Type: string
Default: restore_point Type: string<date-time>
Default:
Response Samples
200
422
{
"detail" : [
{
"loc" : [
null
],
"msg" : null ,
"type" : null
}
]
}
Responses Preview PIT Restore POST
https://my.sitebay.org/f/api/v1/site_live/{fqdn}/pit_restore/preview
Restore your site to a previous point in time, down to the minute
Authorizations OAuth2PasswordBearer APIKeyCookie
Query Parameters Request Body Schema booleanDefault:
false
booleanDefault:
false
booleanDefault:
false
booleanDefault:
true
booleanDefault:
true
Response Samples
200
422
{
"backup_point" : null ,
"created_at" : null ,
"delete_extra_files" : null ,
"failed_reason" : null ,
"finished_at" : null ,
"git_restore_hash" : null ,
"id" : null ,
"num_files_added" : null ,
"num_files_deleted" : null ,
"num_files_restored" : null ,
"num_folders_added" : null ,
"num_tables_deleted" : null ,
"num_tables_failed" : null ,
"num_tables_restored" : null ,
"num_tables_skipped" : null ,
"passed_dry_run" : null ,
"restore_db" : null ,
"restore_point" : null ,
"restore_wp_content" : null ,
"site_live_id" : null
}
{
"detail" : [
{
"loc" : [
null
],
"msg" : null ,
"type" : null
}
]
}
Responses
200
422
PIT Restore details
string<date-time>
delete_extra_files
Required
boolean
string<uuid4>
boolean
string<date-time>
restore_wp_content
Required
boolean
string<uuid4>
Get PIT Restore GET
https://my.sitebay.org/f/api/v1/site_live/{fqdn}/pit_restore/{pit_restore_id}
Get the results of a site’s restore to a previous point in time. SiteBot Enabled.
Authorizations OAuth2PasswordBearer APIKeyCookie
Query Parameters pit_restore_id Type: string<uuid4>
Default: fqdn Type: string
Default: format Type: stringDefault:
json
Default: json
Response Samples
200
422
{
"detail" : [
{
"loc" : [
null
],
"msg" : null ,
"type" : null
}
]
}
Responses Get Shell Html GET
https://my.sitebay.org/f/api/v1/site_live/{fqdn}/shell_html
Authorizations OAuth2PasswordBearer APIKeyCookie
Query Parameters fqdn Type: string
Default: for_stage Type: booleanDefault:
false
Default: false
Response Samples
200
422
{
"detail" : [
{
"loc" : [
null
],
"msg" : null ,
"type" : null
}
]
}
Responses Sleep POST
https://my.sitebay.org/f/api/v1/site_live/{fqdn}/sleep
Authorizations OAuth2PasswordBearer APIKeyCookie
Query Parameters fqdn Type: string
Default: for_code_server Type: booleanDefault:
false
Default: false
Response Samples
200
422
{
"detail" : [
{
"loc" : [
null
],
"msg" : null ,
"type" : null
}
]
}
Responses Delete Stage Site DELETE
https://my.sitebay.org/f/api/v1/site_live/{fqdn}/stage
Delete your staging site. SiteBot Enabled.
Authorizations OAuth2PasswordBearer APIKeyCookie
Query Parameters Response Samples
200
422
{
"detail" : [
{
"loc" : [
null
],
"msg" : null ,
"type" : null
}
]
}
Responses Create a Staging site POST
https://my.sitebay.org/f/api/v1/site_live/{fqdn}/stage
Create a staging site on which you can test changes. SiteBot Enabled.
Authorizations OAuth2PasswordBearer APIKeyCookie
Query Parameters Request Body Schema Response Samples
200
422
{
"created_at" : null ,
"fqdn" : null ,
"git_branch" : null ,
"id" : null
}
{
"detail" : [
{
"loc" : [
null
],
"msg" : null ,
"type" : null
}
]
}
Responses
200
422
Site Stage Schema
string<date-time>
string
string<uuid4>
Commit Stage Site POST
https://my.sitebay.org/f/api/v1/site_live/{fqdn}/stage/commit
Sync the wp-content and database from your staging site to your live site. SiteBot Enabled.
Authorizations OAuth2PasswordBearer APIKeyCookie
Query Parameters Response Samples
200
422
{
"created_at" : null ,
"fqdn" : null ,
"git_branch" : null ,
"id" : null
}
{
"detail" : [
{
"loc" : [
null
],
"msg" : null ,
"type" : null
}
]
}
Responses
200
422
Your staging site object
string<date-time>
string
string<uuid4>
Get Cloudflare info GET
https://my.sitebay.org/f/api/v1/site_live/{fqdn}/tools
Get details about your live site’s tools on Cloudflare
Authorizations OAuth2PasswordBearer APIKeyCookie
Query Parameters Response Samples
200
422
{
"active" : null ,
"busy" : null ,
"code_server_enabled" : null ,
"code_server_password" : null ,
"created_at" : null ,
"created_by" : {
"created_at" : null ,
"email" : null ,
"first_name" : null ,
"full_name" : null ,
"id" : null ,
"is_active" : null ,
"is_payment_verified" : null ,
"is_superuser" : null ,
"is_verified" : null ,
"last_name" : null ,
"posthog_user_id" : null
},
"current_cycle_visits" : null ,
"current_storage" : null ,
"db_prefix" : null ,
"dkim_key" : null ,
"domain_option" : null ,
"external_paths" : [
{
"created_at" : null ,
"external_name" : null ,
"id" : null ,
"path" : null
}
],
"favicon_url" : null ,
"fqdn" : null ,
"git_last_sync_hash" : null ,
"git_url" : null ,
"http_auth_enabled" : null ,
"http_auth_password" : null ,
"id" : null ,
"is_free" : null ,
"is_ns_root" : null ,
"is_sleeping" : null ,
"is_testing" : null ,
"max_restore_point" : null ,
"min_restore_point" : null ,
"properties" : null ,
"region_id" : null ,
"site_stage" : null ,
"team" : {
"additional_sites" : null ,
"cancel_at" : null ,
"cancel_at_period_end" : null ,
"created_at" : null ,
"currency" : null ,
"current_cycle_bandwidth" : null ,
"current_cycle_visits" : null ,
"cycle_end" : null ,
"cycle_start" : null ,
"grafana_org_id" : null ,
"id" : null ,
"interval" : null ,
"is_active" : null ,
"is_default" : null ,
"is_expired" : null ,
"name" : null ,
"plan_type" : null ,
"plan_type_name" : null ,
"posthog_team_id" : null ,
"should_allow_shopify_payment" : null ,
"storage_usage" : null ,
"storage_usage_percentage" : null ,
"sub_id" : null ,
"tenant_id" : null ,
"timezone" : null ,
"trial_ends_on" : null ,
"user" : {
"created_at" : null ,
"email" : null ,
"first_name" : null ,
"full_name" : null ,
"id" : null ,
"is_active" : null ,
"is_payment_verified" : null ,
"is_superuser" : null ,
"is_verified" : null ,
"last_name" : null ,
"posthog_user_id" : null
},
"user_id" : null ,
"visits_usage_percentage" : null
},
"team_id" : null ,
"tenant_id" : null ,
"tracked_tables" : [
null
],
"untracked_tables" : [
null
],
"user_id" : null
}
{
"detail" : [
{
"loc" : [
null
],
"msg" : null ,
"type" : null
}
]
}
Responses
200
422
Successful Response
boolean
code_server_enabled
Required
boolean
code_server_password
Required
string
string<date-time>
object
string<date-time>
string<email>
string
string<uuid4>
booleanDefault:
true
is_payment_verified
Required
boolean
booleanDefault:
false
booleanDefault:
false
current_cycle_visits
Required
integer
integer
string
string
array
of objects
string<date-time>
string
string<uuid4>
string
string
string
http_auth_enabled
Required
boolean
http_auth_password
Required
string
string<uuid4>
boolean
boolean
boolean
boolean
max_restore_point
Required
string<date-time>
min_restore_point
Required
string<date-time>
object
integer
object
cancel_at_period_end
Required
boolean
string<date-time>
current_cycle_bandwidth
Required
integer
current_cycle_visits
Required
integer
string<uuid4>
boolean
boolean
boolean
string
object
string
should_allow_shopify_payment
Required
boolean
integer
storage_usage_percentage
Required
integer
string
string
object
string<date-time>
string<email>
string
string<uuid4>
booleanDefault:
true
is_payment_verified
Required
boolean
booleanDefault:
false
booleanDefault:
false
string<uuid4>
visits_usage_percentage
Required
integer
string<uuid4>
string
array
of strings
array
of strings
string<uuid4>
Get Site Team Usage GET
https://my.sitebay.org/f/api/v1/site_live/{fqdn}/usage
Get your visits and storage for a site at a given interval
Authorizations OAuth2PasswordBearer APIKeyCookie
Query Parameters fqdn Type: string
Default: start Type: string<date-time>
Default: end Type: string<date-time>
Default:
Response Samples
200
422
{
"detail" : [
{
"loc" : [
null
],
"msg" : null ,
"type" : null
}
]
}
Responses 
