diff --git a/_app/main.js b/_app/main.js
index e731e92d8..82705eb84 100644
--- a/_app/main.js
+++ b/_app/main.js
@@ -650,6 +650,9 @@ App.Views = {};
// deal with common-lang-blocks
this.toggleCommonLangBlocks();
+ // setup the server/mount path editor
+ this.setupServerFieldCustomization();
+
// add toggles to code blocks if necessary
if (this.platform === "ios" || this.platform === "osx" || this.platform === "macos") {
new App.Views.Docs.Toggle({
@@ -729,6 +732,123 @@ App.Views = {};
}
},
+ setupServerFieldCustomization: function setupServerFieldCustomization() {
+
+ if(!document.getElementById('parse-server-custom-url')) {
+ // no customization available on this page
+ return;
+ }
+
+ if (typeof(Storage) !== "undefined") {
+ // apply previous values from local storage
+ const _url = localStorage.getItem('parse-server-custom-url');
+ const _mount = localStorage.getItem('parse-server-custom-mount');
+ const _protocol = localStorage.getItem('parse-server-custom-protocol');
+ const _appId = localStorage.getItem('parse-server-custom-appid');
+ const _clientKey = localStorage.getItem('parse-server-custom-clientkey');
+
+ // set existing entries
+ if (_url) {
+ $(".custom-parse-server-url").html(_url);
+ $("#parse-server-custom-url").val(_url);
+ }
+ if (_mount) {
+ $(".custom-parse-server-mount").html(_mount);
+ $("#parse-server-custom-mount").val(_mount);
+ }
+ if (_protocol) {
+ $(".custom-parse-server-protocol").html(_protocol);
+ $("#parse-server-custom-protocol").val(_protocol);
+ }
+ if (_appId) {
+ $(".custom-parse-server-appid").html(_appId);
+ $("#parse-server-custom-appid").val(_appId);
+ }
+ if (_clientKey) {
+ $(".custom-parse-server-clientkey").html(_clientKey);
+ $("#parse-server-custom-clientkey").val(_clientKey);
+ }
+ }
+
+ // set url listener
+ $('#parse-server-custom-url').keyup(function() {
+ const url = $('#parse-server-custom-url').val();
+ if(!url.match(/^[-_a-z0-9\.]+(?::[0-9]+)?$/i)) {
+ // not a valid url
+ return;
+ }
+ $(".custom-parse-server-url").html(url);
+ if (typeof(Storage) !== "undefined") {
+ localStorage.setItem('parse-server-custom-url', url);
+ }
+ });
+
+ // set mount listener
+ $('#parse-server-custom-mount').keyup(function() {
+ var mount = $('#parse-server-custom-mount').val();
+ if(!mount.match(/^[-_a-z0-9\/]+$/i) && mount !== '') {
+ // not a valid mount path, and not empty
+ return;
+ }
+ if(!mount.match(/^\//)) {
+ // add leading slash
+ mount = '/'+mount;
+ }
+ if(!mount.match(/\/$/)) {
+ // add trailing slash
+ mount = mount+'/';
+ }
+ $(".custom-parse-server-mount").html(mount);
+ if (typeof(Storage) !== "undefined") {
+ localStorage.setItem('parse-server-custom-mount', mount);
+ }
+ });
+
+ // set protocol listener
+ $('#parse-server-custom-protocol').change(function() {
+ const protocol = $('#parse-server-custom-protocol').val();
+ if(!protocol.match(/^[a-z]+$/)) {
+ // not a valid protocol
+ return;
+ }
+ $(".custom-parse-server-protocol").html(protocol);
+ if (typeof(Storage) !== "undefined") {
+ localStorage.setItem('parse-server-custom-protocol', protocol);
+ }
+ });
+
+ // set appId listener
+ $('#parse-server-custom-appid').keyup(function() {
+ var appId = $('#parse-server-custom-appid').val();
+ if(!appId.match(/^[^\s]+$/i)) {
+ // not a valid appId
+ return;
+ }
+ // encode any html
+ appId = appId.replace(/&/g, '&').replace(//g, '>').replace(/"/g, '"');
+ $(".custom-parse-server-appid").html(appId);
+ if (typeof(Storage) !== "undefined") {
+ localStorage.setItem('parse-server-custom-appid', appId);
+ }
+ });
+
+ // set clientKey listener
+ $('#parse-server-custom-clientkey').keyup(function() {
+ var clientKey = $('#parse-server-custom-clientkey').val();
+ if(!clientKey.match(/^[^\s]+$/i)) {
+ // not a valid appId
+ return;
+ }
+ // encode any html
+ clientKey = clientKey.replace(/&/g, '&').replace(//g, '>').replace(/"/g, '"');
+ $(".custom-parse-server-clientkey").html(clientKey);
+ if (typeof(Storage) !== "undefined") {
+ localStorage.setItem('parse-server-custom-clientkey', clientKey);
+ }
+ });
+
+ },
+
// we recalculate the header heights for the TOC
// highlighting when the height of the content changes
handleToggleChange: function() {
@@ -753,7 +873,7 @@ $('pre code').each(function(i, block) {
hljs.highlightBlock(block);
});
-var platform = window.location.pathname.split('/')[2];
+var platform = window.location.pathname.split('/')[1];
if (platform) {
new App.Views.Docs.Main({
language: 'en',
diff --git a/_includes/android/push-notifications.md b/_includes/android/push-notifications.md
index c3b348aa6..3b4592fd9 100644
--- a/_includes/android/push-notifications.md
+++ b/_includes/android/push-notifications.md
@@ -480,7 +480,7 @@ curl -X GET \
-G \
--data-urlencode 'limit=1000' \
--data-urlencode 'where={ "city": "San Francisco", "deviceType": { "$in": [ "ios", "android", "winphone", "embedded" ] } }' \
-https://api.parse.com/1/installations
+https://YOUR.PARSE-SERVER.HERE/parse/installations
```
If you type the above into a console, you should be able to see the first 1,000 objects that match your query. Note that constraints are always ANDed, so if you want to further reduce the search scope, you can add a constraint that matches the specific installation for your device:
@@ -493,7 +493,7 @@ curl -X GET \
-G \
--data-urlencode 'limit=1' \
--data-urlencode 'where={ “objectId”: {YOUR_INSTALLATION_OBJECT_ID}, "city": "San Francisco", "deviceType": { "$in": [ "ios", "android", "winphone", "embedded" ] } }' \
-https://api.parse.com/1/installations
+https://YOUR.PARSE-SERVER.HERE/parse/installations
```
If the above query returns no results, it is likely that your installation does not meet the targeting criteria for your campaign.
diff --git a/_includes/arduino/other.md b/_includes/arduino/other.md
index c34e16308..465b0ba46 100644
--- a/_includes/arduino/other.md
+++ b/_includes/arduino/other.md
@@ -5,7 +5,7 @@ Because the Arduino SDK was designed to minimize memory footprint, it doesn't pr
For example, you could sign up a user from Arduino through a REST call:
```cpp
-ParseResponse response = Parse.sendRequest("POST", "/1/users", "{\"username\":\"cooldude6\",\"password\":\"p_n7!-e8\"}", "");
+ParseResponse response = Parse.sendRequest("POST", "/parse/users", "{\"username\":\"cooldude6\",\"password\":\"p_n7!-e8\"}", "");
```
In this case, the response will contain the objectId of the created user, assuming it was created successfully.
diff --git a/_includes/arduino/requests.md b/_includes/arduino/requests.md
index de44dafba..5fd2aa1d3 100644
--- a/_includes/arduino/requests.md
+++ b/_includes/arduino/requests.md
@@ -5,7 +5,7 @@ Because the Arduino SDK was designed to minimize memory footprint, it doesn't pr
For example, you could sign up a user from Arduino through a REST call:
```cpp
-ParseResponse response = Parse.sendRequest("POST", "/1/users", "{\"username\":\"cooldude6\",\"password\":\"p_n7!-e8\"}", "");
+ParseResponse response = Parse.sendRequest("POST", "/parse/users", "{\"username\":\"cooldude6\",\"password\":\"p_n7!-e8\"}", "");
```
In this case, the response will contain the objectId of the created user, assuming it was created successfully.
diff --git a/_includes/cloudcode/cloud-code.md b/_includes/cloudcode/cloud-code.md
index 2a5b0a5a2..7399dc882 100644
--- a/_includes/cloudcode/cloud-code.md
+++ b/_includes/cloudcode/cloud-code.md
@@ -98,7 +98,7 @@ curl -X POST \
-H "X-Parse-REST-API-Key: ${REST_API_KEY}" \
-H "Content-Type: application/json" \
-d '{ "movie": "The Matrix" }' \
- https://api.parse.com/1/functions/averageStars
+ https://YOUR.PARSE-SERVER.HERE/parse/functions/averageStars
```
And finally, to call the same function from a JavaScript app:
diff --git a/_includes/common/security.md b/_includes/common/security.md
index d56a13a56..93997a894 100644
--- a/_includes/common/security.md
+++ b/_includes/common/security.md
@@ -456,9 +456,9 @@ There are some special classes in Parse that don't follow all of the same securi
|Delete|normal behavior [5]|master key only [7]|
|Add Field|normal behavior|normal behavior|
-1. Logging in, or `/1/login` in the REST API, does not respect the Get CLP on the user class. Login works just based on username and password, and cannot be disabled using CLPs.
+1. Logging in, or `/parse/login` in the REST API, does not respect the Get CLP on the user class. Login works just based on username and password, and cannot be disabled using CLPs.
-2. Retrieving the current user, or becoming a User based on a session token, which are both `/1/users/me` in the REST API, do not respect the Get CLP on the user class.
+2. Retrieving the current user, or becoming a User based on a session token, which are both `/parse/users/me` in the REST API, do not respect the Get CLP on the user class.
3. Read ACLs do not apply to the logged in user. For example, if all users have ACLs with Read disabled, then doing a find query over users will still return the logged in user. However, if the Find CLP is disabled, then trying to perform a find on users will still return an error.
diff --git a/_includes/common/server-customize.md b/_includes/common/server-customize.md
new file mode 100644
index 000000000..ffa3a030d
--- /dev/null
+++ b/_includes/common/server-customize.md
@@ -0,0 +1,24 @@
+# Your Configuration
+
+
+Customize our docs with your server configuration.
+
+Protocol:
+
+Domain:
+
+Mount Path:
+
+App Id:
+
+Client Key:
+
+
+- serverUrl: https://YOUR.PARSE-SERVER.HERE/parse/
+- appId: APPLICATION_ID
+- clientKey: CLIENT_KEY
\ No newline at end of file
diff --git a/_includes/embedded_c/cloud-code.md b/_includes/embedded_c/cloud-code.md
index 34a4b9f5f..28733ca8c 100644
--- a/_includes/embedded_c/cloud-code.md
+++ b/_includes/embedded_c/cloud-code.md
@@ -20,5 +20,5 @@ void myCloudFunctionCallback(ParseClient client, int error, int httpStatus, cons
// httpResponseBody holds the Cloud Function response
}
}
-parseSendRequest(client, "POST", "/1/functions/hello", "{\"value\":\"echo\"}", myCloudFunctionCallback);
+parseSendRequest(client, "POST", "/parse/functions/hello", "{\"value\":\"echo\"}", myCloudFunctionCallback);
```
diff --git a/_includes/embedded_c/requests.md b/_includes/embedded_c/requests.md
index 86a865f72..aa6972e4a 100644
--- a/_includes/embedded_c/requests.md
+++ b/_includes/embedded_c/requests.md
@@ -3,7 +3,7 @@
The main way you'll be interacting with Parse is through the `parseSendRequest` function, which sends a request to the REST API. For example, here's how to save an object with some data:
```cpp
-char data[] = "{ \"temperature\": 165 }"; parseSendRequest(client, "POST", "/1/classes/Temperature", data, NULL);
+char data[] = "{ \"temperature\": 165 }"; parseSendRequest(client, "POST", "/parse/classes/Temperature", data, NULL);
```
For some requests you will be interested in data returned for the request. In such a case you need to setup a callback and pass it to `parseSendRequest`.
@@ -15,7 +15,7 @@ void mySaveCallback(ParseClient client, int error, int httpStatus, const char* h
}
}
-parseSendRequest(client, "GET", "/1/classes/TestObject/gsMHOY3MAx", NULL, myCallback);
+parseSendRequest(client, "GET", "/parse/classes/TestObject/gsMHOY3MAx", NULL, myCallback);
```
Using this function, you have full access to the REST API to create objects, delete objects, send analytics events, and more. Take a look at the [REST API Guide]({{ site.baseUrl }}/rest/guide) to find out all the details.
diff --git a/_includes/ios/push-notifications.md b/_includes/ios/push-notifications.md
index 4ddc613fd..3a744cc4d 100644
--- a/_includes/ios/push-notifications.md
+++ b/_includes/ios/push-notifications.md
@@ -875,7 +875,7 @@ curl -X GET \
-G \
--data-urlencode 'limit=1000' \
--data-urlencode 'where={ "city": "San Francisco", "deviceType": { "$in": [ "ios", "android", "winphone", "embedded" ] } }' \
-https://api.parse.com/1/installations
+https://YOUR.PARSE-SERVER.HERE/parse/installations
If you type the above into a console, you should be able to see the first 1,000 objects that match your query. Note that constraints are always ANDed, so if you want to further reduce the search scope, you can add a constraint that matches the specific installation for your device:
@@ -888,7 +888,7 @@ curl -X GET \
-G \
--data-urlencode 'limit=1' \
--data-urlencode 'where={ “objectId”: {YOUR_INSTALLATION_OBJECT_ID}, "city": "San Francisco", "deviceType": { "$in": [ "ios", "android", "winphone", "embedded" ] } }' \
-https://api.parse.com/1/installations
+https://YOUR.PARSE-SERVER.HERE/parse/installations
If the above query returns no results, it is likely that your installation does not meet the targeting criteria for your campaign.
diff --git a/_includes/js/users.md b/_includes/js/users.md
index 0bb92c368..42afa0ad8 100644
--- a/_includes/js/users.md
+++ b/_includes/js/users.md
@@ -464,7 +464,7 @@ Parse then verifies that the provided `authData` is valid and checks to see if a
Status: 200 OK
-Location: https://api.parse.com/1/users/uMz0YZeAqc
+Location: https://YOUR.PARSE-SERVER.HERE/parse/users/uMz0YZeAqc
With a response body like:
@@ -492,7 +492,7 @@ If the user has never been linked with this account, you will instead receive a
Status: 201 Created
-Location: https://api.parse.com/1/users/uMz0YZeAqc
+Location: https://YOUR.PARSE-SERVER.HERE/parse/users/uMz0YZeAqc
The body of the response will contain the `objectId`, `createdAt`, `sessionToken`, and an automatically-generated unique `username`. For example:
diff --git a/_includes/rest/analytics.md b/_includes/rest/analytics.md
index 8e8980f45..117ca34f0 100644
--- a/_includes/rest/analytics.md
+++ b/_includes/rest/analytics.md
@@ -25,20 +25,20 @@ In the example below, the `at` parameter is optional. If omitted, the current se
-Note that Parse currently only stores the first eight dimension pairs per call to `/1/events/`.
+Note that Parse currently only stores the first eight dimension pairs per call to /parse/events/<eventName>.
diff --git a/_includes/rest/cloud-code.md b/_includes/rest/cloud-code.md
index 4232d5b3c..843a34318 100644
--- a/_includes/rest/cloud-code.md
+++ b/_includes/rest/cloud-code.md
@@ -6,19 +6,19 @@ Cloud Functions can be called using the REST API. For example, to call the Cloud
import json,httplib
-connection = httplib.HTTPSConnection('api.parse.com', 443)
+connection = httplib.HTTPSConnection('YOUR.PARSE-SERVER.HERE', 443)
connection.connect()
-connection.request('POST', '/1/jobs/userMigration', json.dumps({
+connection.request('POST', '/parse/jobs/userMigration', json.dumps({
"plan": "paid"
}), {
- "X-Parse-Application-Id": "${APPLICATION_ID}",
+ "X-Parse-Application-Id": "${APPLICATION_ID}",
"X-Parse-Master-Key": "${MASTER_KEY}",
"Content-Type": "application/json"
})
diff --git a/_includes/rest/config.md b/_includes/rest/config.md
index abf96fc03..ad19ce718 100644
--- a/_includes/rest/config.md
+++ b/_includes/rest/config.md
@@ -8,16 +8,16 @@ After that you will be able to fetch the config on the client by sending a `GET`
var request = require('request');
diff --git a/_includes/rest/files.md b/_includes/rest/files.md
index 027d5b83d..bdc956404 100644
--- a/_includes/rest/files.md
+++ b/_includes/rest/files.md
@@ -6,18 +6,18 @@ To upload a file to Parse, send a POST request to the files URL, postfixed with
import json,httplib
-connection = httplib.HTTPSConnection('api.parse.com', 443)
+connection = httplib.HTTPSConnection('YOUR.PARSE-SERVER.HERE', 443)
connection.connect()
-connection.request('DELETE', '/1/files/...profile.png', '', {
- "X-Parse-Application-Id": "${APPLICATION_ID}",
+connection.request('DELETE', '/parse/files/...profile.png', '', {
+ "X-Parse-Application-Id": "${APPLICATION_ID}",
"X-Parse-Master-Key": "${MASTER_KEY}"
})
result = json.loads(connection.getresponse().read())
diff --git a/_includes/rest/geopoints.md b/_includes/rest/geopoints.md
index 57963e6cc..be51cf251 100644
--- a/_includes/rest/geopoints.md
+++ b/_includes/rest/geopoints.md
@@ -8,7 +8,7 @@ To associate a point with an object you will need to embed a `GeoPoint` data typ
import json,httplib
-connection = httplib.HTTPSConnection('api.parse.com', 443)
+connection = httplib.HTTPSConnection('YOUR.PARSE-SERVER.HERE', 443)
connection.connect()
-connection.request('GET', '/1/hooks/functions/sendMessage', '', {
- "X-Parse-Application-Id": "${APPLICATION_ID}",
+connection.request('GET', '/parse/hooks/functions/sendMessage', '', {
+ "X-Parse-Application-Id": "${APPLICATION_ID}",
"X-Parse-Master-Key": "${MASTER_KEY}",
"Content-Type": "application/json"
})
@@ -120,17 +120,17 @@ The output is a json object with one key: "results" whose value is a list of clo
To fetch the list of all cloud triggers you deployed or created, use:
import json,httplib
-connection = httplib.HTTPSConnection('api.parse.com', 443)
+connection = httplib.HTTPSConnection('YOUR.PARSE-SERVER.HERE', 443)
connection.connect()
-connection.request('GET', '/1/hooks/triggers', '', {
- "X-Parse-Application-Id": "${APPLICATION_ID}",
+connection.request('GET', '/parse/hooks/triggers', '', {
+ "X-Parse-Application-Id": "${APPLICATION_ID}",
"X-Parse-Master-Key": "${MASTER_KEY}",
"Content-Type": "application/json"
})
@@ -161,17 +161,17 @@ The output is a json object with one key: "results" whose value is a list of clo
To fetch a single cloud trigger, use:
import json,httplib
-connection = httplib.HTTPSConnection('api.parse.com', 443)
+connection = httplib.HTTPSConnection('YOUR.PARSE-SERVER.HERE', 443)
connection.connect()
-connection.request('GET', '/1/hooks/triggers/Scores/beforeSave', '', {
- "X-Parse-Application-Id": "${APPLICATION_ID}",
+connection.request('GET', '/parse/hooks/triggers/Scores/beforeSave', '', {
+ "X-Parse-Application-Id": "${APPLICATION_ID}",
"X-Parse-Master-Key": "${MASTER_KEY}",
"Content-Type": "application/json"
})
@@ -204,29 +204,30 @@ To create cloud code functions or cloud code triggers you can modify your cloud
and perform a `parse deploy` the usual way.
## Create function webhook
-To create a new function webhook post to `/1/hooks/functions` with payload in the format
-
+To create a new function webhook post to /parse/hooks/functions with payload in the format
+
+```json
{"functionName" : x, "url" : y}
-
import json,httplib
-connection = httplib.HTTPSConnection('api.parse.com', 443)
+connection = httplib.HTTPSConnection('YOUR.PARSE-SERVER.HERE', 443)
connection.connect()
-connection.request('POST', '/1/hooks/functions', json.dumps(
+connection.request('POST', '/parse/hooks/functions', json.dumps(
{"functionName":"baz","url":"https://api.example.com/baz"}
), {
- "X-Parse-Application-Id": "${APPLICATION_ID}",
+ "X-Parse-Application-Id": "${APPLICATION_ID}",
"X-Parse-Master-Key": "${MASTER_KEY}",
"Content-Type": "application/json"
})
@@ -246,20 +247,20 @@ If you try to create a function webhook and a cloud code function with the same
For example,
## Create trigger webhook
-To create a new function webhook post to `/1/hooks/triggers` with payload in the format
+To create a new function webhook post to /parse/hooks/triggers with payload in the format
{"className": x, "triggerName": y, "url": z}
@@ -288,20 +289,20 @@ To create a new function webhook post to `/1/hooks/triggers` with payload in the
Post example,
import json,httplib
-connection = httplib.HTTPSConnection('api.parse.com', 443)
+connection = httplib.HTTPSConnection('YOUR.PARSE-SERVER.HERE', 443)
connection.connect()
-connection.request('POST', '/1/hooks/triggers', json.dumps(
+connection.request('POST', '/parse/hooks/triggers', json.dumps(
{"className": "Game", "triggerName": "beforeSave", "url": "https://api.example.com/Game/beforeSave"}
), {
- "X-Parse-Application-Id": "${APPLICATION_ID}",
+ "X-Parse-Application-Id": "${APPLICATION_ID}",
"X-Parse-Master-Key": "${MASTER_KEY}",
"Content-Type": "application/json"
})
@@ -325,20 +326,20 @@ If you try to create a trigger webhook and a cloud code trigger with the same na
For example,
import json,httplib
-connection = httplib.HTTPSConnection('api.parse.com', 443)
+connection = httplib.HTTPSConnection('YOUR.PARSE-SERVER.HERE', 443)
connection.connect()
-connection.request('POST', '/1/hooks/triggers', json.dumps(
+connection.request('POST', '/parse/hooks/triggers', json.dumps(
{"className": "Tournament", "triggerName": "beforeDelete", "url": "https://api.example.com/Scores/beforeDelete"}
), {
- "X-Parse-Application-Id": "${APPLICATION_ID}",
+ "X-Parse-Application-Id": "${APPLICATION_ID}",
"X-Parse-Master-Key": "${MASTER_KEY}",
"Content-Type": "application/json"
})
@@ -362,20 +363,20 @@ To edit the url of a function webhook that was already created use the put metho
Put example,
import json,httplib
-connection = httplib.HTTPSConnection('api.parse.com', 443)
+connection = httplib.HTTPSConnection('YOUR.PARSE-SERVER.HERE', 443)
connection.connect()
-connection.request('PUT', '/1/hooks/functions/baz', json.dumps(
+connection.request('PUT', '/parse/hooks/functions/baz', json.dumps(
{"url":"https://api.example.com/_baz"}
), {
- "X-Parse-Application-Id": "${APPLICATION_ID}",
+ "X-Parse-Application-Id": "${APPLICATION_ID}",
"X-Parse-Master-Key": "${MASTER_KEY}",
"Content-Type": "application/json"
})
@@ -395,20 +396,20 @@ If you try to update a function webhook and a cloud code function with the same
For example,
import json,httplib
-connection = httplib.HTTPSConnection('api.parse.com', 443)
+connection = httplib.HTTPSConnection('YOUR.PARSE-SERVER.HERE', 443)
connection.connect()
-connection.request('PUT', '/1/hooks/triggers/Game/beforeSave', json.dumps(
+connection.request('PUT', '/parse/hooks/triggers/Game/beforeSave', json.dumps(
{"url": "https://api.example.com/Game/_beforeSave"}
), {
- "X-Parse-Application-Id": "${APPLICATION_ID}",
+ "X-Parse-Application-Id": "${APPLICATION_ID}",
"X-Parse-Master-Key": "${MASTER_KEY}",
"Content-Type": "application/json"
})
@@ -467,20 +468,20 @@ If you try to update a trigger webhook and a cloud code trigger with the same na
For example,
import json,httplib
-connection = httplib.HTTPSConnection('api.parse.com', 443)
+connection = httplib.HTTPSConnection('YOUR.PARSE-SERVER.HERE', 443)
connection.connect()
-connection.request('PUT', '/1/hooks/triggers/Tournament/beforeDelete', json.dumps(
+connection.request('PUT', '/parse/hooks/triggers/Tournament/beforeDelete', json.dumps(
{"__op": "Delete"}
), {
- "X-Parse-Application-Id": "${APPLICATION_ID}",
+ "X-Parse-Application-Id": "${APPLICATION_ID}",
"X-Parse-Master-Key": "${MASTER_KEY}",
"Content-Type": "application/json"
})
diff --git a/_includes/rest/objects.md b/_includes/rest/objects.md
index 963d9dcb3..c213dc577 100644
--- a/_includes/rest/objects.md
+++ b/_includes/rest/objects.md
@@ -36,19 +36,19 @@ When you retrieve objects from Parse, some fields are automatically added: `crea
In the REST API, the class-level operations operate on a resource based on just the class name. For example, if the class name is `GameScore`, the class URL is:
The operations specific to a single object are available a nested URL. For example, operations specific to the `GameScore` above with `objectId` equal to `Ed1nuqPvcm` would use the object URL:
import json,httplib
-connection = httplib.HTTPSConnection('api.parse.com', 443)
+connection = httplib.HTTPSConnection('YOUR.PARSE-SERVER.HERE', 443)
connection.connect()
-connection.request('POST', '/1/classes/GameScore', json.dumps({
+connection.request('POST', '/parse/classes/GameScore', json.dumps({
"score": 1337,
"playerName": "Sean Plott",
"cheatMode": False
}), {
- "X-Parse-Application-Id": "${APPLICATION_ID}",
+ "X-Parse-Application-Id": "${APPLICATION_ID}",
"X-Parse-REST-API-Key": "${REST_API_KEY}",
"Content-Type": "application/json"
})
@@ -86,7 +86,7 @@ When the creation is successful, the HTTP response is a `201 Created` and the `L
Status: 201 Created
-Location: https://api.parse.com/1/classes/GameScore/Ed1nuqPvcm
+Location: https://YOUR.PARSE-SERVER.HERE/parse/classes/GameScore/Ed1nuqPvcm
The response body is a JSON object containing the `objectId` and the `createdAt` timestamp of the newly-created object:
@@ -104,16 +104,16 @@ Once you've created an object, you can retrieve its contents by sending a GET re
import json,httplib,urllib
-connection = httplib.HTTPSConnection('api.parse.com', 443)
+connection = httplib.HTTPSConnection('YOUR.PARSE-SERVER.HERE', 443)
params = urllib.urlencode({"include":"game"})
connection.connect()
-connection.request('GET', '/1/classes/GameScore/Ed1nuqPvcm?%s' % params, '', {
- "X-Parse-Application-Id": "${APPLICATION_ID}",
+connection.request('GET', '/parse/classes/GameScore/Ed1nuqPvcm?%s' % params, '', {
+ "X-Parse-Application-Id": "${APPLICATION_ID}",
"X-Parse-REST-API-Key": "${REST_API_KEY}"
})
result = json.loads(connection.getresponse().read())
@@ -166,20 +166,20 @@ To change the data on an object that already exists, send a PUT request to the o
import json,httplib
-connection = httplib.HTTPSConnection('api.parse.com', 443)
+connection = httplib.HTTPSConnection('YOUR.PARSE-SERVER.HERE', 443)
connection.connect()
-connection.request('DELETE', '/1/classes/GameScore/Ed1nuqPvcm', '', {
- "X-Parse-Application-Id": "${APPLICATION_ID}",
+connection.request('DELETE', '/parse/classes/GameScore/Ed1nuqPvcm', '', {
+ "X-Parse-Application-Id": "${APPLICATION_ID}",
"X-Parse-REST-API-Key": "${REST_API_KEY}"
})
result = json.loads(connection.getresponse().read())
@@ -388,22 +388,22 @@ You can delete a single field from an object by using the `Delete` operation:
import json,httplib
-connection = httplib.HTTPSConnection('api.parse.com', 443)
+connection = httplib.HTTPSConnection('YOUR.PARSE-SERVER.HERE', 443)
connection.connect()
-connection.request('POST', '/1/installations', json.dumps({
+connection.request('POST', '/parse/installations', json.dumps({
"deviceType": "ios",
"deviceToken": "0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef",
"channels": [
""
]
}), {
- "X-Parse-Application-Id": "${APPLICATION_ID}",
+ "X-Parse-Application-Id": "${APPLICATION_ID}",
"X-Parse-REST-API-Key": "${REST_API_KEY}",
"Content-Type": "application/json"
})
@@ -65,7 +65,7 @@ When the creation is successful, the HTTP response is a `201 Created` and the `L
Status: 201 Created
-Location: https://api.parse.com/1/installations/mrmBZvsErB
+Location: https://YOUR.PARSE-SERVER.HERE/parse/installations/mrmBZvsErB
The response body is a JSON object containing the `objectId` and the `createdAt` timestamp of the newly-created installation:
@@ -88,7 +88,7 @@ You could create and object with these fields using a command like this:
import json,httplib
-connection = httplib.HTTPSConnection('api.parse.com', 443)
+connection = httplib.HTTPSConnection('YOUR.PARSE-SERVER.HERE', 443)
connection.connect()
-connection.request('DELETE', '/1/installations/mrmBZvsErB', '', {
- "X-Parse-Application-Id": "${APPLICATION_ID}",
+connection.request('DELETE', '/parse/installations/mrmBZvsErB', '', {
+ "X-Parse-Application-Id": "${APPLICATION_ID}",
"X-Parse-Master-Key": "${MASTER_KEY}"
})
result = json.loads(connection.getresponse().read())
@@ -299,7 +299,7 @@ Subscribing to a channel via the REST API can be done by updating the `Installat
import json,httplib
-connection = httplib.HTTPSConnection('api.parse.com', 443)
+connection = httplib.HTTPSConnection('YOUR.PARSE-SERVER.HERE', 443)
connection.connect()
-connection.request('PUT', '/1/installations/mrmBZvsErB', json.dumps({
+connection.request('PUT', '/parse/installations/mrmBZvsErB', json.dumps({
"channels": [
"Giants"
]
}), {
- "X-Parse-Application-Id": "${APPLICATION_ID}",
+ "X-Parse-Application-Id": "${APPLICATION_ID}",
"X-Parse-REST-API-Key": "${REST_API_KEY}",
"Content-Type": "application/json"
})
@@ -338,7 +338,7 @@ With the REST API, the following code can be used to alert all subscribers of th
curl -X POST \
- -H "X-Parse-Application-Id: ${APPLICATION_ID}" \
+ -H "X-Parse-Application-Id: ${APPLICATION_ID}" \
-H "X-Parse-REST-API-Key: ${REST_API_KEY}" \
-H "Content-Type: application/json" \
-d '{
@@ -350,13 +350,13 @@ curl -X POST \
"alert": "The Giants won against the Mets 2-3."
}
}' \
- https://api.parse.com/1/push
+ https://YOUR.PARSE-SERVER.HERE/parse/push
import json,httplib
-connection = httplib.HTTPSConnection('api.parse.com', 443)
+connection = httplib.HTTPSConnection('YOUR.PARSE-SERVER.HERE', 443)
connection.connect()
-connection.request('POST', '/1/push', json.dumps({
+connection.request('POST', '/parse/push', json.dumps({
"channels": [
"Giants",
"Mets"
@@ -365,7 +365,7 @@ connection.request('POST', '/1/push', json.dumps({
"alert": "The Giants won against the Mets 2-3."
}
}), {
- "X-Parse-Application-Id": "${APPLICATION_ID}",
+ "X-Parse-Application-Id": "${APPLICATION_ID}",
"X-Parse-REST-API-Key": "${REST_API_KEY}",
"Content-Type": "application/json"
})
@@ -385,7 +385,7 @@ Storing arbitrary data on an `Installation` object is done in the same way we st
import json,httplib
-connection = httplib.HTTPSConnection('api.parse.com', 443)
+connection = httplib.HTTPSConnection('YOUR.PARSE-SERVER.HERE', 443)
connection.connect()
-connection.request('PUT', '/1/installations/mrmBZvsErB', json.dumps({
+connection.request('PUT', '/parse/installations/mrmBZvsErB', json.dumps({
"user": {
"__type": "Pointer",
"className": "_User",
"objectId": "vmRZXZ1Dvo"
}
}), {
- "X-Parse-Application-Id": "${APPLICATION_ID}",
+ "X-Parse-Application-Id": "${APPLICATION_ID}",
"X-Parse-REST-API-Key": "${REST_API_KEY}",
"Content-Type": "application/json"
})
@@ -453,7 +453,7 @@ Once you have your data stored on your `Installation` objects, you can use a que
curl -X POST \
- -H "X-Parse-Application-Id: ${APPLICATION_ID}" \
+ -H "X-Parse-Application-Id: ${APPLICATION_ID}" \
-H "X-Parse-REST-API-Key: ${REST_API_KEY}" \
-H "Content-Type: application/json" \
-d '{
@@ -464,13 +464,13 @@ curl -X POST \
"alert": "Willie Hayes injured by own pop fly."
}
}' \
- https://api.parse.com/1/push
+ https://YOUR.PARSE-SERVER.HERE/parse/push
import json,httplib
-connection = httplib.HTTPSConnection('api.parse.com', 443)
+connection = httplib.HTTPSConnection('YOUR.PARSE-SERVER.HERE', 443)
connection.connect()
-connection.request('POST', '/1/push', json.dumps({
+connection.request('POST', '/parse/push', json.dumps({
"where": {
"injuryReports": True
},
@@ -478,7 +478,7 @@ connection.request('POST', '/1/push', json.dumps({
"alert": "Willie Hayes injured by own pop fly."
}
}), {
- "X-Parse-Application-Id": "${APPLICATION_ID}",
+ "X-Parse-Application-Id": "${APPLICATION_ID}",
"X-Parse-REST-API-Key": "${REST_API_KEY}",
"Content-Type": "application/json"
})
@@ -490,7 +490,7 @@ We can even use channels with our query. To send a push to all subscribers of th
curl -X POST \
- -H "X-Parse-Application-Id: ${APPLICATION_ID}" \
+ -H "X-Parse-Application-Id: ${APPLICATION_ID}" \
-H "X-Parse-REST-API-Key: ${REST_API_KEY}" \
-H "Content-Type: application/json" \
-d '{
@@ -502,13 +502,13 @@ curl -X POST \
"alert": "The Giants scored a run! The score is now 2-2."
}
}' \
- https://api.parse.com/1/push
+ https://YOUR.PARSE-SERVER.HERE/parse/push
import json,httplib
-connection = httplib.HTTPSConnection('api.parse.com', 443)
+connection = httplib.HTTPSConnection('YOUR.PARSE-SERVER.HERE', 443)
connection.connect()
-connection.request('POST', '/1/push', json.dumps({
+connection.request('POST', '/parse/push', json.dumps({
"where": {
"channels": "Giants",
"scores": True
@@ -517,7 +517,7 @@ connection.request('POST', '/1/push', json.dumps({
"alert": "The Giants scored a run! The score is now 2-2."
}
}), {
- "X-Parse-Application-Id": "${APPLICATION_ID}",
+ "X-Parse-Application-Id": "${APPLICATION_ID}",
"X-Parse-REST-API-Key": "${REST_API_KEY}",
"Content-Type": "application/json"
})
@@ -529,7 +529,7 @@ If we store relationships to other objects in our `Installation` class, we can a
import json,httplib
-connection = httplib.HTTPSConnection('api.parse.com', 443)
+connection = httplib.HTTPSConnection('YOUR.PARSE-SERVER.HERE', 443)
connection.connect()
-connection.request('GET', '/1/classes/GameScore', '', {
- "X-Parse-Application-Id": "${APPLICATION_ID}",
+connection.request('GET', '/parse/classes/GameScore', '', {
+ "X-Parse-Application-Id": "${APPLICATION_ID}",
"X-Parse-REST-API-Key": "${REST_API_KEY}"
})
result = json.loads(connection.getresponse().read())
@@ -54,22 +54,22 @@ There are several ways to put constraints on the objects found, using the `where
import json,httplib,urllib
-connection = httplib.HTTPSConnection('api.parse.com', 443)
+connection = httplib.HTTPSConnection('YOUR.PARSE-SERVER.HERE', 443)
params = urllib.urlencode({"where":json.dumps({
"score": {
"$exists": False
}
})})
connection.connect()
-connection.request('GET', '/1/classes/GameScore?%s' % params, '', {
- "X-Parse-Application-Id": "${APPLICATION_ID}",
+connection.request('GET', '/parse/classes/GameScore?%s' % params, '', {
+ "X-Parse-Application-Id": "${APPLICATION_ID}",
"X-Parse-REST-API-Key": "${REST_API_KEY}"
})
result = json.loads(connection.getresponse().read())
@@ -251,15 +251,15 @@ If you have a class containing sports teams and you store a user's hometown in t
import json,httplib,urllib
-connection = httplib.HTTPSConnection('api.parse.com', 443)
+connection = httplib.HTTPSConnection('YOUR.PARSE-SERVER.HERE', 443)
params = urllib.urlencode({"order":"-createdAt","limit":10,"include":"post.author"})
connection.connect()
-connection.request('GET', '/1/classes/Comment?%s' % params, '', {
- "X-Parse-Application-Id": "${APPLICATION_ID}",
+connection.request('GET', '/parse/classes/Comment?%s' % params, '', {
+ "X-Parse-Application-Id": "${APPLICATION_ID}",
"X-Parse-REST-API-Key": "${REST_API_KEY}"
})
result = json.loads(connection.getresponse().read())
@@ -772,23 +772,23 @@ If you are limiting your query, or if there are a very large number of results,
For JavaScript usage, the Parse Cloud supports [cross-origin resource sharing](http://en.wikipedia.org/wiki/Cross-Origin_Resource_Sharing), so that you can use these headers in conjunction with XMLHttpRequest.
diff --git a/_includes/rest/roles.md b/_includes/rest/roles.md
index 0e7d813a9..852e9b422 100644
--- a/_includes/rest/roles.md
+++ b/_includes/rest/roles.md
@@ -20,7 +20,7 @@ To create a new role, send a POST request to the roles root:
import json,httplib
-connection = httplib.HTTPSConnection('api.parse.com', 443)
+connection = httplib.HTTPSConnection('YOUR.PARSE-SERVER.HERE', 443)
connection.connect()
-connection.request('POST', '/1/roles', json.dumps({
+connection.request('POST', '/parse/roles', json.dumps({
"name": "Moderators",
"ACL": {
"*": {
@@ -122,7 +122,7 @@ connection.request('POST', '/1/roles', json.dumps({
]
}
}), {
- "X-Parse-Application-Id": "${APPLICATION_ID}",
+ "X-Parse-Application-Id": "${APPLICATION_ID}",
"X-Parse-REST-API-Key": "${REST_API_KEY}",
"Content-Type": "application/json"
})
@@ -134,7 +134,7 @@ When the creation is successful, the HTTP response is a `201 Created` and the Lo
Status: 201 Created
-Location: https://api.parse.com/1/roles/mrmBZvsErB
+Location: https://YOUR.PARSE-SERVER.HERE/parse/roles/mrmBZvsErB
The response body is a JSON object containing the `objectId` and `createdAt` timestamp of the newly-created object:
@@ -152,16 +152,16 @@ You can also retrieve the contents of a role object by sending a GET request to
import json,httplib
-connection = httplib.HTTPSConnection('api.parse.com', 443)
+connection = httplib.HTTPSConnection('YOUR.PARSE-SERVER.HERE', 443)
connection.connect()
-connection.request('GET', '/1/roles/mrmBZvsErB', '', {
- "X-Parse-Application-Id": "${APPLICATION_ID}",
+connection.request('GET', '/parse/roles/mrmBZvsErB', '', {
+ "X-Parse-Application-Id": "${APPLICATION_ID}",
"X-Parse-REST-API-Key": "${REST_API_KEY}"
})
result = json.loads(connection.getresponse().read())
@@ -198,7 +198,7 @@ For example, we can add two users to the "Moderators" role created above like so
import json,httplib
-connection = httplib.HTTPSConnection('api.parse.com', 443)
+connection = httplib.HTTPSConnection('YOUR.PARSE-SERVER.HERE', 443)
connection.connect()
-connection.request('DELETE', '/1/roles/mrmBZvsErB', '', {
- "X-Parse-Application-Id": "${APPLICATION_ID}",
+connection.request('DELETE', '/parse/roles/mrmBZvsErB', '', {
+ "X-Parse-Application-Id": "${APPLICATION_ID}",
"X-Parse-Master-Key": "${MASTER_KEY}"
})
result = json.loads(connection.getresponse().read())
@@ -323,17 +323,17 @@ Again, we pass the master key in order to bypass the ACL on the role itself. Al
import json,httplib
-connection = httplib.HTTPSConnection('api.parse.com', 443)
+connection = httplib.HTTPSConnection('YOUR.PARSE-SERVER.HERE', 443)
connection.connect()
-connection.request('PUT', '/1/schemas/City', "", {
- "X-Parse-Application-Id": "${APPLICATION_ID}",
+connection.request('PUT', '/parse/schemas/City', "", {
+ "X-Parse-Application-Id": "${APPLICATION_ID}",
"X-Parse-Master-Key": "${MASTER_KEY}",
"Content-Type": "application/json"
})
diff --git a/_includes/rest/sessions.md b/_includes/rest/sessions.md
index ae09d6847..abd17c1b2 100644
--- a/_includes/rest/sessions.md
+++ b/_includes/rest/sessions.md
@@ -30,27 +30,27 @@ With revocable sessions, your current session token could become invalid if its
## Creating Sessions
-For mobile apps and websites, you should not create `Session` objects manually. Instead, you should call `GET /1/login` and `POST /1/users` (signup), which will automatically generate a `Session` object in the Parse Cloud. The session token for this automatically-created session will be sent back on the login and signup response. Same for Facebook/Twitter login and signup requests.
+For mobile apps and websites, you should not create `Session` objects manually. Instead, you should call GET /parse/login and POST /parse/users (signup), which will automatically generate a `Session` object in the Parse Cloud. The session token for this automatically-created session will be sent back on the login and signup response. Same for Facebook/Twitter login and signup requests.
In "Parse for IoT" apps (e.g. Arduino or Embedded C), you may want to programmatically create a restricted session that can be transferred to an IoT device. In order to do this, you must first log in normally to obtain an unrestricted session token. Then, you can create a restricted session by providing this unrestricted session token:
import json,httplib
-connection = httplib.HTTPSConnection('api.parse.com', 443)
+connection = httplib.HTTPSConnection('YOUR.PARSE-SERVER.HERE', 443)
connection.connect()
-connection.request('POST', '/1/sessions', json.dumps({
+connection.request('POST', '/parse/sessions', json.dumps({
"customField": "value"
}), {
- "X-Parse-Application-Id": "${APPLICATION_ID}",
+ "X-Parse-Application-Id": "${APPLICATION_ID}",
"X-Parse-REST-API-Key": "${REST_API_KEY}",
"X-Parse-Session-Token": "r:pnktnjyb996sj4p156gjtp4im",
"Content-Type": "application/json"
@@ -82,17 +82,17 @@ At this point, you can pass the session token `r:aVrtljyb7E8xKo9256gfvp4n2` to a
If you have the session's objectId, you fetch the `Session` object as long as it belongs to the same user as your current session: