Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Updated some styling and added error codes to http apps section

  • Loading branch information...
commit 7e7fdf25cf4ebd08d76199a0bad473fa81620597 1 parent a51dcfd
@krobertson krobertson authored
View
12 _posts/http-apps/0001-01-01-delete-apps-name.md
@@ -8,7 +8,7 @@ Deletes a provisioned service on the target cloud.
### Resource URL
-`DELETE /apps/{name}`
+ DELETE /apps/{name}
### Parameters
@@ -18,12 +18,18 @@ Deletes a provisioned service on the target cloud.
[Yes](/http-authentication)
+### Response Codes
+
+* HTTP 200 - Success
+* HTTP 403, error code 200 - Operation forbidden, usually authentication failed
+* HTTP 404, error code 301 - Application not found
+
### Example Request
**Request**
-`DELETE http://api.vcap.me/apps/apidocs`
+ DELETE http://api.vcap.me/apps/apidocs
**Response**
-None
+ 200 OK
View
12 _posts/http-apps/0001-01-01-get-apps-name-crashes.md
@@ -8,7 +8,7 @@ Returns information about application crashes on the target cloud.
### Resource URL
-`GET /apps/{name}/crashes`
+ GET /apps/{name}/crashes
### Parameters
@@ -18,14 +18,22 @@ Returns information about application crashes on the target cloud.
[Yes](/http-authentication)
+### Response Codes
+
+* HTTP 200 - Success
+* HTTP 403, error code 200 - Operation forbidden, usually authentication failed
+* HTTP 404, error code 301 - Application not found
+
### Example Request
**Request**
-`GET http://api.vcap.me/apps/apidocs/crashes`
+ GET http://api.vcap.me/apps/apidocs/crashes
**Response**
+ 200 OK
+
<div class="js example">
{% highlight js %}
{% include snippets/http-api-get-apps-name-crashes-response.json %}
View
12 _posts/http-apps/0001-01-01-get-apps-name-instances.md
@@ -8,7 +8,7 @@ Returns information about application instances on the target cloud.
### Resource URL
-`GET /apps/{name}/instances`
+ GET /apps/{name}/instances
### Parameters
@@ -18,14 +18,22 @@ Returns information about application instances on the target cloud.
[Yes](/http-authentication)
+### Response Codes
+
+* HTTP 200 - Success
+* HTTP 403, error code 200 - Operation forbidden, usually authentication failed
+* HTTP 404, error code 301 - Application not found
+
### Example Request
**Request**
-`GET http://api.vcap.me/apps/apidocs/instances`
+ GET http://api.vcap.me/apps/apidocs/instances
**Response**
+ 200 OK
+
<div class="js example">
{% highlight js %}
{% include snippets/http-api-get-apps-name-instances-response.json %}
View
12 _posts/http-apps/0001-01-01-get-apps-name-stats.md
@@ -8,7 +8,7 @@ Returns information about application statistics on the target cloud.
### Resource URL
-`GET /apps/{name}/stats`
+ GET /apps/{name}/stats
### Parameters
@@ -18,14 +18,22 @@ Returns information about application statistics on the target cloud.
[Yes](/http-authentication)
+### Response Codes
+
+* HTTP 200 - Success
+* HTTP 403, error code 200 - Operation forbidden, usually authentication failed
+* HTTP 404, error code 301 - Application not found
+
### Example Request
**Request**
-`GET http://api.vcap.me/apps/apidocs/stats`
+ GET http://api.vcap.me/apps/apidocs/stats
**Response**
+ 200 OK
+
<div class="js example">
{% highlight js %}
{% include snippets/http-api-get-apps-name-stats-response.json %}
View
12 _posts/http-apps/0001-01-01-get-apps-name.md
@@ -8,7 +8,7 @@ Returns basic information about an application deployed on the target cloud.
### Resource URL
-`GET /apps/{name}`
+ GET /apps/{name}
### Parameters
@@ -18,14 +18,22 @@ Returns basic information about an application deployed on the target cloud.
[Yes](/http-authentication)
+### Response Codes
+
+* HTTP 200 - Success
+* HTTP 403, error code 200 - Operation forbidden, usually authentication failed
+* HTTP 404, error code 301 - Application not found
+
### Example Request
**Request**
-`GET http://api.vcap.me/apps/apidocs`
+ GET http://api.vcap.me/apps/apidocs
**Response**
+ 200 OK
+
<div class="js example">
{% highlight js %}
{% include snippets/http-api-get-apps-name-response.json %}
View
12 _posts/http-apps/0001-01-01-get-apps.md
@@ -8,7 +8,7 @@ Returns the list of applications deployed on the target cloud.
### Resource URL
-`GET /apps`
+ GET /apps
### Parameters
@@ -18,14 +18,22 @@ None
[Yes](/http-authentication)
+### Response Codes
+
+* HTTP 200 - Success
+* HTTP 403, error code 200 - Operation forbidden, usually authentication failed
+* HTTP 404, error code 301 - Application not found
+
### Example Request
**Request**
-`GET http://api.vcap.me/apps`
+ GET http://api.vcap.me/apps
**Response**
+ 200 OK
+
<div class="js example">
{% highlight js %}
{% include snippets/http-api-get-apps-response.json %}
View
18 _posts/http-apps/0001-01-01-put-apps-name.md
@@ -8,7 +8,7 @@ Updates an application at target cloud.
### Resource URL
-`PUT /apps/{name}`
+ PUT /apps/{name}
### Parameters
@@ -27,11 +27,17 @@ Updates an application at target cloud.
[Yes](/http-authentication)
+### Response Codes
+
+* HTTP 200 - Success, changes are applied
+* HTTP 400, error code 309 - Application debugging not allowed
+* HTTP 400, error code 300 - Part of the application configuration is invalid
+
### Example Request
**Request**
-`PUT http://api.vcap.me/apps/apidocs`
+ PUT http://api.vcap.me/apps/apidocs
<div class="js example">
{% highlight js %}
@@ -41,4 +47,10 @@ Updates an application at target cloud.
**Response**
-None
+ 200 OK
+
+<div class="js example">
+{% highlight js %}
+{% include snippets/http-api-put-apps-name-response.json %}
+{% endhighlight %}
+</div>
Please sign in to comment.
Something went wrong with that request. Please try again.