AmazonApiGatewayV2
Amazon API Gateway V2
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Amazon API Gateway V2
Endpoints 103
- GETGet apis
/v2/apis?maxResults=string&nextToken=stringGets a collection of Api resources. - PUTImport api
/v2/apis?basepath=string&failOnWarnings=trueImports an API. - POSTCreate api
/v2/apisCreates an Api resource. - GETGet api mappings
/v2/domainnames/:DomainName/apimappings?maxResults=string&nextToken=stringGets API mappings. - POSTCreate api mapping
/v2/domainnames/:DomainName/apimappingsCreates an API mapping. - GETGet authorizers
/v2/apis/:ApiId/authorizers?maxResults=string&nextToken=stringGets the Authorizers for an API. - POSTCreate authorizer
/v2/apis/:ApiId/authorizersCreates an Authorizer for an API. - GETGet deployments
/v2/apis/:ApiId/deployments?maxResults=string&nextToken=stringGets the Deployments for an API. - POSTCreate deployment
/v2/apis/:ApiId/deploymentsCreates a Deployment for an API. - GETGet domain names
/v2/domainnames?maxResults=string&nextToken=stringGets the domain names for an AWS account. - POSTCreate domain name
/v2/domainnamesCreates a domain name. - GETGet integrations
/v2/apis/:ApiId/integrations?maxResults=string&nextToken=stringGets the Integrations for an API. - POSTCreate integration
/v2/apis/:ApiId/integrationsCreates an Integration. - GETGet integration responses
/v2/apis/:ApiId/integrations/:IntegrationId/integrationresponses?maxResults=string&nextToken=stringGets the IntegrationResponses for an Integration. - POSTCreate integration response
/v2/apis/:ApiId/integrations/:IntegrationId/integrationresponsesCreates an IntegrationResponses. - GETGet models
/v2/apis/:ApiId/models?maxResults=string&nextToken=stringGets the Models for an API. - POSTCreate model
/v2/apis/:ApiId/modelsCreates a Model for an API. - GETList portals
/v2/portals?maxResults=string&nextToken=stringLists portals. - POSTCreate portal
/v2/portalsCreates a portal. - GETList portal products
/v2/portalproducts?maxResults=string&nextToken=string&resourceOwner=stringLists portal products. - POSTCreate portal product
/v2/portalproductsCreates a new portal product. - GETList product pages
/v2/portalproducts/:PortalProductId/productpages?maxResults=string&nextToken=string&resourceOwnerAccountId=stringLists the product pages for a portal product. - POSTCreate product page
/v2/portalproducts/:PortalProductId/productpagesCreates a new product page for a portal product. - GETList product rest endpoint pages
/v2/portalproducts/:PortalProductId/productrestendpointpages?maxResults=string&nextToken=string&resourceOwnerAccountId=stringLists the product REST endpoint pages of a portal product. - POSTCreate product rest endpoint page
/v2/portalproducts/:PortalProductId/productrestendpointpagesCreates a product REST endpoint page for a portal product. - GETGet routes
/v2/apis/:ApiId/routes?maxResults=string&nextToken=stringGets the Routes for an API. - POSTCreate route
/v2/apis/:ApiId/routesCreates a Route for an API. - GETGet route responses
/v2/apis/:ApiId/routes/:RouteId/routeresponses?maxResults=string&nextToken=stringGets the RouteResponses for a Route. - POSTCreate route response
/v2/apis/:ApiId/routes/:RouteId/routeresponsesCreates a RouteResponse for a Route. - GETList routing rules
/v2/domainnames/:DomainName/routingrules?domainNameId=string&maxResults=0&nextToken=stringLists routing rules. - POSTCreate routing rule
/v2/domainnames/:DomainName/routingrules?domainNameId=stringCreates a RoutingRule. - GETGet stages
/v2/apis/:ApiId/stages?maxResults=string&nextToken=stringGets the Stages for an API. - POSTCreate stage
/v2/apis/:ApiId/stagesCreates a Stage for an API. - GETGet vpc links
/v2/vpclinks?maxResults=string&nextToken=stringGets a collection of VPC links. - POSTCreate vpc link
/v2/vpclinksCreates a VPC link. - DELETEDelete access log settings
/v2/apis/:ApiId/stages/:StageName/accesslogsettingsDeletes the AccessLogSettings for a Stage. To disable access logging for a Stage, delete its AccessLogSettings. - GETGet api
/v2/apis/:ApiIdGets an Api resource. - PUTReimport api
/v2/apis/:ApiId?basepath=string&failOnWarnings=truePuts an Api resource. - DELETEDelete api
/v2/apis/:ApiIdDeletes an Api resource. - PATCHUpdate api
/v2/apis/:ApiIdUpdates an Api resource. - GETGet api mapping
/v2/domainnames/:DomainName/apimappings/:ApiMappingIdGets an API mapping. - DELETEDelete api mapping
/v2/domainnames/:DomainName/apimappings/:ApiMappingIdDeletes an API mapping. - PATCHUpdate api mapping
/v2/domainnames/:DomainName/apimappings/:ApiMappingIdThe API mapping. - GETGet authorizer
/v2/apis/:ApiId/authorizers/:AuthorizerIdGets an Authorizer. - DELETEDelete authorizer
/v2/apis/:ApiId/authorizers/:AuthorizerIdDeletes an Authorizer. - PATCHUpdate authorizer
/v2/apis/:ApiId/authorizers/:AuthorizerIdUpdates an Authorizer. - DELETEDelete cors configuration
/v2/apis/:ApiId/corsDeletes a CORS configuration. - GETGet deployment
/v2/apis/:ApiId/deployments/:DeploymentIdGets a Deployment. - DELETEDelete deployment
/v2/apis/:ApiId/deployments/:DeploymentIdDeletes a Deployment. - PATCHUpdate deployment
/v2/apis/:ApiId/deployments/:DeploymentIdUpdates a Deployment. - GETGet domain name
/v2/domainnames/:DomainNameGets a domain name. - DELETEDelete domain name
/v2/domainnames/:DomainNameDeletes a domain name. - PATCHUpdate domain name
/v2/domainnames/:DomainNameUpdates a domain name. - GETGet integration
/v2/apis/:ApiId/integrations/:IntegrationIdGets an Integration. - DELETEDelete integration
/v2/apis/:ApiId/integrations/:IntegrationIdDeletes an Integration. - PATCHUpdate integration
/v2/apis/:ApiId/integrations/:IntegrationIdUpdates an Integration. - GETGet integration response
/v2/apis/:ApiId/integrations/:IntegrationId/integrationresponses/:IntegrationResponseIdGets an IntegrationResponses. - DELETEDelete integration response
/v2/apis/:ApiId/integrations/:IntegrationId/integrationresponses/:IntegrationResponseIdDeletes an IntegrationResponses. - PATCHUpdate integration response
/v2/apis/:ApiId/integrations/:IntegrationId/integrationresponses/:IntegrationResponseIdUpdates an IntegrationResponses. - GETGet model
/v2/apis/:ApiId/models/:ModelIdGets a Model. - DELETEDelete model
/v2/apis/:ApiId/models/:ModelIdDeletes a Model. - PATCHUpdate model
/v2/apis/:ApiId/models/:ModelIdUpdates a Model. - GETGet portal
/v2/portals/:PortalIdGets a portal. - DELETEDelete portal
/v2/portals/:PortalIdDeletes a portal. - PATCHUpdate portal
/v2/portals/:PortalIdUpdates a portal. - GETGet portal product
/v2/portalproducts/:PortalProductId?resourceOwnerAccountId=stringGets a portal product. - DELETEDelete portal product
/v2/portalproducts/:PortalProductIdDeletes a portal product. - PATCHUpdate portal product
/v2/portalproducts/:PortalProductIdUpdates the portal product. - GETGet portal product sharing policy
/v2/portalproducts/:PortalProductId/sharingpolicyGets the sharing policy for a portal product. - PUTPut portal product sharing policy
/v2/portalproducts/:PortalProductId/sharingpolicyUpdates the sharing policy for a portal product. - DELETEDelete portal product sharing policy
/v2/portalproducts/:PortalProductId/sharingpolicyDeletes the sharing policy for a portal product. - GETGet product page
/v2/portalproducts/:PortalProductId/productpages/:ProductPageId?resourceOwnerAccountId=stringGets a product page of a portal product. - DELETEDelete product page
/v2/portalproducts/:PortalProductId/productpages/:ProductPageIdDeletes a product page of a portal product. - PATCHUpdate product page
/v2/portalproducts/:PortalProductId/productpages/:ProductPageIdUpdates a product page of a portal product. - GETGet product rest endpoint page
/v2/portalproducts/:PortalProductId/productrestendpointpages/:ProductRestEndpointPageId?includeRawDisplayContent=string&resourceOwnerAccountId=stringGets a product REST endpoint page. - DELETEDelete product rest endpoint page
/v2/portalproducts/:PortalProductId/productrestendpointpages/:ProductRestEndpointPageIdDeletes a product REST endpoint page. - PATCHUpdate product rest endpoint page
/v2/portalproducts/:PortalProductId/productrestendpointpages/:ProductRestEndpointPageIdUpdates a product REST endpoint page. - GETGet route
/v2/apis/:ApiId/routes/:RouteIdGets a Route. - DELETEDelete route
/v2/apis/:ApiId/routes/:RouteIdDeletes a Route. - PATCHUpdate route
/v2/apis/:ApiId/routes/:RouteIdUpdates a Route. - DELETEDelete route request parameter
/v2/apis/:ApiId/routes/:RouteId/requestparameters/:RequestParameterKeyDeletes a route request parameter. Supported only for WebSocket APIs. - GETGet route response
/v2/apis/:ApiId/routes/:RouteId/routeresponses/:RouteResponseIdGets a RouteResponse. - DELETEDelete route response
/v2/apis/:ApiId/routes/:RouteId/routeresponses/:RouteResponseIdDeletes a RouteResponse. - PATCHUpdate route response
/v2/apis/:ApiId/routes/:RouteId/routeresponses/:RouteResponseIdUpdates a RouteResponse. - DELETEDelete route settings
/v2/apis/:ApiId/stages/:StageName/routesettings/:RouteKeyDeletes the RouteSettings for a stage. - GETGet routing rule
/v2/domainnames/:DomainName/routingrules/:RoutingRuleId?domainNameId=stringGets a routing rule. - PUTPut routing rule
/v2/domainnames/:DomainName/routingrules/:RoutingRuleId?domainNameId=stringUpdates a routing rule. - DELETEDelete routing rule
/v2/domainnames/:DomainName/routingrules/:RoutingRuleId?domainNameId=stringDeletes a routing rule. - GETGet stage
/v2/apis/:ApiId/stages/:StageNameGets a Stage. - DELETEDelete stage
/v2/apis/:ApiId/stages/:StageNameDeletes a Stage. - PATCHUpdate stage
/v2/apis/:ApiId/stages/:StageNameUpdates a Stage. - GETGet vpc link
/v2/vpclinks/:VpcLinkIdGets a VPC link. - DELETEDelete vpc link
/v2/vpclinks/:VpcLinkIdDeletes a VPC link. - PATCHUpdate vpc link
/v2/vpclinks/:VpcLinkIdUpdates a VPC link. - POSTPublish portal
/v2/portals/:PortalId/publishPublishes a portal. - DELETEDisable portal
/v2/portals/:PortalId/publishDeletes the publication of a portal portal. - GETExport api
/v2/apis/:ApiId/exports/:Specification?exportVersion=string&includeExtensions=true&outputType=string&stageName=string - GETGet model template
/v2/apis/:ApiId/models/:ModelId/templateGets a model template. - GETGet tags
/v2/tags/:ResourceArnGets a collection of Tag resources. - POSTTag resource
/v2/tags/:ResourceArnCreates a new Tag resource to represent a tag. - DELETEUntag resource
/v2/tags/:ResourceArn?tagKeys=Deletes a Tag. - POSTPreview portal
/v2/portals/:PortalId/previewCreates a portal preview. - DELETEReset authorizers cache
/v2/apis/:ApiId/stages/:StageName/cache/authorizersResets all authorizer cache entries on a stage. Supported only for HTTP APIs.
API details
- Base URL
https://apigateway.{region}.amazonaws.com- Authentication
- AWS Signature Version 4 (requests signed with your AWS access key)
- Operations
- 103 operations on 45 pathsGET 38DELETE 25POST 20PATCH 16PUT 4
- Description format
- AWS Smithy model, API version
2018-11-29 - Links
- Documentation · OpenAPI document
- Listed from
- AWS Smithy API model (aws/api-models-aws) (Apache-2.0)
How to test the AmazonApiGatewayV2 in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the AmazonApiGatewayV2 collection, without the publisher's secrets.
- Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Get apis” (GET /v2/apis?maxResults=string&nextToken=string), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the AmazonApiGatewayV2?
Amazon API Gateway V2 It is listed under Developer tools and has 103 endpoints.
Who publishes the AmazonApiGatewayV2?
It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.
What is the base URL of the AmazonApiGatewayV2?
Requests go to https://apigateway.{region}.amazonaws.com. Endpoint paths are added to this base URL.
How do I authenticate with the AmazonApiGatewayV2?
With AWS Signature Version 4 (requests signed with your AWS access key).
How many endpoints does the AmazonApiGatewayV2 have?
103 operations on 45 paths (38 GET, 25 DELETE, 20 POST, 16 PATCH, 4 PUT).
Is forking the AmazonApiGatewayV2 free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.