Amplify-cli: How to update API key on project.

[amymc]

On setting up my dev project, an aws-exports.js file was generated which included the API key. Since then, the API key has expired and I have been prompted in the AppSync console to update the key.

How do I update the API key on my project now? For working locally I can just update the key in aws-exports.js but obviously as soon as I run amplify-push that gets overwritten with the old API key.

Thanks,
Amy

[rajababu3]

@amymc

Amplify.configure({
    ...awsmobile,
    aws_appsync_graphqlEndpoint:
        process.env.REACT_APP_aws_appsync_graphqlEndpoint,
    aws_appsync_region: process.env.REACT_APP_aws_appsync_region,
    aws_appsync_authenticationType:
        process.env.REACT_APP_aws_appsync_authenticationType,
})

You can try something like this.

[amymc]

Just to clarify I have tried running amplify update api as per the docs but that command doesn't seem to exist. When I run it I just get a list of suggested commands.

[kaustavghosh06]

@amymc Which CLI version are you using? amplify api update or amplify update api does exist.

[amymc]

Hi @kaustavghosh06,

Running amplify --v returns0.1.18

When I run amplify update api or amplify api update I get the following:

[amymc]

Upgrading my version of amplify-cli with yarn global upgrade @aws-amplify/cli solved my problem.

Thanks!

[cj-l]

I'm facing the same issue. I can put the new API key in my local file but when I deploy with the AWS Amplify Console how does it know the new key to use?

[karldanninger]

I have the same issue. I've updated aws-exports yet when I run amplify push it shows that it fails and I see the old key in the stacktrace

[javierjavier]

Changing the APIKeyExpirationEpoch worked for me. See https://github.com/aws-amplify/amplify-cli/issues/808.

[shamal]

In Android project, I still have the same issue. I have updated awsconfiguration.json with new api key. amplify status also shows the new api key. but when I do amplify push it fails telling API key not found: <old api key> (Service: AWSAppSync; Status Code: 404; Error Code: NotFoundException; Request ID: 2fe05136-b0e5-11e9-a0fc-59240c6936f3)

[kaustavghosh06]

@shamal As mentioned in the above comments, setting the APIKeyExpirationEpoch key in your amplify/backend/api/<api-name>/parameters.json file would renew the API Key. Changing the APIKey just in your awsconfiguration.json, wouldn't make the amplify push succeed. Please take a look at #808 for more details. You can find documentation reference out here - https://aws-amplify.github.io/docs/cli-toolchain/graphql#apikeyexpirationepoch

[vientang]

Just had to do this and setting the APIKeyExpirationEpoch worked. Here are the steps I took.

1. In amplify/backend/api/<api-name>/parameters.json, APIKeyExpirationEpoch wasn't there so I've added APIKeyExpirationEpoch and set it to "-1".
2. Run amplify push. This removes the API key from the template in the cloud (I think). At this point, my local files still showed the old API key.
3. In amplify/backend/api/<api-name>/parameters.json, I've removed the APIKeyExpirationEpoch field but you could also set an expiration date, defined by seconds.
4. Run amplify push again. This time, all of the files that lists the API key is now updated.
5. My API key was manually set in my .env files so I had to manually update that as well.

Hope this helps.

[berenddeboer]

People coming here via Google search, note that APIKeyExpirationEpoch is apparently now deprecated. When you set it and push you get: APIKeyExpirationEpoch parameter's -1 value is deprecated to disable the API Key creation. In the future CreateAPIKey parameter replaces this behavior.

[loganpowell]

Is this the latest/greatest guidance?

https://docs.amplify.aws/cli/graphql-transformer/config-params#createapikey

[karldanninger]

Hey @berenddeboer where did you read that? could you link the source? Thanks in advance