How do I get the Invoke URL for an API Gateway Rest API Stage?

[mfulton26]

In the AWS Console I can navigate to an Amazon API Gateway and then select its Stages. When view Stages I am presented with an Invoke URL. e.g. https://{{restApiId}}.execute-api.us-east-1.amazonaws.com/{{stageName}}

Is there a way to programmatically get this URL using aws-sdk-js-v3? If the Invoke URL is always in the format of https://{{restApiId}}.execute-api.us-east-1.amazonaws.com/{{stageName}} then I can compute that myself by using GetRestApisCommand and GetStagesCommand but I was hesitant to do so if the URL can be in other formats.

If there isn't a way to do this then such might be a nice addition to aws-sdk-js-v3 to remove guess work, etc.

[alhimik45]

Have you found a solution?

[mfulton26]

I have not.

[RanVaknin]

Hi @mfulton26 ,

If you didn't know, all the AWS SDKs are code-generated from the API model of the various AWS Services. In this case, the APIGATEWAY API Model does not expose a method that returns the invoke URL so the SDK will not have any way of supporting this. In other words, this is a feature that only exists on console as a courtesy.

You can construct the API Gateway endpoint yourself if you know the id and the stage name:
https://{{restApiId}}.execute-api.{{region}}.amazonaws.com/{{stageName}}

Thanks,
Ran~

[mfulton26]

That's great. I'm typically a little hesitant to construct URLs without since clear documentation that the URL will always be correct. I take it that you are confirming that this will always be the URL structure. Thank you.

[RanVaknin]

Hi @mfulton26,

I take it that you are confirming that this will always be the URL structure.

We on the SDK team can only make recommendations about service related behavior, but cannot guarantee it. According to the API Gateway documentation this should be the correct format. The best way of course would be to dynamically obtain it, but unfortunately this is not an option.
Unless the API gateway service team is going to change the endpoint scheme which is unlikely, it should be safe to manually construct the URL.

Thanks,
Ran~

[github-actions[bot]]

Hello! Reopening this discussion to make it searchable.