Was this helpful?

 

Base Path: https://api.enterprise.apigee.com/v1/o/{org_name}

API Resource Path:

/apiproducts/{apiproduct_name}

Description: Gets an API Product

Verb: GET
Auth: Basic Auth
Media types:
application/json
text/xml

Overview: Gets the profile for an API Product by name.

Sample Request:
$ curl -X GET -H "Accept:application/json" \
https://api.enterprise.apigee.com/v1/o/(org_name)/apiproducts/{apiproduct_name} \
-u myname:mypass
Sample Response:
{
  "apiResources" : [ /weather ],
  "approvalType" : "auto",
  "attributes" : [ ],
  "createdAt" : 1367938427800,
  "createdBy" : "andrew@apigee.com",
  "description" : "",
  "displayName" : "Free API Product",
  "environments" : [ "test" ],
  "lastModifiedAt" : 1367938427800,
  "lastModifiedBy" : "andrew@apigee.com",
  "name" : "weather_free",
  "proxies" : [ "weatherapi" ],
  "scopes" : [ ]
}
Response Payload Elements:
Name Description
apiResources A list of URIs (including wildcards) that represent the bundle of APIs permitted to consumers of this API Product
approvalType Determines the state of the consumer key generated for requesters of this API Product. For Auto, key are generated in "Approved' state. For Manual, keys are approved in 'Pending' state.
attributes Any app-specific arbitrary attributes that may be used to define visibility of the API Product or runtime policy enforcement (such as setting for a rate-limiting policy.
createdAt Unix time when the API Product was created
createdBy Apigee user account name of the individual who submitted the POST request that created this entity
description Human-readable description of the API Product
displayName Friendly name to display to Developers, for example, in a Developer Onboarding app
lastModifiedAt Unix time when the API Product was most recently updated
lastModifiedBy Apigee user account name of the individual who last modified the API Product
name The name of the API Product
scopes Oauth scopes required in the Access Token(s) used to consume any of the API resources (URIs) bundled in this API Product
proxies Every API product is bound to one or more API proxies by name
environments Every API product is bound to at least one environment
Errors
{
   "Error":{
      "Code":"keymanagement.service.apiproduct_invalid_name",
      "Message":"ApiProduct Name is invalid",
      "Contexts":""
   }
}

 

Add new comment

Provide your email address if you wish to be contacted offline about your comment.
We will not display your email address as part of your comment.

We'd love your feedback and perspective! Please be as specific as possible.
Type the characters you see in this picture. (verify using audio)

Type the characters you see in the picture above; if you can't read them, submit the form and a new image will be generated. Not case sensitive.