POST

/v1/apis/{apiId}

http://appsync.{region}.amazonaws.com/v1/apis/{apiId}

Updates a <code>GraphqlApi</code> object.

Access Token Required: API Key

Path Parameters

apiIdstringrequired

The API ID.

Body Params

namestringrequired

The new name for the <code>GraphqlApi</code> object.

logConfigobject

The Amazon CloudWatch Logs configuration.

xrayEnabledboolean

A flag indicating whether to use X-Ray tracing for the <code>GraphqlApi</code>.

userPoolConfigobject

Describes an Amazon Cognito user pool configuration.

authenticationTypestring

The new authentication type for the <code>GraphqlApi</code> object.

openIDConnectConfigobject

Describes an OpenID Connect (OIDC) configuration.

lambdaAuthorizerConfigobject

A <code>LambdaAuthorizerConfig</code> specifies how to authorize AppSync API access when using the <code>AWS_LAMBDA</code> authorizer mode. Be aware that an AppSync API can have only one Lambda authorizer configured at a time.

additionalAuthenticationProvidersarray

A list of additional authentication providers for the <code>GraphqlApi</code> API.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://appsync.{region}.amazonaws.com/v1/apis/{apiId}' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}