REST Resource: projects.locations.apis

Stay organized with collections Save and categorize content based on your preferences.

Resource: Api

A top-level description of an API. Produced by producers and are commitments to provide services.

JSON representation
{
  "name": string,
  "displayName": string,
  "description": string,
  "createTime": string,
  "updateTime": string,
  "availability": string,
  "recommendedVersion": string,
  "recommendedDeployment": string,
  "labels": {
    string: string,
    ...
  },
  "annotations": {
    string: string,
    ...
  }
}
Fields
name

string

Resource name.

displayName

string

Human-meaningful name.

description

string

A detailed description.

createTime

string (Timestamp format)

Output only. Creation timestamp.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

updateTime

string (Timestamp format)

Output only. Last update timestamp.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

availability

string

A user-definable description of the availability of this service. Format: free-form, but we expect single words that describe availability, e.g., "NONE", "TESTING", "PREVIEW", "GENERAL", "DEPRECATED", "SHUTDOWN".

recommendedVersion

string

The recommended version of the API. Format: apis/{api}/versions/{version}

recommendedDeployment

string

The recommended deployment of the API. Format: apis/{api}/deployments/{deployment}

labels

map (key: string, value: string)

Labels attach identifying metadata to resources. Identifying metadata can be used to filter list operations.

Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. No more than 64 user labels can be associated with one resource (System labels are excluded).

See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with apigeeregistry.googleapis.com/ and cannot be changed.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

annotations

map (key: string, value: string)

Annotations attach non-identifying metadata to resources.

Annotation keys and values are less restricted than those of labels, but should be generally used for small values of broad interest. Larger, topic- specific metadata should be stored in Artifacts.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Methods

create

Creates a specified API.

delete

Removes a specified API and all of the resources that it owns.

get

Returns a specified API.

getIamPolicy

Gets the access control policy for a resource.

list

Returns matching APIs.

patch

Used to modify a specified API.

setIamPolicy

Sets the access control policy on the specified resource.

testIamPermissions

Returns permissions that a caller has on the specified resource.