GetGraphqlApi - AWS AppSync


Retrieves a GraphqlApi object.

Request Syntax

GET /apis/apiId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.


The API ID for the GraphQL API.

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "graphqlApi": { "additionalAuthenticationProviders": [ { "authenticationType": "string", "lambdaAuthorizerConfig": { "authorizerResultTtlInSeconds": number, "authorizerUri": "string", "identityValidationExpression": "string" }, "openIDConnectConfig": { "authTTL": number, "clientId": "string", "iatTTL": number, "issuer": "string" }, "userPoolConfig": { "appIdClientRegex": "string", "awsRegion": "string", "userPoolId": "string" } } ], "apiId": "string", "apiType": "string", "arn": "string", "authenticationType": "string", "dns": { "string" : "string" }, "enhancedMetricsConfig": { "dataSourceLevelMetricsBehavior": "string", "operationLevelMetricsConfig": "string", "resolverLevelMetricsBehavior": "string" }, "introspectionConfig": "string", "lambdaAuthorizerConfig": { "authorizerResultTtlInSeconds": number, "authorizerUri": "string", "identityValidationExpression": "string" }, "logConfig": { "cloudWatchLogsRoleArn": "string", "excludeVerboseContent": boolean, "fieldLogLevel": "string" }, "mergedApiExecutionRoleArn": "string", "name": "string", "openIDConnectConfig": { "authTTL": number, "clientId": "string", "iatTTL": number, "issuer": "string" }, "owner": "string", "ownerContact": "string", "queryDepthLimit": number, "resolverCountLimit": number, "tags": { "string" : "string" }, "uris": { "string" : "string" }, "userPoolConfig": { "appIdClientRegex": "string", "awsRegion": "string", "defaultAction": "string", "userPoolId": "string" }, "visibility": "string", "wafWebAclArn": "string", "xrayEnabled": boolean } }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.


The GraphqlApi object.

Type: GraphqlApi object


For information about the errors that are common to all actions, see Common Errors.


You don't have access to perform this operation on this resource.

HTTP Status Code: 403


The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.

HTTP Status Code: 400


An internal AWS AppSync error occurred. Try your request again.

HTTP Status Code: 500


The resource specified in the request was not found. Check the resource, and then try again.

HTTP Status Code: 404


You aren't authorized to perform this operation.

HTTP Status Code: 401

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: