Console
    Start free

    MCP Tools Reference: apihub.googleapis.com

    Tool: get_api

    Get API resource details.

    The following sample demonstrate how to use curl to invoke the get_api MCP tool.

    Curl Request 
      
curl  
--location  
 'https://apihub. REGION 
.rep.googleapis.com/mcp' 
  
 \ 
--header  
 'content-type: application/json' 
  
 \ 
--header  
 'accept: application/json, text/event-stream' 
  
 \ 
--data  
 '{ 
 "method": "tools/call", 
 "params": { 
 "name": "get_api", 
 "arguments": { 
 // provide these details according to the tool' 
s  
MCP  
specification  
 } 
  
 } 
,  
 "jsonrpc" 
:  
 "2.0" 
,  
 "id" 
:  
 1 
 } 
 '

    Where, REGION is the supported API hub region. For more information, see Supported regions .

    Input Schema

    The GetApi method's request.

    GetApiRequest

    JSON representation 
     { 
 "name" 
 : 
 string 
 }
    Fields
    name

    string

    Required. The name of the API resource to retrieve. Format: projects/{project}/locations/{location}/apis/{api}

    Output Schema

    An API resource in the API Hub.

    Api

    JSON representation 
     { 
 "name" 
 : 
 string 
 , 
 "displayName" 
 : 
 string 
 , 
 "description" 
 : 
 string 
 , 
 "documentation" 
 : 
 { 
 object (  Documentation 
 
) 
 } 
 , 
 "owner" 
 : 
 { 
 object (  Owner 
 
) 
 } 
 , 
 "versions" 
 : 
 [ 
 string 
 ] 
 , 
 "createTime" 
 : 
 string 
 , 
 "updateTime" 
 : 
 string 
 , 
 "targetUser" 
 : 
 { 
 object (  AttributeValues 
 
) 
 } 
 , 
 "team" 
 : 
 { 
 object (  AttributeValues 
 
) 
 } 
 , 
 "businessUnit" 
 : 
 { 
 object (  AttributeValues 
 
) 
 } 
 , 
 "maturityLevel" 
 : 
 { 
 object (  AttributeValues 
 
) 
 } 
 , 
 "attributes" 
 : 
 { 
 string 
 : 
 { 
 object (  AttributeValues 
 
) 
 } 
 , 
 ... 
 } 
 , 
 "apiStyle" 
 : 
 { 
 object (  AttributeValues 
 
) 
 } 
 , 
 "selectedVersion" 
 : 
 string 
 , 
 "apiRequirements" 
 : 
 { 
 object (  AttributeValues 
 
) 
 } 
 , 
 "fingerprint" 
 : 
 string 
 , 
 "sourceMetadata" 
 : 
 [ 
 { 
 object (  SourceMetadata 
 
) 
 } 
 ] 
 , 
 "apiFunctionalRequirements" 
 : 
 { 
 object (  AttributeValues 
 
) 
 } 
 , 
 "apiTechnicalRequirements" 
 : 
 { 
 object (  AttributeValues 
 
) 
 } 
 }
    Fields
    name

    string

    Identifier. The name of the API resource in the API Hub.

    Format: projects/{project}/locations/{location}/apis/{api}

    displayName

    string

    Required. The display name of the API resource.
    description

    string

    Optional. The description of the API resource.
    documentation

    object ( Documentation )

    Optional. The documentation for the API resource.
    owner

    object ( Owner )

    Optional. Owner details for the API resource.
    versions[]

    string

    Output only. The list of versions present in an API resource. Note: An API resource can be associated with more than 1 version. Format is projects/{project}/locations/{location}/apis/{api}/versions/{version}

    createTime

    string ( Timestamp format)

    Output only. The time at which the API resource was created.

    Uses RFC 3339, where generated output will always be Z-normalized and use 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. The time at which the API resource was last updated.

    Uses RFC 3339, where generated output will always be Z-normalized and use 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" .
    targetUser

    object ( AttributeValues )

    Optional. The target users for the API. This maps to the following system defined attribute: projects/{project}/locations/{location}/attributes/system-target-user attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
    team

    object ( AttributeValues )

    Optional. The team owning the API. This maps to the following system defined attribute: projects/{project}/locations/{location}/attributes/system-team attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
    businessUnit

    object ( AttributeValues )

    Optional. The business unit owning the API. This maps to the following system defined attribute: projects/{project}/locations/{location}/attributes/system-business-unit attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
    maturityLevel

    object ( AttributeValues )

    Optional. The maturity level of the API. This maps to the following system defined attribute: projects/{project}/locations/{location}/attributes/system-maturity-level attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
    attributes

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

    Optional. The list of user defined attributes associated with the API 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" } .
    apiStyle

    object ( AttributeValues )

    Optional. The style of the API. This maps to the following system defined attribute: projects/{project}/locations/{location}/attributes/system-api-style attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
    selectedVersion

    string

    Optional. The selected version for an API resource. This can be used when special handling is needed on client side for particular version of the API. Format is projects/{project}/locations/{location}/apis/{api}/versions/{version}

    apiRequirements

    object ( AttributeValues )

    Optional. The api requirement doc associated with the API resource. Carinality is 1 for this attribute. This maps to the following system defined attribute: projects/{project}/locations/{location}/attributes/system-api-requirements attribute. The value of the attribute should be a proper URI, and in case of Cloud Storage URI, it should point to a Cloud Storage object, not a directory.
    fingerprint

    string

    Optional. Fingerprint of the API resource. This must be unique for each API resource. It can neither be unset nor be updated to an existing fingerprint of another API resource.
    sourceMetadata[]

    object ( SourceMetadata )

    Output only. The list of sources and metadata from the sources of the API resource.
    apiFunctionalRequirements

    object ( AttributeValues )

    Optional. The api functional requirements associated with the API resource. Carinality is 1 for this attribute. This maps to the following system defined attribute: projects/{project}/locations/{location}/attributes/system-api-functional-requirements attribute. The value of the attribute should be a proper URI, and in case of Cloud Storage URI, it should point to a Cloud Storage object, not a directory.
    apiTechnicalRequirements

    object ( AttributeValues )

    Optional. The api technical requirements associated with the API resource. Carinality is 1 for this attribute. This maps to the following system defined attribute: projects/{project}/locations/{location}/attributes/system-api-technical-requirements attribute. The value of the attribute should be a proper URI, and in case of Cloud Storage URI, it should point to a Cloud Storage object, not a directory.

    Documentation

    JSON representation 
     { 
 "externalUri" 
 : 
 string 
 }
    Fields
    externalUri

    string

    Optional. The uri of the externally hosted documentation.

    Owner

    JSON representation 
     { 
 "displayName" 
 : 
 string 
 , 
 "email" 
 : 
 string 
 }
    Fields
    displayName

    string

    Optional. The name of the owner.
    email

    string

    Required. The email of the owner.

    Timestamp

    JSON representation 
     { 
 "seconds" 
 : 
 string 
 , 
 "nanos" 
 : 
 integer 
 }
    Fields
    seconds

    string ( int64 format)

    Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be between -62135596800 and 253402300799 inclusive (which corresponds to 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z).
    nanos

    integer

    Non-negative fractions of a second at nanosecond resolution. This field is the nanosecond portion of the duration, not an alternative to seconds. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be between 0 and 999,999,999 inclusive.

    AttributeValues

    JSON representation 
     { 
 "attribute" 
 : 
 string 
 , 
 // Union field Value 
can be only one of the following: 
 "enumValues" 
 : 
 { 
 object (  EnumAttributeValues 
 
) 
 } 
 , 
 "stringValues" 
 : 
 { 
 object (  StringAttributeValues 
 
) 
 } 
 , 
 "jsonValues" 
 : 
 { 
 object (  StringAttributeValues 
 
) 
 } 
 , 
 "uriValues" 
 : 
 { 
 object (  StringAttributeValues 
 
) 
 } 
 // End of list of possible types for union field Value 
. 
 }
    Fields
    attribute

    string

    Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}

    Union field Value . The attribute values associated with the resource. Value can be only one of the following:
    enumValues

    object ( EnumAttributeValues )

    The attribute values associated with a resource in case attribute data type is enum.

    stringValues

    object ( StringAttributeValues )

    The attribute values associated with a resource in case attribute data type is string.

    jsonValues

    object ( StringAttributeValues )

    The attribute values associated with a resource in case attribute data type is JSON.

    uriValues

    object ( StringAttributeValues )

    The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.

    EnumAttributeValues

    JSON representation 
     { 
 "values" 
 : 
 [ 
 { 
 object (  AllowedValue 
 
) 
 } 
 ] 
 }
    Fields
    values[]

    object ( AllowedValue )

    Required. The attribute values in case attribute data type is enum.

    AllowedValue

    JSON representation 
     { 
 "id" 
 : 
 string 
 , 
 "displayName" 
 : 
 string 
 , 
 "description" 
 : 
 string 
 , 
 "immutable" 
 : 
 boolean 
 }
    Fields
    id

    string

    Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates.

    This value should be 4-63 characters, and valid characters are /[a-z][0-9]-/.
    displayName

    string

    Required. The display name of the allowed value.
    description

    string

    Optional. The detailed description of the allowed value.
    immutable

    boolean

    Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.

    StringAttributeValues

    JSON representation 
     { 
 "values" 
 : 
 [ 
 string 
 ] 
 }
    Fields
    values[]

    string

    Required. The attribute values in case attribute data type is string or JSON.

    AttributesEntry

    JSON representation 
     { 
 "key" 
 : 
 string 
 , 
 "value" 
 : 
 { 
 object (  AttributeValues 
 
) 
 } 
 }
    Fields
    key

    string

    value

    object ( AttributeValues )

    SourceMetadata

    JSON representation 
     { 
 "sourceType" 
 : 
 enum ( SourceType 
) 
 , 
 "originalResourceId" 
 : 
 string 
 , 
 "originalResourceCreateTime" 
 : 
 string 
 , 
 "originalResourceUpdateTime" 
 : 
 string 
 , 
 // Union field source 
can be only one of the following: 
 "pluginInstanceActionSource" 
 : 
 { 
 object (  PluginInstanceActionSource 
 
) 
 } 
 // End of list of possible types for union field source 
. 
 }
    Fields
    sourceType

    enum ( SourceType )

    Output only. The type of the source.

    originalResourceId

    string

    Output only. The unique identifier of the resource at the source.

    originalResourceCreateTime

    string ( Timestamp format)

    Output only. The time at which the resource was created at the source.

    Uses RFC 3339, where generated output will always be Z-normalized and use 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" .

    originalResourceUpdateTime

    string ( Timestamp format)

    Output only. The time at which the resource was last updated at the source.

    Uses RFC 3339, where generated output will always be Z-normalized and use 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" .

    Union field source . The source of the resource. source can be only one of the following:
    pluginInstanceActionSource

    object ( PluginInstanceActionSource )

    Output only. The source of the resource is a plugin instance action.

    PluginInstanceActionSource

    JSON representation 
     { 
 "pluginInstance" 
 : 
 string 
 , 
 "actionId" 
 : 
 string 
 }
    Fields
    pluginInstance

    string

    Output only. The resource name of the source plugin instance. Format is projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}

    actionId

    string

    Output only. The id of the plugin instance action.

    Tool Annotations

    Destructive Hint: ❌ | Idempotent Hint: ✅ | Read Only Hint: ✅ | Open World Hint: ❌
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: