Admin API operations map directly to REST HTTP verbs, which means that you use standard HTTP methods to retrieve and manipulate your resources.
The specific formats for Admin API URIs are:
https://appengine.googleapis.com/v1/resourcePath?parameters
For example, to list all of the details about the my-v1 version in the my-
frontend service of the application in the my-app project, you can send the
HTTP request with the ?view=FULL parameter:
GET https://appengine.googleapis.com/v1/apps/my-app/services/my-frontend/versions/my-v1?view=FULL
See the App Engine Admin API Reference document for the full set of URIs used for each supported operation in the API.
Learn the basics
New to REST APIs? Here are a few resources to help you get started.
REST basics
There are two ways to invoke the API:
- Sending HTTP requests and parsing the responses.
- Using client libraries.
If you decide not to use client libraries, you'll need to understand the basics of REST.
REST is a style of software architecture that provides a convenient and consistent approach to requesting and modifying data.
The term REST is short for "Representational State Transfer." In the context of Google APIs, it refers to using HTTP verbs to retrieve and modify representations of data stored by Google.
In a RESTful system, resources are stored in a data store; a client sends a request that the server perform a particular action (such as creating, retrieving, updating, or deleting a resource), and the server performs the action and sends a response, often in the form of a representation of the specified resource.
In Google's RESTful APIs, the client specifies an action using an HTTP verb such as POST, GET, PUT, or DELETE. It specifies a resource by a globally-unique URI of the following form:
https://www.googleapis.com/apiName/apiVersion/resourcePath?parameters
Because all API resources have unique HTTP-accessible URIs, REST enables data caching and is optimized to work with the web's distributed infrastructure.
You may find the method definitions in the HTTP 1.1 standards documentation useful; they include specifications for GET, POST, PUT, and DELETE.
JSON basics
The Admin API returns data in JSON format.
JSON (JavaScript Object Notation) is a common, language-independent data format that provides a simple text representation of arbitrary data structures. For more information, see json.org.