Console
    Contact Us Start free

    REST Resource: projects.locations.externalApis

    Resource: ExternalApi

    An external API represents an API being provided by external sources. This can be used to model third-party APIs and can be used to define dependencies.

    JSON representation 
     { 
 "name" 
 : 
 string 
 , 
 "displayName" 
 : 
 string 
 , 
 "description" 
 : 
 string 
 , 
 "endpoints" 
 : 
 [ 
 string 
 ] 
 , 
 "paths" 
 : 
 [ 
 string 
 ] 
 , 
 "documentation" 
 : 
 { 
 object (  Documentation 
 
) 
 } 
 , 
 "attributes" 
 : 
 { 
 string 
 : 
 { 
 object (  AttributeValues 
 
) 
 } 
 , 
 ... 
 } 
 , 
 "createTime" 
 : 
 string 
 , 
 "updateTime" 
 : 
 string 
 }
    Fields
    name

    string

    Identifier. Format: projects/{project}/locations/{location}/externalApi/{externalApi} .
    displayName

    string

    Required. Display name of the external API. Max length is 63 characters (Unicode Code Points).
    description

    string

    Optional. Description of the external API. Max length is 2000 characters (Unicode Code Points).
    endpoints[]

    string

    Optional. List of endpoints on which this API is accessible.
    paths[]

    string

    Optional. List of paths served by this API.
    documentation

    object ( Documentation )

    Optional. Documentation of the external API.
    attributes

    map (key: string, value: object ( AttributeValues ))

    Optional. The list of user defined attributes associated with the Version resource. The key is the attribute name. It will be of the format: projects/{project}/locations/{location}/attributes/{attribute} . The value is the attribute values associated with the resource.

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

    string ( Timestamp format)

    Output only. Creation timestamp.

    Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30" .
    updateTime

    string ( Timestamp format)

    Output only. Last update timestamp.

    Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30" .

    Methods

    create

    		Create an External API resource in the API hub.

    delete

    		Delete an External API resource in the API hub.

    get

    		Get details about an External API resource in the API hub.

    list

    		List External API resources in the API hub.

    patch

    		Update an External API resource in the API hub.
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: