Skip to content

Firewall Management Service API

by amazonaws.com

API keyHTTPSCloud Platforms
Open documentation ↗

Overview

<p>This is the <i>Firewall Manager API Reference</i>. This guide is for developers who need detailed information about the Firewall Manager API actions, data types, and errors. For detailed information about Firewall Manager features, see the <a href="https://docs.aws.amazon.com/waf/latest/developerguide/fms-chapter.html">Firewall Manager Developer Guide</a>.</p> <p>Some API actions require explicit resource permissions. For information, see the developer guide topic <a href="https://docs.aws.amazon.com/waf/latest/developerguide/fms-security_iam_service-with-iam.html#fms-security_iam_service-with-iam-roles-service">Service roles for Firewall Manager</a>. </p>

Firewall Management Service is a cloud platforms API from amazonaws.com. Requests are authenticated with an API key. It is served over HTTPS. Its OpenAPI description documents 42 endpoints.

At a glance

Authentication
API key
HTTPS
Yes
CORS
Unknown
Version
2018-01-01
Endpoints
42
Spec updated
2020-04-22

Endpoints

MethodPathWhat it does
POST/#X-Amz-Target=AWSFMS_20180101.AssociateAdminAccount<p>Sets a Firewall Manager default administrator account. The Firewall Manager default administrator account can manage third-party firewalls and has full admin
POST/#X-Amz-Target=AWSFMS_20180101.AssociateThirdPartyFirewallSets the Firewall Manager policy administrator as a tenant administrator of a third-party firewall service. A tenant is an instance of the third-party firewall
POST/#X-Amz-Target=AWSFMS_20180101.BatchAssociateResourceAssociate resources to a Firewall Manager resource set.
POST/#X-Amz-Target=AWSFMS_20180101.BatchDisassociateResourceDisassociates resources from a Firewall Manager resource set.
POST/#X-Amz-Target=AWSFMS_20180101.DeleteAppsListPermanently deletes an Firewall Manager applications list.
POST/#X-Amz-Target=AWSFMS_20180101.DeleteNotificationChannelDeletes an Firewall Manager association with the IAM role and the Amazon Simple Notification Service (SNS) topic that is used to record Firewall Manager SNS log
POST/#X-Amz-Target=AWSFMS_20180101.DeletePolicyPermanently deletes an Firewall Manager policy.
POST/#X-Amz-Target=AWSFMS_20180101.DeleteProtocolsListPermanently deletes an Firewall Manager protocols list.
POST/#X-Amz-Target=AWSFMS_20180101.DeleteResourceSetDeletes the specified <a>ResourceSet</a>.
POST/#X-Amz-Target=AWSFMS_20180101.DisassociateAdminAccount<p>Disassociates an Firewall Manager administrator account. To set a different account as an Firewall Manager administrator, submit a <a>PutAdminAccount</a> req
POST/#X-Amz-Target=AWSFMS_20180101.DisassociateThirdPartyFirewallDisassociates a Firewall Manager policy administrator from a third-party firewall tenant. When you call <code>DisassociateThirdPartyFirewall</code>, the third-p
POST/#X-Amz-Target=AWSFMS_20180101.GetAdminAccountReturns the Organizations account that is associated with Firewall Manager as the Firewall Manager default administrator.
POST/#X-Amz-Target=AWSFMS_20180101.GetAdminScopeReturns information about the specified account's administrative scope. The admistrative scope defines the resources that an Firewall Manager administrator can
POST/#X-Amz-Target=AWSFMS_20180101.GetAppsListReturns information about the specified Firewall Manager applications list.
POST/#X-Amz-Target=AWSFMS_20180101.GetComplianceDetail<p>Returns detailed compliance information about the specified member account. Details include resources that are in and out of compliance with the specified po
POST/#X-Amz-Target=AWSFMS_20180101.GetNotificationChannelInformation about the Amazon Simple Notification Service (SNS) topic that is used to record Firewall Manager SNS logs.
POST/#X-Amz-Target=AWSFMS_20180101.GetPolicyReturns information about the specified Firewall Manager policy.
POST/#X-Amz-Target=AWSFMS_20180101.GetProtectionStatusIf you created a Shield Advanced policy, returns policy-level attack summary information in the event of a potential DDoS attack. Other policy types are current
POST/#X-Amz-Target=AWSFMS_20180101.GetProtocolsListReturns information about the specified Firewall Manager protocols list.
POST/#X-Amz-Target=AWSFMS_20180101.GetResourceSetGets information about a specific resource set.
POST/#X-Amz-Target=AWSFMS_20180101.GetThirdPartyFirewallAssociationStatusThe onboarding status of a Firewall Manager admin account to third-party firewall vendor tenant.
POST/#X-Amz-Target=AWSFMS_20180101.GetViolationDetailsRetrieves violations for a resource based on the specified Firewall Manager policy and Amazon Web Services account.
POST/#X-Amz-Target=AWSFMS_20180101.ListAdminAccountsForOrganization<p>Returns a <code>AdminAccounts</code> object that lists the Firewall Manager administrators within the organization that are onboarded to Firewall Manager by
POST/#X-Amz-Target=AWSFMS_20180101.ListAdminsManagingAccountLists the accounts that are managing the specified Organizations member account. This is useful for any member account so that they can view the accounts who ar
POST/#X-Amz-Target=AWSFMS_20180101.ListAppsListsReturns an array of <code>AppsListDataSummary</code> objects.
POST/#X-Amz-Target=AWSFMS_20180101.ListComplianceStatusReturns an array of <code>PolicyComplianceStatus</code> objects. Use <code>PolicyComplianceStatus</code> to get a summary of which member accounts are protected
POST/#X-Amz-Target=AWSFMS_20180101.ListDiscoveredResourcesReturns an array of resources in the organization's accounts that are available to be associated with a resource set.
POST/#X-Amz-Target=AWSFMS_20180101.ListMemberAccounts<p>Returns a <code>MemberAccounts</code> object that lists the member accounts in the administrator's Amazon Web Services organization.</p> <p>Either an Firewal
POST/#X-Amz-Target=AWSFMS_20180101.ListPoliciesReturns an array of <code>PolicySummary</code> objects.
POST/#X-Amz-Target=AWSFMS_20180101.ListProtocolsListsReturns an array of <code>ProtocolsListDataSummary</code> objects.
POST/#X-Amz-Target=AWSFMS_20180101.ListResourceSetResourcesReturns an array of resources that are currently associated to a resource set.
POST/#X-Amz-Target=AWSFMS_20180101.ListResourceSetsReturns an array of <code>ResourceSetSummary</code> objects.
POST/#X-Amz-Target=AWSFMS_20180101.ListTagsForResourceRetrieves the list of tags for the specified Amazon Web Services resource.
POST/#X-Amz-Target=AWSFMS_20180101.ListThirdPartyFirewallFirewallPoliciesRetrieves a list of all of the third-party firewall policies that are associated with the third-party firewall administrator's account.
POST/#X-Amz-Target=AWSFMS_20180101.PutAdminAccountCreates or updates an Firewall Manager administrator account. The account must be a member of the organization that was onboarded to Firewall Manager by <a>Asso
POST/#X-Amz-Target=AWSFMS_20180101.PutAppsListCreates an Firewall Manager applications list.
POST/#X-Amz-Target=AWSFMS_20180101.PutNotificationChannel<p>Designates the IAM role and Amazon Simple Notification Service (SNS) topic that Firewall Manager uses to record SNS logs.</p> <p>To perform this action outsi
POST/#X-Amz-Target=AWSFMS_20180101.PutPolicy<p>Creates an Firewall Manager policy.</p> <p>Firewall Manager provides the following types of policies: </p> <ul> <li> <p>An WAF policy (type WAFV2), which def
POST/#X-Amz-Target=AWSFMS_20180101.PutProtocolsListCreates an Firewall Manager protocols list.
POST/#X-Amz-Target=AWSFMS_20180101.PutResourceSet<p>Creates the resource set.</p> <p>An Firewall Manager resource set defines the resources to import into an Firewall Manager policy from another Amazon Web Ser
POST/#X-Amz-Target=AWSFMS_20180101.TagResourceAdds one or more tags to an Amazon Web Services resource.
POST/#X-Amz-Target=AWSFMS_20180101.UntagResourceRemoves one or more tags from an Amazon Web Services resource.

Questions

Does the Firewall Management Service API need an API key?

Yes. The Firewall Management Service API uses API key authentication; the documentation explains how to get credentials.

Does the Firewall Management Service API support HTTPS?

Yes, the Firewall Management Service API is served over HTTPS.

How many endpoints does the Firewall Management Service API have?

Its OpenAPI description lists 42 endpoints in version 2018-01-01. All of them are shown on this page.

What are alternatives to the Firewall Management Service API?

Other Cloud Platforms APIs include Remote Settings PROD, Linode API, DigitalOcean API, Vercel API, Platform API.

Compare alternatives →

Remote Settings PROD

Cloud Platforms

Firefox is a free web browser backed by Mozilla, a non-profit dedicated to internet health and privacy.

No auth19 endpoints

Linode API

Cloud Platforms

## Introduction The Linode API provides the ability to programmatically manage the full range of Linode products and services. This reference is designed to assist application developers and system administrators. Each endpoint includes descriptions, request syntax, and examples using standard HTTP requests. Response data is returned in JSON format. This document was generated from our OpenAPI Specification. See the <a target="_top" href="https://www.openapis.org">OpenAPI website</a> for more information. <a target="_top" href="/docs/api/openapi.yaml">Download the Linode OpenAPI Specification</a>. ## Changelog <a target="_top" href="/docs/products/tools/api/release-notes/">View our Changelog</a> to see release notes on all changes made to our API. ## Access and Authentication Some endpoints are publicly accessible without requiring authentication. All endpoints affecting your Account, however, require either a Personal Access Token or OAuth authentication (when using third-party applications). ### Personal Access Token The easiest way to access the API is with a Personal Access Token (PAT) generated from the <a target="_top" href="https://cloud.linode.com/profile/tokens">Linode Cloud Manager</a> or the [Create Personal Access Token](/docs/api/profile/#personal-access-token-create) endpoint. All scopes for the OAuth security model ([defined below](/docs/api/profile/#oauth)) apply to this security model as well. #### Authentication | Security Scheme Type: | HTTP | |-----------------------|------| | **HTTP Authorization Scheme** | bearer | ### OAuth If you only need to access the Linode API for personal use, we recommend that you create a [personal access token](/docs/api/#personal-access-token). If you're designing an application that can authenticate with an arbitrary Linode user, then you should use the OAuth 2.0 workflows presented in this section. For a more detailed example of an OAuth 2.0 implementation, see our guide on [How to Create an OAuth App with the Linode Python API Library](/docs/products/tools/api/guides/create-an-oauth-app-with-the-python-api-library/#oauth-2-authentication-exchange). Before you implement OAuth in your application, you first need to create an OAuth client. You can do this [with the Linode API](/docs/api/account/#oauth-client-create) or [via the Cloud Manager](https://cloud.linode.com/profile/clients): - When creating the client, you'll supply a `label` and a `redirect_uri` (referred to as the Callback URL in the Cloud Manager). - The response from this endpoint will give you a `client_id` and a `secret`. - Clients can be public or private, and are private by default. You can choose to make the client public when it is created. - A private client is used with applications which can securely store the client secret (that is, the secret returned to you when you first created the client). For example, an application running on a secured server that only the developer has access to would use a private OAuth client. This is also called a confidential client in some OAuth documentation. - A public client is used with applications where the client secret is not guaranteed to be secure. For example, a native app running on a user's computer may not be able to keep the client secret safe, as a user could potentially inspect the source of the application. So, native apps or apps that run in a user's browser should use a public client. - Public and private clients follow different workflows, as described below. #### OAuth Workflow The OAuth workflow is a series of exchanges between your third-party app and Linode. The workflow is used to authenticate a user before an application can start making API calls on the user's behalf. Notes: - With respect to the diagram in [section 1.2 of RFC 6749](https://tools.ietf.org/html/rfc6749#section-1.2), login.linode.com (referred to in this section as the *login server*) is the Resource Owner and the Authorization Server; api.linode.com (referred to here as the *api se

Bearer token350 endpoints

DigitalOcean API

Cloud Platforms

# Introduction The DigitalOcean API allows you to manage Droplets and resources within the DigitalOcean cloud in a simple, programmatic way using conventional HTTP requests. All of the functionality that you are familiar with in the DigitalOcean control panel is also available through the API, allowing you to script the complex actions that your situation requires. The API documentation will start with a general overview about the design and technology that has been implemented, followed by reference information about specific endpoints. ## Requests Any tool that is fluent in HTTP can communicate with the API simply by requesting the correct URI. Requests should be made using the HTTPS protocol so that traffic is encrypted. The interface responds to different methods depending on the action required. |Method|Usage| |--- |--- | |GET|For simple retrieval of information about your account, Droplets, or environment, you should use the GET method. The information you request will be returned to you as a JSON object. The attributes defined by the JSON object can be used to form additional requests. Any request using the GET method is read-only and will not affect any of the objects you are querying.| |DELETE|To destroy a resource and remove it from your account and environment, the DELETE method should be used. This will remove the specified object if it is found. If it is not found, the operation will return a response indicating that the object was not found. This idempotency means that you do not have to check for a resource's availability prior to issuing a delete command, the final state will be the same regardless of its existence.| |PUT|To update the information about a resource in your account, the PUT method is available. Like the DELETE Method, the PUT method is idempotent. It sets the state of the target using the provided values, regardless of their current values. Requests using the PUT method do not need to check the current attributes of the object.| |PATCH|Some resources support partial modification. In these cases, the PATCH method is available. Unlike PUT which generally requires a complete representation of a resource, a PATCH request is is a set of instructions on how to modify a resource updating only specific attributes.| |POST|To create a new object, your request should specify the POST method. The POST request includes all of the attributes necessary to create a new object. When you wish to create a new object, send a POST request to the target endpoint.| |HEAD|Finally, to retrieve metadata information, you should use the HEAD method to get the headers. This returns only the header of what would be returned with an associated GET request. Response headers contain some useful information about your API access and the results that are available for your request. For instance, the headers contain your current rate-limit value and the amount of time available until the limit resets. It also contains metrics about the total number of objects found, pagination information, and the total content length.| ## HTTP Statuses Along with the HTTP methods that the API responds to, it will also return standard HTTP statuses, including error codes. In the event of a problem, the status will contain the error code, while the body of the response will usually contain additional information about the problem that was encountered. In general, if the status returned is in the 200 range, it indicates that the request was fulfilled successfully and that no error was encountered. Return codes in the 400 range typically indicate that there was an issue with the request that was sent. Among other things, this could mean that you did not authenticate correctly, that you are requesting an action that you do not have authorization for, that the object you are requesting does not exist, or that your request is malformed. If you receive a status in the 500 range, this generally indicates a server-side problem. This means that we are having

Bearer token290 endpoints

Vercel API

Cloud Platforms

Vercel combines the best developer experience with an obsessive focus on end-user performance. Our platform enables frontend teams to do their best work.

Bearer token112 endpoints

Platform API

Cloud Platforms

The [REST API specification](https://www.ably.io/documentation/rest-api) for Ably.

HTTP Basic22 endpoints

Azure Data Lake Storage

Cloud Platforms

Azure Data Lake Storage provides storage for Hadoop and other big data workloads.

No auth10 endpoints

Listed from APIs.guru (CC0).