Amazon GuardDuty Admin API

The Admin API from Amazon GuardDuty — 3 operation(s) for admin.

GitHub OpenAPI

Operations 5

GET /detector/{DetectorId}/admin Describe Organization Configuration #
POST /detector/{DetectorId}/admin Update Organization Configuration #
POST /admin/disable Disable Organization Admin Account #
POST /admin/enable Enable Organization Admin Account #
GET /admin List Organization Admin Accounts #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/amazon-guardduty:amazon-guardduty-admin-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

amazon-guardduty-admin-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Amazon GuardDuty Admin API
  version: '2017-11-28'
  description: Generated from AWS's published Smithy model for Amazon GuardDuty. 5 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://guardduty.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /detector/{DetectorId}/admin:
    get:
      operationId: DescribeOrganizationConfiguration
      summary: Describe Organization Configuration
      description: Returns information about the account selected as the delegated administrator for GuardDuty. There might
        be regional differences because some data sources might not be available in all the Amazon Web Services Regions where
        GuardDuty is presently supported. For more information, see Regions and endpoints.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeOrganizationConfigurationResponse'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '500':
          description: InternalServerErrorException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribeOrganizationConfigurationRequest'
      tags:
      - Admin
    post:
      operationId: UpdateOrganizationConfiguration
      summary: Update Organization Configuration
      description: Configures the delegated administrator account with the provided values. You must provide a value for either
        autoEnableOrganizationMembers or autoEnable, but not both. Specifying both EKS Runtime Monitoring (EKS_RUNTIME_MONITORING)
        and Runtime Monitoring (RUNTIME_MONITORING) will cause an error. You can add only one of these two features because
        Runtime Monitoring already includes the threat detection for Amazon EKS resources. For more information, see Runtime
        Monitoring. There might be regional differences because some data sources might not be available in all the Amazon
        Web Services Regions where GuardDuty is presently supported. For more information, see Regions and endpoints.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateOrganizationConfigurationResponse'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '500':
          description: InternalServerErrorException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateOrganizationConfigurationRequest'
      tags:
      - Admin
  /admin/disable:
    post:
      operationId: DisableOrganizationAdminAccount
      summary: Disable Organization Admin Account
      description: Removes the existing GuardDuty delegated administrator of the organization. Only the organization's management
        account can run this API operation.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DisableOrganizationAdminAccountResponse'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '500':
          description: InternalServerErrorException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DisableOrganizationAdminAccountRequest'
      tags:
      - Admin
  /admin/enable:
    post:
      operationId: EnableOrganizationAdminAccount
      summary: Enable Organization Admin Account
      description: Designates an Amazon Web Services account within the organization as your GuardDuty delegated administrator.
        Only the organization's management account can run this API operation.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EnableOrganizationAdminAccountResponse'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '500':
          description: InternalServerErrorException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EnableOrganizationAdminAccountRequest'
      tags:
      - Admin
  /admin:
    get:
      operationId: ListOrganizationAdminAccounts
      summary: List Organization Admin Accounts
      description: Lists the accounts designated as GuardDuty delegated administrators. Only the organization's management
        account can run this API operation.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListOrganizationAdminAccountsResponse'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '500':
          description: InternalServerErrorException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListOrganizationAdminAccountsRequest'
      tags:
      - Admin
components:
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical
        request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: guardduty
  schemas:
    AdminAccount:
      type: object
      properties:
        AdminAccountId:
          type: string
          description: The Amazon Web Services account ID for the account.
        AdminStatus:
          type: string
          enum:
          - ENABLED
          - DISABLE_IN_PROGRESS
          description: Indicates whether the account is enabled as the delegated administrator.
    BadRequestException:
      type: object
      properties:
        Message:
          type: string
          description: The error message.
        Type:
          type: string
          description: The error type.
    DescribeOrganizationConfigurationRequest:
      type: object
      properties:
        DetectorId:
          type: string
          description: The detector ID of the delegated administrator for which you need to retrieve the information. To find
            the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors
            API.
        MaxResults:
          type: integer
          description: You can use this parameter to indicate the maximum number of items that you want in the response.
        NextToken:
          type: string
          description: You can use this parameter when paginating results. Set the value of this parameter to null on your
            first call to the list action. For subsequent calls to the action, fill nextToken in the request with the value
            of NextToken from the previous response to continue listing data.
      required:
      - DetectorId
    DescribeOrganizationConfigurationResponse:
      type: object
      properties:
        AutoEnable:
          type: boolean
          description: Indicates whether GuardDuty is automatically enabled for accounts added to the organization. Even though
            this is still supported, we recommend using AutoEnableOrganizationMembers to achieve the similar results.
        MemberAccountLimitReached:
          type: boolean
          description: Indicates whether the maximum number of allowed member accounts are already associated with the delegated
            administrator account for your organization.
        DataSources:
          $ref: '#/components/schemas/OrganizationDataSourceConfigurationsResult'
        Features:
          type: array
          items:
            $ref: '#/components/schemas/OrganizationFeatureConfigurationResult'
          description: A list of features that are configured for this organization.
        NextToken:
          type: string
          description: The pagination parameter to be used on the next list operation to retrieve more items.
        AutoEnableOrganizationMembers:
          type: string
          enum:
          - NEW
          - ALL
          - NONE
          description: 'Indicates the auto-enablement configuration of GuardDuty or any of the corresponding protection plans
            for the member accounts in the organization. NEW: Indicates that when a new account joins the organization, they
            will have GuardDuty or any of the corresponding protection plans enabled automatically. ALL: Indicates that all
            accounts in the organization have GuardDuty and any of the corresponding protection plans enabled automatically.
            This includes NEW accounts that join the organization and accounts that may have been suspended or removed from
            the organization in GuardDuty. NONE: Indicates t'
      required:
      - MemberAccountLimitReached
    DisableOrganizationAdminAccountRequest:
      type: object
      properties:
        AdminAccountId:
          type: string
          description: The Amazon Web Services Account ID for the organizations account to be disabled as a GuardDuty delegated
            administrator.
      required:
      - AdminAccountId
    DisableOrganizationAdminAccountResponse:
      type: object
      properties: {}
    EnableOrganizationAdminAccountRequest:
      type: object
      properties:
        AdminAccountId:
          type: string
          description: The Amazon Web Services account ID for the organization account to be enabled as a GuardDuty delegated
            administrator.
      required:
      - AdminAccountId
    EnableOrganizationAdminAccountResponse:
      type: object
      properties: {}
    InternalServerErrorException:
      type: object
      properties:
        Message:
          type: string
          description: The error message.
        Type:
          type: string
          description: The error type.
    ListOrganizationAdminAccountsRequest:
      type: object
      properties:
        MaxResults:
          type: integer
          description: The maximum number of results to return in the response.
        NextToken:
          type: string
          description: A token to use for paginating results that are returned in the response. Set the value of this parameter
            to null for the first request to a list action. For subsequent calls, use the NextToken value returned from the
            previous request to continue listing results after the first page.
    ListOrganizationAdminAccountsResponse:
      type: object
      properties:
        AdminAccounts:
          type: array
          items:
            $ref: '#/components/schemas/AdminAccount'
          description: A list of accounts configured as GuardDuty delegated administrators.
        NextToken:
          type: string
          description: The pagination parameter to be used on the next list operation to retrieve more items.
    OrganizationAdditionalConfiguration:
      type: object
      properties:
        Name:
          type: string
          enum:
          - EKS_ADDON_MANAGEMENT
          - ECS_FARGATE_AGENT_MANAGEMENT
          - EC2_AGENT_MANAGEMENT
          - RDS_DATA_RISK
          description: The name of the additional configuration that will be configured for the organization. These values
            are applicable to only Runtime Monitoring protection plan.
        AutoEnable:
          type: string
          enum:
          - NEW
          - NONE
          - ALL
          description: 'The status of the additional configuration that will be configured for the organization. Use one of
            the following values to configure the feature status for the entire organization: NEW: Indicates that when a new
            account joins the organization, they will have the additional configuration enabled automatically. ALL: Indicates
            that all accounts in the organization have the additional configuration enabled automatically. This includes NEW
            accounts that join the organization and accounts that may have been suspended or removed from the organization
            in GuardDuty. It may take up to 24 hours to updat'
    OrganizationAdditionalConfigurationResult:
      type: object
      properties:
        Name:
          type: string
          enum:
          - EKS_ADDON_MANAGEMENT
          - ECS_FARGATE_AGENT_MANAGEMENT
          - EC2_AGENT_MANAGEMENT
          - RDS_DATA_RISK
          description: The name of the additional configuration that is configured for the member accounts within the organization.
            These values are applicable to only Runtime Monitoring protection plan.
        AutoEnable:
          type: string
          enum:
          - NEW
          - NONE
          - ALL
          description: 'Describes the status of the additional configuration that is configured for the member accounts within
            the organization. One of the following values is the status for the entire organization: NEW: Indicates that when
            a new account joins the organization, they will have the additional configuration enabled automatically. ALL:
            Indicates that all accounts in the organization have the additional configuration enabled automatically. This
            includes NEW accounts that join the organization and accounts that may have been suspended or removed from the
            organization in GuardDuty. It may take up to 24 hour'
    OrganizationDataSourceConfigurations:
      type: object
      properties:
        S3Logs:
          $ref: '#/components/schemas/OrganizationS3LogsConfiguration'
        Kubernetes:
          $ref: '#/components/schemas/OrganizationKubernetesConfiguration'
        MalwareProtection:
          $ref: '#/components/schemas/OrganizationMalwareProtectionConfiguration'
    OrganizationDataSourceConfigurationsResult:
      type: object
      properties:
        S3Logs:
          $ref: '#/components/schemas/OrganizationS3LogsConfigurationResult'
        Kubernetes:
          $ref: '#/components/schemas/OrganizationKubernetesConfigurationResult'
        MalwareProtection:
          $ref: '#/components/schemas/OrganizationMalwareProtectionConfigurationResult'
      required:
      - S3Logs
    OrganizationEbsVolumes:
      type: object
      properties:
        AutoEnable:
          type: boolean
          description: Whether scanning EBS volumes should be auto-enabled for new members joining the organization.
    OrganizationEbsVolumesResult:
      type: object
      properties:
        AutoEnable:
          type: boolean
          description: An object that contains the status of whether scanning EBS volumes should be auto-enabled for new members
            joining the organization.
    OrganizationFeatureConfiguration:
      type: object
      properties:
        Name:
          type: string
          enum:
          - S3_DATA_EVENTS
          - EKS_AUDIT_LOGS
          - EBS_MALWARE_PROTECTION
          - RDS_LOGIN_EVENTS
          - LAMBDA_NETWORK_LOGS
          - EKS_RUNTIME_MONITORING
          - RUNTIME_MONITORING
          - AI_PROTECTION
          description: The name of the feature that will be configured for the organization.
        AutoEnable:
          type: string
          enum:
          - NEW
          - NONE
          - ALL
          description: 'Describes the status of the feature that is configured for the member accounts within the organization.
            One of the following values is the status for the entire organization: NEW: Indicates that when a new account
            joins the organization, they will have the feature enabled automatically. ALL: Indicates that all accounts in
            the organization have the feature enabled automatically. This includes NEW accounts that join the organization
            and accounts that may have been suspended or removed from the organization in GuardDuty. It may take up to 24
            hours to update the configuration for all the member ac'
        AdditionalConfiguration:
          type: array
          items:
            $ref: '#/components/schemas/OrganizationAdditionalConfiguration'
          description: The additional information that will be configured for the organization.
    OrganizationFeatureConfigurationResult:
      type: object
      properties:
        Name:
          type: string
          enum:
          - S3_DATA_EVENTS
          - EKS_AUDIT_LOGS
          - EBS_MALWARE_PROTECTION
          - RDS_LOGIN_EVENTS
          - LAMBDA_NETWORK_LOGS
          - EKS_RUNTIME_MONITORING
          - RUNTIME_MONITORING
          - AI_PROTECTION
          description: The name of the feature that is configured for the member accounts within the organization.
        AutoEnable:
          type: string
          enum:
          - NEW
          - NONE
          - ALL
          description: 'Describes the status of the feature that is configured for the member accounts within the organization.
            NEW: Indicates that when a new account joins the organization, they will have the feature enabled automatically.
            ALL: Indicates that all accounts in the organization have the feature enabled automatically. This includes NEW
            accounts that join the organization and accounts that may have been suspended or removed from the organization
            in GuardDuty. NONE: Indicates that the feature will not be automatically enabled for any account in the organization.
            In this case, each account will be managed '
        AdditionalConfiguration:
          type: array
          items:
            $ref: '#/components/schemas/OrganizationAdditionalConfigurationResult'
          description: The additional configuration that is configured for the member accounts within the organization.
    OrganizationKubernetesAuditLogsConfiguration:
      type: object
      properties:
        AutoEnable:
          type: boolean
          description: A value that contains information on whether Kubernetes audit logs should be enabled automatically
            as a data source for the organization.
      required:
      - AutoEnable
    OrganizationKubernetesAuditLogsConfigurationResult:
      type: object
      properties:
        AutoEnable:
          type: boolean
          description: Whether Kubernetes audit logs data source should be auto-enabled for new members joining the organization.
      required:
      - AutoEnable
    OrganizationKubernetesConfiguration:
      type: object
      properties:
        AuditLogs:
          $ref: '#/components/schemas/OrganizationKubernetesAuditLogsConfiguration'
      required:
      - AuditLogs
    OrganizationKubernetesConfigurationResult:
      type: object
      properties:
        AuditLogs:
          $ref: '#/components/schemas/OrganizationKubernetesAuditLogsConfigurationResult'
      required:
      - AuditLogs
    OrganizationMalwareProtectionConfiguration:
      type: object
      properties:
        ScanEc2InstanceWithFindings:
          $ref: '#/components/schemas/OrganizationScanEc2InstanceWithFindings'
    OrganizationMalwareProtectionConfigurationResult:
      type: object
      properties:
        ScanEc2InstanceWithFindings:
          $ref: '#/components/schemas/OrganizationScanEc2InstanceWithFindingsResult'
    OrganizationS3LogsConfiguration:
      type: object
      properties:
        AutoEnable:
          type: boolean
          description: A value that contains information on whether S3 data event logs will be enabled automatically as a
            data source for the organization.
      required:
      - AutoEnable
    OrganizationS3LogsConfigurationResult:
      type: object
      properties:
        AutoEnable:
          type: boolean
          description: A value that describes whether S3 data event logs are automatically enabled for new members of the
            organization.
      required:
      - AutoEnable
    OrganizationScanEc2InstanceWithFindings:
      type: object
      properties:
        EbsVolumes:
          $ref: '#/components/schemas/OrganizationEbsVolumes'
    OrganizationScanEc2InstanceWithFindingsResult:
      type: object
      properties:
        EbsVolumes:
          $ref: '#/components/schemas/OrganizationEbsVolumesResult'
    UpdateOrganizationConfigurationRequest:
      type: object
      properties:
        DetectorId:
          type: string
          description: The ID of the detector that configures the delegated administrator. To find the detectorId in the current
            Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.
        AutoEnable:
          type: boolean
          description: Represents whether to automatically enable member accounts in the organization. This applies to only
            new member accounts, not the existing member accounts. When a new account joins the organization, the chosen features
            will be enabled for them by default. Even though this is still supported, we recommend using AutoEnableOrganizationMembers
            to achieve the similar results. You must provide a value for either autoEnableOrganizationMembers or autoEnable.
        DataSources:
          $ref: '#/components/schemas/OrganizationDataSourceConfigurations'
        Features:
          type: array
          items:
            $ref: '#/components/schemas/OrganizationFeatureConfiguration'
          description: A list of features that will be configured for the organization.
        AutoEnableOrganizationMembers:
          type: string
          enum:
          - NEW
          - ALL
          - NONE
          description: 'Indicates the auto-enablement configuration of GuardDuty for the member accounts in the organization.
            You must provide a value for either autoEnableOrganizationMembers or autoEnable. Use one of the following configuration
            values for autoEnableOrganizationMembers: NEW: Indicates that when a new account joins the organization, they
            will have GuardDuty enabled automatically. ALL: Indicates that all accounts in the organization have GuardDuty
            enabled automatically. This includes NEW accounts that join the organization and accounts that may have been suspended
            or removed from the organization in Gu'
      required:
      - DetectorId
    UpdateOrganizationConfigurationResponse:
      type: object
      properties: {}
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/guardduty/service/2017-11-28/guardduty-2017-11-28.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)