Cisco Meraki Policies API
The Policies API from Cisco Meraki — 4 operation(s) for policies.
OpenAPI Specification
openapi: 3.0.0
info:
title: Meraki Integrated API for Secure Connect — Policies
description: "The Cisco Meraki Integrated API for Secure Connect is a modern REST API based on the OpenAPI specification.\n\
\ ---\n\n [API Documentation](https://meraki.io/api)\n\n [Meraki Homepage](https://www.meraki.com)\n"
version: 1.8.0
contact:
name: Meraki Developer Community
url: https://meraki.io/community
x-provenance:
method: harvested
authored_by: Cisco Meraki
harvested_by: API Evangelist
harvested_on: '2026-08-19'
first_party: true
note: Published by Cisco. Retrieved unmodified except for this x-provenance block.
provider_published: true
derived_view: Per-first-tag view of the source document, tag 'Policies'. Operations and schemas are the provider's, unmodified.
x-evidence:
- type: source
url: https://github.com/meraki/secure-connect-openapi/blob/main/secure_connect_oas_beta.json
- type: raw
url: https://raw.githubusercontent.com/meraki/secure-connect-openapi/main/secure_connect_oas_beta.json
servers:
- url: https://api.meraki.com/{basePath}
variables:
basePath:
default: api/secureConnect/v1
security:
- meraki_api_key: []
- bearerAuth: []
tags:
- name: Policies
paths:
/organizations/{organizationId}/policy/destinationLists:
get:
tags:
- Policies
- Destination Lists
- Umbrella
description: Get the destination lists in your organization.
summary: Get Destination Lists
operationId: getDestinationLists
parameters:
- name: organizationId
in: path
description: Organization ID associated with this resource.
required: true
schema:
type: integer
- name: page
in: query
description: The number of a page in the collection.
required: false
schema:
default: 1
type: integer
format: int32
minimum: 1
example: 4
- name: limit
in: query
description: The number of records in the collection to return on the page.
required: false
schema:
default: 100
type: integer
format: int32
minimum: 1
maximum: 100
example: 50
security:
- meraki_api_key: []
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
description: The MIME content type of the response body.
example: application/json
Date:
schema:
type: string
pattern: ^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$
description: The timestamp of the response.
example: '2023-03-14T18:34:25Z'
content:
application/json:
schema:
type: object
description: The status, metadata, and properties of the destination lists.
required:
- status
- meta
- data
properties:
status:
type: object
required:
- code
- text
description: The status information for the response.
properties:
code:
type: integer
description: The HTTP status code of the response.
example: 200
text:
type: string
description: The HTTP message that describes the response.
example: OK
example:
code: 200
text: OK
meta:
type: object
description: The pagination information for the response.
properties:
page:
type: integer
description: The number of the page in the collection.
example: 50
limit:
type: integer
description: The maximum number of items that are returned on the page.
example: 10
total:
type: integer
description: The total number of items in the collection.
example: 20
data:
type: array
description: The list of destination lists.
items:
type: object
required:
- id
- organizationId
- access
- isGlobal
- name
- thirdpartyCategoryId
- createdAt
- modifiedAt
- isMspDefault
- markedForDeletion
properties:
id:
type: integer
example: 1234567
description: The unique ID of the destination list.
organizationId:
type: integer
example: 2345678
description: The organization ID.
access:
type: string
enum:
- allow
- block
example: allow
description: The type of access for the destination list.
isGlobal:
type: boolean
example: false
description: 'Specifies whether the destination list is a global destination list.
There is only one default `allow` destination list and one default `block` destination list for
an organization.'
name:
type: string
example: Global Allow list
description: The name of the destination list.
thirdpartyCategoryId:
type: integer
example: 1
description: The third-party category ID of the destination list.
createdAt:
type: integer
example: 1490206249
description: The date and time when the destination list was created.
modifiedAt:
type: integer
example: 1520476127
description: The date and time when the destination list was modified.
isMspDefault:
type: boolean
description: Specifies whether MSP is the default.
example: false
markedForDeletion:
type: boolean
example: false
description: Specifies whether the destination list is marked for deletion.
bundleTypeId:
type: integer
default: 1
enum:
- 1
- 2
- 4
example: 4
description: 'The type of the destination list in the policy.
Set `1` for DNS, `2` for web, and `4` for SAML Bypass.
If the field is not specified, the default value is `1`.'
meta:
type: object
description: The total number of each type of destination in the destination list. The fields in
the `meta` object are optional.
properties:
destinationCount:
type: integer
example: 5
description: The total number of destinations in a destination list.
domainCount:
type: integer
example: 5
description: 'The total number of domains in a destination list.
Domains are part of the total number of destinations in a destination list.'
urlCount:
type: integer
example: 0
description: 'The total number of URLs in a destination list.
Urls are part of the total number of destinations in a destination list.'
ipv4Count:
type: integer
example: 0
description: 'The total number of IP addresses in a destination list.
IP addresses are part of the total number of destinations in a destination list.'
applicationCount:
type: integer
example: 0
description: 'The total number of applications in a destination list.
Applications are part of the total number of destinations in a destination list.'
example:
domainCount: 1
urlCount: 0
ipv4Count: 1
destinationCount: 2
applicationCount: 0
example:
id: 1234567
organizationId: 2345678
access: allow
isGlobal: true
name: Global Allow List
thirdpartyCategoryId: 0
createdAt: 1490206249
modifiedAt: 1520476127
isMspDefault: false
markedForDeletion: false
bundleTypeId: 2
meta:
destinationCount: 5
domainCount: 5
urlCount: 0
ipv4Count: 0
applicationCount: 0
example:
status:
code: 200
text: OK
meta:
page: 1
limit: 100
total: 100
data:
- id: 1234567
organizationId: 2345678
access: allow
isGlobal: true
name: Global Allow List
thirdpartyCategoryId: 0
createdAt: 1490206249
modifiedAt: 1520476127
isMspDefault: false
markedForDeletion: false
bundleTypeId: 2
meta:
destinationCount: 5
domainCount: 5
urlCount: 0
ipv4Count: 0
applicationCount: 0
'400':
description: Bad Request
content:
application/json:
schema:
type: object
description: Bad Request
properties:
statusCode:
type: integer
example: 400
description: HTTP status code
error:
type: string
example: Bad Request
description: A brief description of the error
message:
type: string
example: Validation Error
txId:
type: string
example: d479k9i2b723
'401':
description: Unauthorized
content:
application/json:
schema:
type: object
description: Unauthorized
properties:
statusCode:
type: integer
example: 401
description: HTTP status code
error:
type: string
example: Unauthorized
description: The authorization header is missing or the token is unauthorized.
txId:
type: string
example: a478k9i2b723
'403':
description: Forbidden
content:
application/json:
schema:
type: object
description: Forbidden
properties:
statusCode:
type: integer
example: 403
description: HTTP status code
error:
type: string
example: Forbidden
description: The token is invalid.
txId:
type: string
example: a478k9i2b723
'404':
description: Not Found
content:
application/json:
schema:
type: object
description: Not Found
properties:
statusCode:
type: integer
example: 404
description: HTTP status code
error:
type: string
example: Not Found
description: A resource specified in the URL was not found.
txId:
type: string
example: a478k9i2b723
'500':
description: Internal Server Error
content:
application/json:
schema:
type: object
description: Internal Server Error
properties:
statusCode:
type: integer
example: 500
description: HTTP status code
error:
type: string
example: Internal Server Error
description: The server can not process the request.
message:
type: string
example: An internal server error occurred
txId:
type: string
example: l477k9i2b893
post:
tags:
- Policies
- Destination Lists
- Umbrella
description: Create a destination list in your organization.
summary: Create Destination List
operationId: createDestinationList
security:
- meraki_api_key: []
requestBody:
description: 'Provide destination information and an optional array of destination objects.
Accepts no more than 500 destination objects.
If you make an API request on the POST operation that adds a URL on a high-volume domain to a destination list,
the operation may succeed (`HTTP/200 OK`).
However, the server returns an error message (`HTTP/400 Bad Request`) that indicates that the destination is on
a high-volume domain.
**Note:** Umbrella does not add URLs that are on high-volume domains to destination lists. Instead, we recommend
that you add the domain only.'
content:
application/json:
schema:
type: object
required:
- access
- isGlobal
- name
description: The properties of the destination list.
properties:
access:
type: string
enum:
- allow
- block
example: allow
description: The type of access for the destination list.
isGlobal:
type: boolean
example: false
description: 'Specifies whether the destination list is a global destination list.
There is only one default `allow` destination list and one default `block` destination list for an organization.'
name:
type: string
example: Global Allow list
description: The name of the destination list.
bundleTypeId:
type: integer
default: 1
enum:
- 1
- 2
- 4
example: 4
description: 'The type of the destination list in the policy.
Set `1` for DNS, `2` for web, and `4` for SAML Bypass.
If the field is not specified, the default value is `1`.'
destinations:
type: array
description: The list of destinations.
maxItems: 500
items:
type: object
description: The properties of the destination.
properties:
destination:
type: string
example: cisco.com
description: A domain, URL, or IP.
type:
type: string
enum:
- domain
- url
- ipv4
example: domain
description: The type of the destination.
comment:
type: string
description: The comment about the destination.
example: Add new destination list
example:
access: allow
isGlobal: false
name: The name of the destination list.
example:
access: allow
isGlobal: false
name: New Destination List
required: true
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
description: The MIME content type of the response body.
example: application/json
Date:
schema:
type: string
pattern: ^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$
description: The timestamp of the response.
example: '2023-03-14T18:34:25Z'
content:
application/json:
schema:
type: object
description: The status and properties of the destination lists.
required:
- status
- data
properties:
status:
type: object
required:
- code
- text
description: The status information for the response.
properties:
code:
type: integer
description: The HTTP status code of the response.
example: 200
text:
type: string
description: The HTTP message that describes the response.
example: OK
example:
code: 200
text: OK
data:
type: object
required:
- id
- organizationId
- access
- isGlobal
- name
- thirdpartyCategoryId
- createdAt
- modifiedAt
- isMspDefault
- markedForDeletion
properties:
id:
type: integer
example: 1234567
description: The unique ID of the destination list.
organizationId:
type: integer
example: 2345678
description: The organization ID.
access:
type: string
enum:
- allow
- block
example: allow
description: The type of access for the destination list.
isGlobal:
type: boolean
example: false
description: 'Specifies whether the destination list is a global destination list.
There is only one default `allow` destination list and one default `block` destination list for
an organization.'
name:
type: string
example: Global Allow list
description: The name of the destination list.
thirdpartyCategoryId:
type: integer
example: 1
description: The third-party category ID of the destination list.
createdAt:
type: integer
example: 1490206249
description: The date and time when the destination list was created.
modifiedAt:
type: integer
example: 1520476127
description: The date and time when the destination list was modified.
isMspDefault:
type: boolean
description: Specifies whether MSP is the default.
example: false
markedForDeletion:
type: boolean
example: false
description: Specifies whether the destination list is marked for deletion.
bundleTypeId:
type: integer
default: 1
enum:
- 1
- 2
- 4
example: 4
description: 'The type of the destination list in the policy.
Set `1` for DNS, `2` for web, and `4` for SAML Bypass.
If the field is not specified, the default value is `1`.'
meta:
type: object
description: The total number of each type of destination in the destination list. The fields in the
`meta` object are optional.
properties:
destinationCount:
type: integer
example: 5
description: The total number of destinations in a destination list.
domainCount:
type: integer
example: 5
description: 'The total number of domains in a destination list.
Domains are part of the total number of destinations in a destination list.'
urlCount:
type: integer
example: 0
description: 'The total number of URLs in a destination list.
Urls are part of the total number of destinations in a destination list.'
ipv4Count:
type: integer
example: 0
description: 'The total number of IP addresses in a destination list.
IP addresses are part of the total number of destinations in a destination list.'
applicationCount:
type: integer
example: 0
description: 'The total number of applications in a destination list.
Applications are part of the total number of destinations in a destination list.'
example:
domainCount: 1
urlCount: 0
ipv4Count: 1
destinationCount: 2
applicationCount: 0
example:
id: 1234567
organizationId: 2345678
access: allow
isGlobal: true
name: Global Allow List
thirdpartyCategoryId: 0
createdAt: 1490206249
modifiedAt: 1520476127
isMspDefault: false
markedForDeletion: false
bundleTypeId: 2
meta:
destinationCount: 5
domainCount: 5
urlCount: 0
ipv4Count: 0
applicationCount: 0
example:
status:
code: 200
text: OK
data:
id: 2477857
organizationId: 22429759
access: allow
isGlobal: false
name: New Destination List
thirdpartyCategoryId: 0
createdAt: 1532628019
modifiedAt: 1532628019
isMspDefault: false
markedForDeletion: false
bundleTypeId: 2
meta:
destinationCount: 1
'400':
description: Bad Request
content:
application/json:
schema:
type: object
description: Bad Request
properties:
statusCode:
type: integer
example: 400
description: HTTP status code
error:
type: string
example: Bad Request
description: A brief description of the error
message:
type: string
example: Validation Error
txId:
type: string
example: d479k9i2b723
'401':
description: Unauthorized
content:
application/json:
schema:
type: object
description: Unauthorized
properties:
statusCode:
type: integer
example: 401
description: HTTP status code
error:
type: string
example: Unauthorized
description: The authorization header is missing or the token is unauthorized.
txId:
type: string
example: a478k9i2b723
'403':
description: Forbidden
content:
application/json:
schema:
type: object
description: Forbidden
properties:
statusCode:
type: integer
example: 403
description: HTTP status code
error:
type: string
example: Forbidden
description: The token is invalid.
txId:
type: string
example: a478k9i2b723
'404':
description: Not Found
content:
application/json:
schema:
type: object
description: Not Found
properties:
statusCode:
type: integer
example: 404
description: HTTP status code
error:
type: string
example: Not Found
description: A resource specified in the URL was not found.
txId:
type: string
example: a478k9i2b723
'500':
description: Internal Server Error
content:
application/json:
schema:
type: object
description: Internal Server Error
properties:
statusCode:
type: integer
example: 500
description: HTTP status code
error:
type: string
example: Internal Server Error
description: The server can not process the request.
message:
type: string
example: An internal server error occurred
txId:
type: string
example: l477k9i2b893
parameters:
- name: organizationId
in: path
description: Organization ID associated with this resource.
required: true
schema:
type: integer
/organizations/{organizationId}/policy/destinationLists/{destinationListId}:
patch:
tags:
- Policies
- Destination Lists
- Umbrella
description: Update a destination list in your organization.
summary: Update Destination List
operationId: updateDestinationLists
security:
- meraki_api_key: []
parameters:
- name: organizationId
in: path
description: Organization ID associated with this resource.
required: true
schema:
type: integer
- name: destinationListId
in: path
schema:
type: integer
description: The unique ID of the destination list.
required: true
example: 245
requestBody:
description: Update a destination list.
required: true
content:
application/json:
schema:
type: object
description: Update the name of the destination list.
required:
- name
properties:
name:
type: string
example: Global Allow list
description: The name of the destination list.
example:
name: Updated name of destination list
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
description: The MIME content type of the response body.
example: application/json
Date:
schema:
type: string
pattern: ^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$
description: The timestamp of the response.
example: '2023-03-14T18:34:25Z'
content:
application/json:
schema:
type: object
description: The status and properties of the destination lists.
required:
- status
- data
properties:
status:
type: object
# --- truncated at 32 KB (95 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/cisco-meraki/refs/heads/main/openapi/cisco-meraki-secure-connect-policies-api-openapi.yml