Console
    Contact Us Start free

    REST Resource: projects.locations.apis

    Resource: Api

    An API that can be served by one or more Gateways.

    JSON representation 
     { 
 "name" 
 : 
 string 
 , 
 "createTime" 
 : 
 string 
 , 
 "updateTime" 
 : 
 string 
 , 
 "labels" 
 : 
 { 
 string 
 : 
 string 
 , 
 ... 
 } 
 , 
 "displayName" 
 : 
 string 
 , 
 "managedService" 
 : 
 string 
 , 
 "state" 
 : 
 enum (  State 
 
) 
 }
    Fields
    name

    string

    Output only. Resource name of the API. Format: projects/{project}/locations/global/apis/{api}
    createTime

    string ( Timestamp format)

    Output only. Created time.

    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. Updated time.

    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" .
    labels

    map (key: string, value: string)

    Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources

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

    string

    Optional. Display name.
    managedService

    string

    Optional. Immutable. The name of a Google Managed Service ( https://cloud.google.com/service-infrastructure/docs/glossary#managed) . If not specified, a new Service will automatically be created in the same project as this API.
    state

    enum ( State )

    Output only. State of the API.

    State

    All the possible API states.

    Enums
    STATE_UNSPECIFIED API does not have a state yet.
    CREATING API is being created.
    ACTIVE API is active.
    FAILED API creation failed.
    DELETING API is being deleted.
    UPDATING API is being updated.

    Methods

    create

    		Creates a new Api in a given project and location.

    delete

    		Deletes a single Api.

    get

    		Gets details of a single Api.

    getIamPolicy

    		Gets the access control policy for a resource.

    list

    		Lists Apis in a given project and location.

    patch

    		Updates the parameters of a single Api.

    setIamPolicy

    		Sets the access control policy on the specified resource.

    testIamPermissions

    		Returns permissions that a caller has on the specified resource.
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: