diff --git a/openapi/spec2.json b/openapi/spec2.json index 5a3f280..234ee47 100644 --- a/openapi/spec2.json +++ b/openapi/spec2.json @@ -1,9 +1,9 @@ { "swagger": "2.0", "info": { - "version": "1.51.1-beta.1", + "version": "1.51.1-beta.2", "title": "Meraki Dashboard API", - "description": "The Cisco Meraki Dashboard API is a modern REST API based on the OpenAPI specification.\n\n> Date: 23 October, 2024\n>\n> [Recent Updates](https://meraki.io/whats-new/)\n\n---\n\n[API Documentation](https://meraki.io/api)\n\n[Community Support](https://meraki.io/community)\n\n[Meraki Homepage](https://www.meraki.com)\n", + "description": "The Cisco Meraki Dashboard API is a modern REST API based on the OpenAPI specification.\n\n> Date: 30 October, 2024\n>\n> [Recent Updates](https://meraki.io/whats-new/)\n\n---\n\n[API Documentation](https://meraki.io/api)\n\n[Community Support](https://meraki.io/community)\n\n[Meraki Homepage](https://www.meraki.com)\n", "contact": { "name": "Meraki Developer Community", "url": "https://meraki.io/community" @@ -386,7 +386,8 @@ "active", "canceled", "expired", - "inactive" + "inactive", + "out_of_compliance" ] }, "name": "statuses", @@ -446,7 +447,8 @@ "active", "canceled", "expired", - "inactive" + "inactive", + "out_of_compliance" ], "description": "Subscription status" }, @@ -736,7 +738,8 @@ "active", "canceled", "expired", - "inactive" + "inactive", + "out_of_compliance" ], "description": "Subscription status" }, @@ -994,7 +997,8 @@ "active", "canceled", "expired", - "inactive" + "inactive", + "out_of_compliance" ], "description": "Subscription status" }, @@ -16923,11 +16927,11 @@ "items": { "type": "object", "properties": { - "id": { + "doorLockId": { "type": "string", "description": "The Door Lock ID" }, - "displayName": { + "name": { "type": "string", "description": "The Door lock name" }, @@ -17010,8 +17014,8 @@ "enrollmentStartedAt": "complete", "doorLocks": [ { - "id": "1", - "displayName": "Door Lock 403", + "doorLockId": "1", + "name": "Door Lock 123", "shortId": "ABE123", "lqi": "1", "rssi": "1", @@ -29370,10 +29374,7 @@ "192.168.1.0/24", "192.168.128.0/24" ], - "vpnNatSubnet": "192.168.1.0/24", - "vpnNat": { - "enabled": true - } + "vpnNatSubnet": "192.168.1.0/24" } } } @@ -100734,6 +100735,1733 @@ ] } }, + "/organizations/{organizationId}/appliance/dns/local/profiles": { + "get": { + "description": "Fetch the local DNS profiles used in the organization", + "operationId": "getOrganizationApplianceDnsLocalProfiles", + "parameters": [ + { + "name": "organizationId", + "in": "path", + "description": "Organization ID", + "type": "string", + "required": true + }, + { + "type": "array", + "items": { + "type": "string" + }, + "name": "profileIds", + "in": "query", + "description": "Optional parameter to filter the results by profile IDs" + } + ], + "responses": { + "200": { + "description": "Successful operation", + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "profileId": { + "type": "string", + "description": "Profile ID" + }, + "name": { + "type": "string", + "description": "Name of profile" + } + } + } + }, + "examples": { + "application/json": [ + { + "profileId": "123456", + "name": "Default profile" + } + ] + } + } + }, + "summary": "Fetch the local DNS profiles used in the organization", + "tags": [ + "appliance", + "configure", + "dns", + "local", + "profiles" + ], + "x-release-stage": "beta" + }, + "post": { + "description": "Create a new local DNS profile", + "operationId": "createOrganizationApplianceDnsLocalProfile", + "parameters": [ + { + "name": "organizationId", + "in": "path", + "description": "Organization ID", + "type": "string", + "required": true + }, + { + "name": "createOrganizationApplianceDnsLocalProfile", + "in": "body", + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of profile" + } + }, + "example": { + "name": "Default profile" + }, + "required": [ + "name" + ] + }, + "required": true + } + ], + "responses": { + "201": { + "description": "Successful operation", + "schema": { + "type": "object", + "properties": { + "profileId": { + "type": "string", + "description": "Profile ID" + }, + "name": { + "type": "string", + "description": "Name of profile" + } + } + }, + "examples": { + "application/json": { + "profileId": "123456", + "name": "Default profile" + } + } + } + }, + "summary": "Create a new local DNS profile", + "tags": [ + "appliance", + "configure", + "dns", + "local", + "profiles" + ], + "x-release-stage": "beta" + } + }, + "/organizations/{organizationId}/appliance/dns/local/profiles/assignments": { + "get": { + "description": "Fetch the local DNS profile assignments in the organization", + "operationId": "getOrganizationApplianceDnsLocalProfilesAssignments", + "parameters": [ + { + "name": "organizationId", + "in": "path", + "description": "Organization ID", + "type": "string", + "required": true + }, + { + "type": "array", + "items": { + "type": "string" + }, + "name": "profileIds", + "in": "query", + "description": "Optional parameter to filter the results by profile IDs" + }, + { + "type": "array", + "items": { + "type": "string" + }, + "name": "networkIds", + "in": "query", + "description": "Optional parameter to filter the results by network IDs" + } + ], + "responses": { + "200": { + "description": "Successful operation", + "schema": { + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "type": "object", + "properties": { + "assignmentId": { + "type": "string", + "description": "ID of the assignment" + }, + "network": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "ID of the network" + } + }, + "description": "The network attached to the profile" + }, + "profile": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "ID of the profile" + } + }, + "description": "The profile the network is attached to" + } + } + }, + "description": "List of local DNS profile assignment" + }, + "meta": { + "type": "object", + "properties": { + "counts": { + "type": "object", + "properties": { + "items": { + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "The total number of items in the dataset" + }, + "remaining": { + "type": "integer", + "description": "The number of items in the dataset that are available on subsequent pages" + } + }, + "description": "Counts relating to the paginated items" + } + }, + "description": "Counts relating to the paginated dataset" + } + }, + "description": "Metadata relevant to the paginated dataset" + } + } + }, + "examples": { + "application/json": { + "items": [ + { + "assignmentId": "123456", + "network": { + "id": "N_123456" + }, + "profile": { + "id": "1234" + } + } + ], + "meta": { + "counts": { + "items": { + "total": 10, + "remaining": 0 + } + } + } + } + } + } + }, + "summary": "Fetch the local DNS profile assignments in the organization", + "tags": [ + "appliance", + "configure", + "dns", + "local", + "profiles", + "assignments" + ], + "x-release-stage": "beta" + } + }, + "/organizations/{organizationId}/appliance/dns/local/profiles/assignments/bulkCreate": { + "post": { + "description": "Assign the local DNS profile to networks in the organization", + "operationId": "createOrganizationApplianceDnsLocalProfilesAssignmentsBulkCreate", + "parameters": [ + { + "name": "organizationId", + "in": "path", + "description": "Organization ID", + "type": "string", + "required": true + }, + { + "name": "createOrganizationApplianceDnsLocalProfilesAssignmentsBulkCreate", + "in": "body", + "schema": { + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "type": "object", + "properties": { + "network": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "ID of the network" + } + }, + "description": "The network attached to the profile" + }, + "profile": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "ID of the profile" + } + }, + "description": "The profile the network is attached to" + } + } + }, + "description": "List containing the network ID and Profile ID" + } + }, + "example": { + "items": [ + { + "network": { + "id": "N_123456" + }, + "profile": { + "id": "1234" + } + } + ] + }, + "required": [ + "items" + ] + }, + "required": true + } + ], + "responses": { + "200": { + "description": "Successful operation", + "schema": { + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "type": "object", + "properties": { + "assignmentId": { + "type": "string", + "description": "ID of the assignment" + }, + "network": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "ID of the network" + } + }, + "description": "The network attached to the profile" + }, + "profile": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "ID of the profile" + } + }, + "description": "The profile the network is attached to" + } + } + }, + "description": "List of local DNS profile assignment" + } + } + }, + "examples": { + "application/json": { + "items": [ + { + "assignmentId": "123456", + "network": { + "id": "N_123456" + }, + "profile": { + "id": "1234" + } + } + ] + } + } + } + }, + "summary": "Assign the local DNS profile to networks in the organization", + "tags": [ + "appliance", + "configure", + "dns", + "local", + "profiles", + "assignments", + "bulkCreate" + ], + "x-release-stage": "beta" + } + }, + "/organizations/{organizationId}/appliance/dns/local/profiles/assignments/bulkDelete": { + "post": { + "description": "Unassign the local DNS profile to networks in the organization", + "operationId": "createOrganizationApplianceDnsLocalProfilesAssignmentsBulkDelete", + "parameters": [ + { + "name": "organizationId", + "in": "path", + "description": "Organization ID", + "type": "string", + "required": true + }, + { + "name": "createOrganizationApplianceDnsLocalProfilesAssignmentsBulkDelete", + "in": "body", + "schema": { + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "type": "object", + "properties": { + "assignmentId": { + "type": "string", + "description": "ID of the assignment" + } + } + }, + "description": "List containing the assignment ID" + } + }, + "example": { + "items": [ + { + "assignmentId": "123456" + } + ] + }, + "required": [ + "items" + ] + }, + "required": true + } + ], + "responses": { + "200": { + "description": "Successful operation", + "schema": { + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "type": "object", + "properties": { + "assignmentId": { + "type": "string", + "description": "ID of the assignment" + }, + "network": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "ID of the network" + } + }, + "description": "The network attached to the profile" + }, + "profile": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "ID of the profile" + } + }, + "description": "The profile the network is attached to" + } + } + }, + "description": "List of local DNS profile assignment" + } + } + }, + "examples": { + "application/json": { + "items": [ + { + "assignmentId": "123456", + "network": { + "id": "N_123456" + }, + "profile": { + "id": "1234" + } + } + ] + } + } + } + }, + "summary": "Unassign the local DNS profile to networks in the organization", + "tags": [ + "appliance", + "configure", + "dns", + "local", + "profiles", + "assignments", + "bulkDelete" + ], + "x-release-stage": "beta" + } + }, + "/organizations/{organizationId}/appliance/dns/local/profiles/{profileId}": { + "put": { + "description": "Update a local DNS profile", + "operationId": "updateOrganizationApplianceDnsLocalProfile", + "parameters": [ + { + "name": "organizationId", + "in": "path", + "description": "Organization ID", + "type": "string", + "required": true + }, + { + "name": "profileId", + "in": "path", + "description": "Profile ID", + "type": "string", + "required": true + }, + { + "name": "updateOrganizationApplianceDnsLocalProfile", + "in": "body", + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of profile" + } + }, + "example": { + "name": "Default profile" + }, + "required": [ + "name" + ] + }, + "required": true + } + ], + "responses": { + "200": { + "description": "Successful operation", + "schema": { + "type": "object", + "properties": { + "profileId": { + "type": "string", + "description": "Profile ID" + }, + "name": { + "type": "string", + "description": "Name of profile" + } + } + }, + "examples": { + "application/json": { + "profileId": "123456", + "name": "Default profile" + } + } + } + }, + "summary": "Update a local DNS profile", + "tags": [ + "appliance", + "configure", + "dns", + "local", + "profiles" + ], + "x-release-stage": "beta" + }, + "delete": { + "description": "Deletes a local DNS profile", + "operationId": "deleteOrganizationApplianceDnsLocalProfile", + "parameters": [ + { + "name": "organizationId", + "in": "path", + "description": "Organization ID", + "type": "string", + "required": true + }, + { + "name": "profileId", + "in": "path", + "description": "Profile ID", + "type": "string", + "required": true + } + ], + "responses": { + "204": { + "description": "Successful operation" + } + }, + "summary": "Deletes a local DNS profile", + "tags": [ + "appliance", + "configure", + "dns", + "local", + "profiles" + ], + "x-release-stage": "beta" + } + }, + "/organizations/{organizationId}/appliance/dns/local/records": { + "get": { + "description": "Fetch the DNS records used in local DNS profiles", + "operationId": "getOrganizationApplianceDnsLocalRecords", + "parameters": [ + { + "name": "organizationId", + "in": "path", + "description": "Organization ID", + "type": "string", + "required": true + }, + { + "type": "array", + "items": { + "type": "string" + }, + "name": "profileIds", + "in": "query", + "description": "Optional parameter to filter the results by profile IDs" + } + ], + "responses": { + "200": { + "description": "Successful operation", + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "recordId": { + "type": "string", + "description": "Record ID" + }, + "hostname": { + "type": "string", + "description": "Hostname for the DNS record" + }, + "address": { + "type": "string", + "description": "IP for the DNS record" + }, + "profile": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Profile ID" + } + }, + "description": "The profile the DNS record is associated with" + } + } + } + }, + "examples": { + "application/json": [ + { + "recordId": "12345", + "hostname": "www.test.com", + "address": "10.1.1.0", + "profile": { + "id": "1" + } + } + ] + } + } + }, + "summary": "Fetch the DNS records used in local DNS profiles", + "tags": [ + "appliance", + "configure", + "dns", + "local", + "records" + ], + "x-release-stage": "beta" + }, + "post": { + "description": "Create a new local DNS record", + "operationId": "createOrganizationApplianceDnsLocalRecord", + "parameters": [ + { + "name": "organizationId", + "in": "path", + "description": "Organization ID", + "type": "string", + "required": true + }, + { + "name": "createOrganizationApplianceDnsLocalRecord", + "in": "body", + "schema": { + "type": "object", + "properties": { + "hostname": { + "type": "string", + "description": "Hostname for the DNS record" + }, + "address": { + "type": "string", + "description": "IP for the DNS record" + }, + "profile": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Profile ID" + } + }, + "description": "The profile the DNS record is associated with" + } + }, + "example": { + "hostname": "www.test.com", + "address": "10.1.1.0", + "profile": { + "id": "1" + } + }, + "required": [ + "hostname", + "address", + "profile" + ] + }, + "required": true + } + ], + "responses": { + "201": { + "description": "Successful operation", + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "recordId": { + "type": "string", + "description": "Record ID" + }, + "hostname": { + "type": "string", + "description": "Hostname for the DNS record" + }, + "address": { + "type": "string", + "description": "IP for the DNS record" + }, + "profile": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Profile ID" + } + }, + "description": "The profile the DNS record is associated with" + } + } + } + }, + "examples": { + "application/json": [ + { + "recordId": "12345", + "hostname": "www.test.com", + "address": "10.1.1.0", + "profile": { + "id": "1" + } + } + ] + } + } + }, + "summary": "Create a new local DNS record", + "tags": [ + "appliance", + "configure", + "dns", + "local", + "records" + ], + "x-release-stage": "beta" + } + }, + "/organizations/{organizationId}/appliance/dns/local/records/{recordId}": { + "put": { + "description": "Updates a local DNS record", + "operationId": "updateOrganizationApplianceDnsLocalRecord", + "parameters": [ + { + "name": "organizationId", + "in": "path", + "description": "Organization ID", + "type": "string", + "required": true + }, + { + "name": "recordId", + "in": "path", + "description": "Record ID", + "type": "string", + "required": true + }, + { + "name": "updateOrganizationApplianceDnsLocalRecord", + "in": "body", + "schema": { + "type": "object", + "properties": { + "hostname": { + "type": "string", + "description": "Hostname for the DNS record" + }, + "address": { + "type": "string", + "description": "IP for the DNS record" + }, + "profile": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Profile ID" + } + }, + "description": "The profile the DNS record is associated with" + } + }, + "example": { + "hostname": "www.test.com", + "address": "10.1.1.0", + "profile": { + "id": "1" + } + } + } + } + ], + "responses": { + "200": { + "description": "Successful operation", + "schema": { + "type": "object", + "properties": { + "recordId": { + "type": "string", + "description": "Record ID" + }, + "hostname": { + "type": "string", + "description": "Hostname for the DNS record" + }, + "address": { + "type": "string", + "description": "IP for the DNS record" + }, + "profile": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Profile ID" + } + }, + "description": "The profile the DNS record is associated with" + } + } + }, + "examples": { + "application/json": { + "recordId": "12345", + "hostname": "www.test.com", + "address": "10.1.1.0", + "profile": { + "id": "1" + } + } + } + } + }, + "summary": "Updates a local DNS record", + "tags": [ + "appliance", + "configure", + "dns", + "local", + "records" + ], + "x-release-stage": "beta" + }, + "delete": { + "description": "Deletes a local DNS record", + "operationId": "deleteOrganizationApplianceDnsLocalRecord", + "parameters": [ + { + "name": "organizationId", + "in": "path", + "description": "Organization ID", + "type": "string", + "required": true + }, + { + "name": "recordId", + "in": "path", + "description": "Record ID", + "type": "string", + "required": true + } + ], + "responses": { + "204": { + "description": "Successful operation" + } + }, + "summary": "Deletes a local DNS record", + "tags": [ + "appliance", + "configure", + "dns", + "local", + "records" + ], + "x-release-stage": "beta" + } + }, + "/organizations/{organizationId}/appliance/dns/split/profiles": { + "get": { + "description": "Fetch the split DNS profiles used in the organization", + "operationId": "getOrganizationApplianceDnsSplitProfiles", + "parameters": [ + { + "name": "organizationId", + "in": "path", + "description": "Organization ID", + "type": "string", + "required": true + }, + { + "type": "array", + "items": { + "type": "string" + }, + "name": "profileIds", + "in": "query", + "description": "Optional parameter to filter the results by profile IDs" + } + ], + "responses": { + "200": { + "description": "Successful operation", + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "profileId": { + "type": "string", + "description": "Profile ID" + }, + "name": { + "type": "string", + "description": "Name of profile" + }, + "hostnames": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The hostnames that should be redirected to the DNS server" + }, + "nameservers": { + "type": "object", + "properties": { + "addresses": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The DNS addresses the hostnames should resolve to" + } + }, + "description": "Contains the DNS addresses the hostnames should resolve to" + } + } + } + }, + "examples": { + "application/json": [ + { + "profileId": "123456", + "name": "Default profile", + "hostnames": [ + "*.test1.com", + "*.test2.com" + ], + "nameservers": { + "addresses": [ + "12.1.10.1" + ] + } + } + ] + } + } + }, + "summary": "Fetch the split DNS profiles used in the organization", + "tags": [ + "appliance", + "configure", + "dns", + "split", + "profiles" + ], + "x-release-stage": "beta" + }, + "post": { + "description": "Create a new split DNS profile", + "operationId": "createOrganizationApplianceDnsSplitProfile", + "parameters": [ + { + "name": "organizationId", + "in": "path", + "description": "Organization ID", + "type": "string", + "required": true + }, + { + "name": "createOrganizationApplianceDnsSplitProfile", + "in": "body", + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of profile" + }, + "hostnames": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The hostnames that should be redirected to the DNS server" + }, + "nameservers": { + "type": "object", + "properties": { + "addresses": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The DNS addresses the hostnames should resolve to" + } + }, + "description": "Contains the DNS addresses the hostnames should resolve to" + } + }, + "example": { + "name": "Default profile", + "hostnames": [ + "*.test1.com", + "*.test2.com" + ], + "nameservers": { + "addresses": [ + "12.1.10.1" + ] + } + }, + "required": [ + "name", + "hostnames", + "nameservers" + ] + }, + "required": true + } + ], + "responses": { + "201": { + "description": "Successful operation", + "schema": { + "type": "object", + "properties": { + "profileId": { + "type": "string", + "description": "Profile ID" + }, + "name": { + "type": "string", + "description": "Name of profile" + }, + "hostnames": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The hostnames that should be redirected to the DNS server" + }, + "nameservers": { + "type": "object", + "properties": { + "addresses": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The DNS addresses the hostnames should resolve to" + } + }, + "description": "Contains the DNS addresses the hostnames should resolve to" + } + } + }, + "examples": { + "application/json": { + "profileId": "123456", + "name": "Default profile", + "hostnames": [ + "*.test1.com", + "*.test2.com" + ], + "nameservers": { + "addresses": [ + "12.1.10.1" + ] + } + } + } + } + }, + "summary": "Create a new split DNS profile", + "tags": [ + "appliance", + "configure", + "dns", + "split", + "profiles" + ], + "x-release-stage": "beta" + } + }, + "/organizations/{organizationId}/appliance/dns/split/profiles/assignments": { + "get": { + "description": "Fetch the split DNS profile assignments in the organization", + "operationId": "getOrganizationApplianceDnsSplitProfilesAssignments", + "parameters": [ + { + "name": "organizationId", + "in": "path", + "description": "Organization ID", + "type": "string", + "required": true + }, + { + "type": "array", + "items": { + "type": "string" + }, + "name": "profileIds", + "in": "query", + "description": "Optional parameter to filter the results by profile IDs" + }, + { + "type": "array", + "items": { + "type": "string" + }, + "name": "networkIds", + "in": "query", + "description": "Optional parameter to filter the results by network IDs" + } + ], + "responses": { + "200": { + "description": "Successful operation", + "schema": { + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "ID of the assignment" + }, + "network": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "ID of the network" + } + }, + "description": "The network attached to the profile" + }, + "profile": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "ID of the profile" + } + }, + "description": "The profile the network is attached to" + } + } + }, + "description": "List of split DNS profile assignment" + }, + "meta": { + "type": "object", + "properties": { + "counts": { + "type": "object", + "properties": { + "items": { + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "The total number of items in the dataset" + }, + "remaining": { + "type": "integer", + "description": "The number of items in the dataset that are available on subsequent pages" + } + }, + "description": "Counts relating to the paginated items" + } + }, + "description": "Counts relating to the paginated dataset" + } + }, + "description": "Metadata relevant to the paginated dataset" + } + } + }, + "examples": { + "application/json": { + "items": [ + { + "id": "123456", + "network": { + "id": "N_123456" + }, + "profile": { + "id": "1234" + } + } + ], + "meta": { + "counts": { + "items": { + "total": 10, + "remaining": 0 + } + } + } + } + } + } + }, + "summary": "Fetch the split DNS profile assignments in the organization", + "tags": [ + "appliance", + "configure", + "dns", + "split", + "profiles", + "assignments" + ], + "x-release-stage": "beta" + } + }, + "/organizations/{organizationId}/appliance/dns/split/profiles/assignments/bulkCreate": { + "post": { + "description": "Assign the split DNS profile to networks in the organization", + "operationId": "createOrganizationApplianceDnsSplitProfilesAssignmentsBulkCreate", + "parameters": [ + { + "name": "organizationId", + "in": "path", + "description": "Organization ID", + "type": "string", + "required": true + }, + { + "name": "createOrganizationApplianceDnsSplitProfilesAssignmentsBulkCreate", + "in": "body", + "schema": { + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "type": "object", + "properties": { + "network": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "ID of the network" + } + }, + "description": "The network attached to the profile" + }, + "profile": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "ID of the profile" + } + }, + "description": "The profile the network is attached to" + } + } + }, + "description": "List containing the network ID and Profile ID" + } + }, + "example": { + "items": [ + { + "network": { + "id": "N_123456" + }, + "profile": { + "id": "1234" + } + } + ] + }, + "required": [ + "items" + ] + }, + "required": true + } + ], + "responses": { + "200": { + "description": "Successful operation", + "schema": { + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "ID of the assignment" + }, + "network": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "ID of the network" + } + }, + "description": "The network attached to the profile" + }, + "profile": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "ID of the profile" + } + }, + "description": "The profile the network is attached to" + } + } + }, + "description": "List of split DNS profile assignment" + } + } + }, + "examples": { + "application/json": { + "items": [ + { + "id": "123456", + "network": { + "id": "N_123456" + }, + "profile": { + "id": "1234" + } + } + ] + } + } + } + }, + "summary": "Assign the split DNS profile to networks in the organization", + "tags": [ + "appliance", + "configure", + "dns", + "split", + "profiles", + "assignments", + "bulkCreate" + ], + "x-release-stage": "beta" + } + }, + "/organizations/{organizationId}/appliance/dns/split/profiles/assignments/bulkDelete": { + "post": { + "description": "Unassign the split DNS profile to networks in the organization", + "operationId": "createOrganizationApplianceDnsSplitProfilesAssignmentsBulkDelete", + "parameters": [ + { + "name": "organizationId", + "in": "path", + "description": "Organization ID", + "type": "string", + "required": true + }, + { + "name": "createOrganizationApplianceDnsSplitProfilesAssignmentsBulkDelete", + "in": "body", + "schema": { + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "ID of the assignment" + } + } + }, + "description": "List containing the assignment ID" + } + }, + "example": { + "items": [ + { + "id": "123456" + } + ] + }, + "required": [ + "items" + ] + }, + "required": true + } + ], + "responses": { + "200": { + "description": "Successful operation", + "schema": { + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "ID of the assignment" + }, + "network": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "ID of the network" + } + }, + "description": "The network attached to the profile" + }, + "profile": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "ID of the profile" + } + }, + "description": "The profile the network is attached to" + } + } + }, + "description": "List of split DNS profile assignment" + } + } + }, + "examples": { + "application/json": { + "items": [ + { + "id": "123456", + "network": { + "id": "N_123456" + }, + "profile": { + "id": "1234" + } + } + ] + } + } + } + }, + "summary": "Unassign the split DNS profile to networks in the organization", + "tags": [ + "appliance", + "configure", + "dns", + "split", + "profiles", + "assignments", + "bulkDelete" + ], + "x-release-stage": "beta" + } + }, + "/organizations/{organizationId}/appliance/dns/split/profiles/{profileId}": { + "put": { + "description": "Update a split DNS profile", + "operationId": "updateOrganizationApplianceDnsSplitProfile", + "parameters": [ + { + "name": "organizationId", + "in": "path", + "description": "Organization ID", + "type": "string", + "required": true + }, + { + "name": "profileId", + "in": "path", + "description": "Profile ID", + "type": "string", + "required": true + }, + { + "name": "updateOrganizationApplianceDnsSplitProfile", + "in": "body", + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of profile" + }, + "hostnames": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The hostnames that should be redirected to the DNS server" + }, + "nameservers": { + "type": "object", + "properties": { + "addresses": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The DNS addresses the hostnames should resolve to" + } + }, + "description": "Contains the DNS addresses the hostnames should resolve to" + } + }, + "example": { + "name": "Default profile", + "hostnames": [ + "*.test1.com", + "*.test2.com" + ], + "nameservers": { + "addresses": [ + "12.1.10.1" + ] + } + } + } + } + ], + "responses": { + "200": { + "description": "Successful operation", + "schema": { + "type": "object", + "properties": { + "profileId": { + "type": "string", + "description": "Profile ID" + }, + "name": { + "type": "string", + "description": "Name of profile" + }, + "hostnames": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The hostnames that should be redirected to the DNS server" + }, + "nameservers": { + "type": "object", + "properties": { + "addresses": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The DNS addresses the hostnames should resolve to" + } + }, + "description": "Contains the DNS addresses the hostnames should resolve to" + } + } + }, + "examples": { + "application/json": { + "profileId": "123456", + "name": "Default profile", + "hostnames": [ + "*.test1.com", + "*.test2.com" + ], + "nameservers": { + "addresses": [ + "12.1.10.1" + ] + } + } + } + } + }, + "summary": "Update a split DNS profile", + "tags": [ + "appliance", + "configure", + "dns", + "split", + "profiles" + ], + "x-release-stage": "beta" + }, + "delete": { + "description": "Deletes a split DNS profile", + "operationId": "deleteOrganizationApplianceDnsSplitProfile", + "parameters": [ + { + "name": "organizationId", + "in": "path", + "description": "Organization ID", + "type": "string", + "required": true + }, + { + "name": "profileId", + "in": "path", + "description": "Profile ID", + "type": "string", + "required": true + } + ], + "responses": { + "204": { + "description": "Successful operation" + } + }, + "summary": "Deletes a split DNS profile", + "tags": [ + "appliance", + "configure", + "dns", + "split", + "profiles" + ], + "x-release-stage": "beta" + } + }, "/organizations/{organizationId}/appliance/sdwan/internetPolicies": { "get": { "description": "Get the SDWAN internet traffic preferences for an MX network", @@ -103281,8 +105009,10 @@ "crc_errors", "crc_errors_error", "crc_errors_warning", + "dashboard_config_generation_failure", "detected_country_mismatch", "device_access_issue", + "device_config_failure", "device_no_space", "device_reporting", "dfs_event_pattern", @@ -103484,6 +105214,7 @@ "Catalyst AP", "Catalyst Controller", "Catalyst Switch", + "MCG", "MG", "MR", "MS", @@ -103842,8 +105573,10 @@ "crc_errors", "crc_errors_error", "crc_errors_warning", + "dashboard_config_generation_failure", "detected_country_mismatch", "device_access_issue", + "device_config_failure", "device_no_space", "device_reporting", "dfs_event_pattern", @@ -104032,6 +105765,7 @@ "Catalyst AP", "Catalyst Controller", "Catalyst Switch", + "MCG", "MG", "MR", "MS", @@ -104241,8 +105975,10 @@ "crc_errors", "crc_errors_error", "crc_errors_warning", + "dashboard_config_generation_failure", "detected_country_mismatch", "device_access_issue", + "device_config_failure", "device_no_space", "device_reporting", "dfs_event_pattern", @@ -104431,6 +106167,7 @@ "Catalyst AP", "Catalyst Controller", "Catalyst Switch", + "MCG", "MG", "MR", "MS", @@ -104687,8 +106424,10 @@ "crc_errors", "crc_errors_error", "crc_errors_warning", + "dashboard_config_generation_failure", "detected_country_mismatch", "device_access_issue", + "device_config_failure", "device_no_space", "device_reporting", "dfs_event_pattern", @@ -104890,6 +106629,7 @@ "Catalyst AP", "Catalyst Controller", "Catalyst Switch", + "MCG", "MG", "MR", "MS", @@ -105091,8 +106831,10 @@ "crc_errors", "crc_errors_error", "crc_errors_warning", + "dashboard_config_generation_failure", "detected_country_mismatch", "device_access_issue", + "device_config_failure", "device_no_space", "device_reporting", "dfs_event_pattern", @@ -105282,6 +107024,7 @@ "Catalyst AP", "Catalyst Controller", "Catalyst Switch", + "MCG", "MG", "MR", "MS", @@ -115928,7 +117671,7 @@ }, "name": "productTypes", "in": "query", - "description": "Optional parameter to filter device availabilities by device product types. This filter uses multiple exact matches. Valid types are wireless, appliance, switch, camera, cellularGateway, sensor, and wirelessController" + "description": "Optional parameter to filter device availabilities by device product types. This filter uses multiple exact matches. Valid types are wireless, appliance, switch, camera, cellularGateway, sensor, wirelessController, and campusGateway" }, { "type": "array", @@ -117075,10 +118818,10 @@ "name": "file_name", "startTime": "2018-02-11T00:00:00.090210Z", "ports": "1, 2", - "status": "completed", + "status": "failed", "errorMessage": "Some error message", - "outputType": "pcap", - "captureSource": "scheduled", + "outputType": "upload_to_cloud", + "captureSource": "proactive", "captureReason": "capture reason", "fileSize": 1066, "duration": 60, @@ -117338,10 +119081,10 @@ "name": "file_name", "startTime": "2018-02-11T00:00:00.090210Z", "ports": "1, 2", - "status": "completed", + "status": "failed", "errorMessage": "Some error message", - "outputType": "pcap", - "captureSource": "scheduled", + "outputType": "upload_to_cloud", + "captureSource": "proactive", "captureReason": "capture reason", "fileSize": 1066, "duration": 60, @@ -117670,10 +119413,10 @@ "name": "file_name", "startTime": "2018-02-11T00:00:00.090210Z", "ports": "1, 2", - "status": "completed", + "status": "failed", "errorMessage": "Some error message", - "outputType": "pcap", - "captureSource": "scheduled", + "outputType": "upload_to_cloud", + "captureSource": "proactive", "captureReason": "capture reason", "fileSize": 1066, "duration": 60, @@ -128524,10 +130267,11 @@ "full", "guest-ambassador", "monitor-only", + "port-tags", "read-only", "ssid-admin" ], - "description": "The privilege of the SAML administrator on the network. Can be one of 'full', 'read-only', 'guest-ambassador', 'monitor-only' or 'ssid-admin'" + "description": "The privilege of the SAML administrator on the network. Can be one of 'full', 'read-only', 'guest-ambassador', 'monitor-only', 'ssid-admin' or 'port-tags'" } }, "required": [ @@ -128873,10 +130617,11 @@ "full", "guest-ambassador", "monitor-only", + "port-tags", "read-only", "ssid-admin" ], - "description": "The privilege of the SAML administrator on the network. Can be one of 'full', 'read-only', 'guest-ambassador', 'monitor-only' or 'ssid-admin'" + "description": "The privilege of the SAML administrator on the network. Can be one of 'full', 'read-only', 'guest-ambassador', 'monitor-only', 'ssid-admin' or 'port-tags'" } }, "required": [ @@ -140802,6 +142547,21 @@ "in": "query", "description": "Optional parameter to filter the result set by the included set of automation IDs" }, + { + "type": "array", + "items": { + "type": "string" + }, + "name": "networkIds", + "in": "query", + "description": "Optional parameter to filter the result set by the associated networks." + }, + { + "type": "string", + "name": "isOrganizationWide", + "in": "query", + "description": "Optional parameter to filter the result set by automations org-wide flag." + }, { "type": "string", "name": "searchQuery", @@ -140967,6 +142727,27 @@ } }, "description": "Count of assigned entities to a automation profile" + }, + "isOrganizationWide": { + "type": "boolean", + "description": "Whether or not this profile is a organization wide profile" + }, + "networks": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The ID of the network / associated node group" + }, + "name": { + "type": "string", + "description": "The name of network / associated node group" + } + } + }, + "description": "List of Associated Networks" } } }, @@ -141055,7 +142836,14 @@ "ports": 51, "networks": 1 } - } + }, + "isOrganizationWide": false, + "networks": [ + { + "id": "N_11865", + "name": "Wonderland-Dev" + } + ] } ], "meta": { @@ -141374,6 +143162,428 @@ } }, "description": "Count of assigned entities to a automation profile" + }, + "isOrganizationWide": { + "type": "boolean", + "description": "Whether or not this profile is a organization wide profile" + }, + "networks": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The ID of the network / associated node group" + }, + "name": { + "type": "string", + "description": "The name of network / associated node group" + } + } + }, + "description": "List of Associated Networks" + } + } + }, + "examples": { + "application/json": { + "id": "1284392014819", + "name": "Automation 1", + "description": "A full length description of the automation.", + "types": [ + "Custom", + "Built-in" + ], + "fallbackProfile": { + "id": "1284392014819", + "name": "Profile 1" + }, + "rules": [ + { + "priority": 1, + "conditions": [ + { + "attribute": "LLDP system description", + "values": [ + "Meraki MR*", + "*Wireless*" + ] + } + ], + "profile": { + "id": "32", + "name": "Profile 2" + } + } + ], + "assignedSwitchPorts": [ + { + "portIds": [ + "1", + "2", + "3", + "1_C3850-NM-8-10G_1", + "1_C3850-NM-8-10G_2" + ], + "switch": { + "serial": "Q234-ABCD-5678" + } + } + ], + "counts": { + "assigned": { + "devices": 2, + "ports": 51, + "networks": 1 + } + }, + "isOrganizationWide": false, + "networks": [ + { + "id": "N_11865", + "name": "Wonderland-Dev" + } + ] + } + } + } + }, + "summary": "Create a port profile automation for an organization", + "tags": [ + "switch", + "configure", + "ports", + "profiles", + "automations" + ], + "x-release-stage": "beta" + } + }, + "/organizations/{organizationId}/switch/ports/profiles/automations/{id}": { + "put": { + "description": "Update a port profile automation in an organization", + "operationId": "updateOrganizationSwitchPortsProfilesAutomation", + "parameters": [ + { + "name": "organizationId", + "in": "path", + "description": "Organization ID", + "type": "string", + "required": true + }, + { + "name": "id", + "in": "path", + "description": "ID", + "type": "string", + "required": true + }, + { + "name": "updateOrganizationSwitchPortsProfilesAutomation", + "in": "body", + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the port profile automation." + }, + "description": { + "type": "string", + "description": "Text describing the port profile automation." + }, + "fallbackProfile": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Default port profile Id" + }, + "name": { + "type": "string", + "description": "Default port profile name" + } + }, + "description": "Configuration settings for port profile" + }, + "rules": { + "type": "array", + "items": { + "type": "object", + "properties": { + "priority": { + "type": "integer", + "description": "Priority of automation rule in sequence" + }, + "conditions": { + "type": "array", + "items": { + "type": "object", + "properties": { + "attribute": { + "type": "string", + "enum": [ + "LLDP system description", + "MAC address" + ], + "description": "Type of the condition" + }, + "values": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Value of the condition" + } + } + }, + "description": "Configuration settings for port profile automation conditions" + }, + "profile": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "ID of port profile" + }, + "name": { + "type": "string", + "description": "Name of port profile" + } + }, + "description": "ID of the port profile which applies to the rule" + } + } + }, + "description": "Configuration settings for port profile automation rules" + }, + "assignedSwitchPorts": { + "type": "array", + "items": { + "type": "object", + "properties": { + "switch": { + "type": "object", + "properties": { + "portIds": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of port ids" + }, + "serial": { + "type": "string", + "description": "Serial number of the switch" + } + }, + "description": "Configuration settings for switch" + } + } + }, + "description": "assigned switch ports" + } + }, + "example": { + "name": "Automation 1", + "description": "A full length description of the automation.", + "fallbackProfile": { + "id": "1284392014819", + "name": "Profile 1" + }, + "rules": [ + { + "priority": 1, + "conditions": [ + { + "attribute": "LLDP system description", + "values": [ + "Meraki MR*", + "*Wireless*" + ] + } + ], + "profile": { + "id": "32", + "name": "Profile 2" + } + } + ], + "assignedSwitchPorts": [ + { + "switch": { + "portIds": [ + "1", + "2", + "3", + "1_C3850-NM-8-10G_1", + "1_C3850-NM-8-10G_2" + ], + "serial": "Q234-ABCD-5678" + } + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Successful operation", + "schema": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Switch port profile automation Id" + }, + "name": { + "type": "string", + "description": "Automation port profile name" + }, + "description": { + "type": "string", + "description": "Text describing the automation profile" + }, + "types": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Type of the profile" + }, + "fallbackProfile": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Default port profile Id" + }, + "name": { + "type": "string", + "description": "Default port profile name" + } + }, + "description": "Fallback port profile" + }, + "rules": { + "type": "array", + "items": { + "type": "object", + "properties": { + "priority": { + "type": "integer", + "description": "Automation sequence" + }, + "conditions": { + "type": "array", + "items": { + "type": "object", + "properties": { + "attribute": { + "type": "string", + "description": "Match attribute/type for the given automaton rule" + }, + "values": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Match criteria/values for the given automaton rule" + } + } + }, + "description": "Match type and criteria rule for target ports" + }, + "profile": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Switch port profile Id" + }, + "name": { + "type": "string", + "description": "Default port profile name" + } + }, + "description": "Profile to be applied" + } + } + }, + "description": "Automation rules configurations" + }, + "assignedSwitchPorts": { + "type": "array", + "items": { + "type": "object", + "properties": { + "portIds": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of port ids" + }, + "switch": { + "type": "object", + "properties": { + "serial": { + "type": "string", + "description": "Switch serial" + } + }, + "description": "Switch details" + } + } + }, + "description": "Assign switch port with the given profile" + }, + "counts": { + "type": "object", + "properties": { + "assigned": { + "type": "object", + "properties": { + "devices": { + "type": "integer", + "description": "Count of devices assigned to the profile" + }, + "ports": { + "type": "integer", + "description": "Count of ports assigned to the profile" + }, + "networks": { + "type": "integer", + "description": "Count of networks assigned to the profile" + } + }, + "description": "Count of assigned devices, ports, networks to a automation profile" + } + }, + "description": "Count of assigned entities to a automation profile" + }, + "isOrganizationWide": { + "type": "boolean", + "description": "Whether or not this profile is a organization wide profile" + }, + "networks": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The ID of the network / associated node group" + }, + "name": { + "type": "string", + "description": "The name of network / associated node group" + } + } + }, + "description": "List of Associated Networks" } } }, @@ -141428,383 +143638,17 @@ "ports": 51, "networks": 1 } - } - } - } - } - }, - "summary": "Create a port profile automation for an organization", - "tags": [ - "switch", - "configure", - "ports", - "profiles", - "automations" - ], - "x-release-stage": "beta" - } - }, - "/organizations/{organizationId}/switch/ports/profiles/automations/{id}": { - "put": { - "description": "Update a port profile automation in an organization", - "operationId": "updateOrganizationSwitchPortsProfilesAutomation", - "parameters": [ - { - "name": "organizationId", - "in": "path", - "description": "Organization ID", - "type": "string", - "required": true - }, - { - "name": "id", - "in": "path", - "description": "ID", - "type": "string", - "required": true - }, - { - "name": "updateOrganizationSwitchPortsProfilesAutomation", - "in": "body", - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the port profile automation." }, - "description": { - "type": "string", - "description": "Text describing the port profile automation." - }, - "fallbackProfile": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Default port profile Id" - }, - "name": { - "type": "string", - "description": "Default port profile name" - } - }, - "description": "Configuration settings for port profile" - }, - "rules": { - "type": "array", - "items": { - "type": "object", - "properties": { - "priority": { - "type": "integer", - "description": "Priority of automation rule in sequence" - }, - "conditions": { - "type": "array", - "items": { - "type": "object", - "properties": { - "attribute": { - "type": "string", - "enum": [ - "LLDP system description", - "MAC address" - ], - "description": "Type of the condition" - }, - "values": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Value of the condition" - } - } - }, - "description": "Configuration settings for port profile automation conditions" - }, - "profile": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "ID of port profile" - }, - "name": { - "type": "string", - "description": "Name of port profile" - } - }, - "description": "ID of the port profile which applies to the rule" - } - } - }, - "description": "Configuration settings for port profile automation rules" - }, - "assignedSwitchPorts": { - "type": "array", - "items": { - "type": "object", - "properties": { - "switch": { - "type": "object", - "properties": { - "portIds": { - "type": "array", - "items": { - "type": "string" - }, - "description": "List of port ids" - }, - "serial": { - "type": "string", - "description": "Serial number of the switch" - } - }, - "description": "Configuration settings for switch" - } - } - }, - "description": "assigned switch ports" - } - }, - "example": { - "name": "Automation 1", - "description": "A full length description of the automation.", - "fallbackProfile": { - "id": "1284392014819", - "name": "Profile 1" - }, - "rules": [ - { - "priority": 1, - "conditions": [ - { - "attribute": "LLDP system description", - "values": [ - "Meraki MR*", - "*Wireless*" - ] - } - ], - "profile": { - "id": "32", - "name": "Profile 2" - } - } - ], - "assignedSwitchPorts": [ + "isOrganizationWide": false, + "networks": [ { - "switch": { - "portIds": [ - "1", - "2", - "3", - "1_C3850-NM-8-10G_1", - "1_C3850-NM-8-10G_2" - ], - "serial": "Q234-ABCD-5678" - } + "id": "N_11865", + "name": "Wonderland-Dev" } ] } } } - ], - "responses": { - "200": { - "description": "Successful operation", - "schema": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Switch port profile automation Id" - }, - "name": { - "type": "string", - "description": "Automation port profile name" - }, - "description": { - "type": "string", - "description": "Text describing the automation profile" - }, - "types": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Type of the profile" - }, - "fallbackProfile": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Default port profile Id" - }, - "name": { - "type": "string", - "description": "Default port profile name" - } - }, - "description": "Fallback port profile" - }, - "rules": { - "type": "array", - "items": { - "type": "object", - "properties": { - "priority": { - "type": "integer", - "description": "Automation sequence" - }, - "conditions": { - "type": "array", - "items": { - "type": "object", - "properties": { - "attribute": { - "type": "string", - "description": "Match attribute/type for the given automaton rule" - }, - "values": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Match criteria/values for the given automaton rule" - } - } - }, - "description": "Match type and criteria rule for target ports" - }, - "profile": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Switch port profile Id" - }, - "name": { - "type": "string", - "description": "Default port profile name" - } - }, - "description": "Profile to be applied" - } - } - }, - "description": "Automation rules configurations" - }, - "assignedSwitchPorts": { - "type": "array", - "items": { - "type": "object", - "properties": { - "portIds": { - "type": "array", - "items": { - "type": "string" - }, - "description": "List of port ids" - }, - "switch": { - "type": "object", - "properties": { - "serial": { - "type": "string", - "description": "Switch serial" - } - }, - "description": "Switch details" - } - } - }, - "description": "Assign switch port with the given profile" - }, - "counts": { - "type": "object", - "properties": { - "assigned": { - "type": "object", - "properties": { - "devices": { - "type": "integer", - "description": "Count of devices assigned to the profile" - }, - "ports": { - "type": "integer", - "description": "Count of ports assigned to the profile" - }, - "networks": { - "type": "integer", - "description": "Count of networks assigned to the profile" - } - }, - "description": "Count of assigned devices, ports, networks to a automation profile" - } - }, - "description": "Count of assigned entities to a automation profile" - } - } - }, - "examples": { - "application/json": { - "id": "1284392014819", - "name": "Automation 1", - "description": "A full length description of the automation.", - "types": [ - "Custom", - "Built-in" - ], - "fallbackProfile": { - "id": "1284392014819", - "name": "Profile 1" - }, - "rules": [ - { - "priority": 1, - "conditions": [ - { - "attribute": "LLDP system description", - "values": [ - "Meraki MR*", - "*Wireless*" - ] - } - ], - "profile": { - "id": "32", - "name": "Profile 2" - } - } - ], - "assignedSwitchPorts": [ - { - "portIds": [ - "1", - "2", - "3", - "1_C3850-NM-8-10G_1", - "1_C3850-NM-8-10G_2" - ], - "switch": { - "serial": "Q234-ABCD-5678" - } - } - ], - "counts": { - "assigned": { - "devices": 2, - "ports": 51, - "networks": 1 - } - } - } - } - } }, "summary": "Update a port profile automation in an organization", "tags": [ @@ -150375,8 +152219,7 @@ "radio", "autoRf", "channels" - ], - "x-release-stage": "beta" + ] } }, "/organizations/{organizationId}/wireless/rfProfiles/assignments/byDevice": { @@ -150886,10 +152729,10 @@ ] } }, - "/organizations/{organizationId}/wireless/zigbee": { + "/organizations/{organizationId}/wireless/zigbee/byNetwork": { "get": { "description": "Return list of Zigbee configs", - "operationId": "getOrganizationWirelessZigbee", + "operationId": "getOrganizationWirelessZigbeeByNetwork", "parameters": [ { "name": "organizationId", @@ -151042,7 +152885,8 @@ "tags": [ "wireless", "configure", - "zigbee" + "zigbee", + "byNetwork" ], "x-release-stage": "beta" } @@ -151161,7 +153005,10 @@ "description": "The serial number of the MR node" }, "tags": { - "type": "string", + "type": "array", + "items": { + "type": "string" + }, "description": "The tags assocated with the MR node" } }, @@ -151222,7 +153069,10 @@ "name": "MR Client", "mac": "e4:55:a8:38:f2:06", "serial": "1234-4567-5678", - "tags": "" + "tags": [ + "tag1", + "tag2" + ] }, "counts": { "doorLocks": { @@ -151495,11 +153345,11 @@ "items": { "type": "object", "properties": { - "id": { + "doorLockId": { "type": "string", "description": "The Door Lock ID" }, - "displayName": { + "name": { "type": "string", "description": "The Door lock name" }, @@ -151577,8 +153427,8 @@ "examples": { "application/json": [ { - "id": "1", - "displayName": "Door Lock 403", + "doorLockId": "1", + "name": "Door Lock 123", "shortId": "ABE123", "lqi": "1", "rssi": "1", @@ -151636,7 +153486,7 @@ "type": "string", "description": "Unique Meraki Idenfier" }, - "displayName": { + "name": { "type": "string", "description": "Display Name to Update" } @@ -151649,7 +153499,7 @@ "doorLocks": [ { "id": "1234", - "displayName": "group_name" + "name": "group_name" } ] }, @@ -151668,11 +153518,11 @@ "items": { "type": "object", "properties": { - "id": { + "doorLockId": { "type": "string", "description": "The Door Lock ID" }, - "displayName": { + "name": { "type": "string", "description": "The Door lock name" }, @@ -151744,8 +153594,8 @@ "examples": { "application/json": [ { - "id": "1", - "displayName": "Door Lock 403", + "doorLockId": "1", + "name": "Door Lock 123", "shortId": "ABE123", "lqi": "1", "rssi": "1", @@ -155151,6 +157001,12 @@ { "name": "bulk" }, + { + "name": "bulkCreate" + }, + { + "name": "bulkDelete" + }, { "name": "bulkEnrollment" }, @@ -155364,6 +157220,9 @@ { "name": "disenrollments" }, + { + "name": "dns" + }, { "name": "doorLocks" }, @@ -155556,6 +157415,9 @@ { "name": "lldpCdp" }, + { + "name": "local" + }, { "name": "locationScanning" }, @@ -155772,6 +157634,9 @@ { "name": "recent" }, + { + "name": "records" + }, { "name": "redundancy" }, @@ -155916,6 +157781,9 @@ { "name": "splashLoginAttempts" }, + { + "name": "split" + }, { "name": "ssids" }, @@ -157691,6 +159559,84 @@ "resource": "/organizations/{organizationId}/cellularGateway/esims/swap/{id}", "operation": "status" }, + { + "group": "Wired/local dns/api/actions/bulk create", + "summary": "Assign the local DNS profile to networks in the organization", + "resource": "/organizations/{organizationId}/appliance/dns/local/profiles/assignments/bulkCreate", + "operation": "bulk_create" + }, + { + "group": "Wired/local dns/api/actions/bulk delete", + "summary": "Unassign the local DNS profile to networks in the organization", + "resource": "/organizations/{organizationId}/appliance/dns/local/profiles/assignments/bulkDelete", + "operation": "bulk_delete" + }, + { + "group": "Wired/local dns/profiles/api/actions/local dns profile", + "summary": "Create a new local DNS profile", + "resource": "/organizations/{organizationId}/appliance/dns/local/profiles", + "operation": "create" + }, + { + "group": "Wired/local dns/profiles/api/actions/local dns profile", + "summary": "Deletes a local DNS profile", + "resource": "/organizations/{organizationId}/appliance/dns/local/profiles/{profileId}", + "operation": "destroy" + }, + { + "group": "Wired/local dns/profiles/api/actions/local dns profile", + "summary": "Update a local DNS profile", + "resource": "/organizations/{organizationId}/appliance/dns/local/profiles/{profileId}", + "operation": "update" + }, + { + "group": "Wired/local dns/records/api/actions/local dns record", + "summary": "Create a new local DNS record", + "resource": "/organizations/{organizationId}/appliance/dns/local/records", + "operation": "create" + }, + { + "group": "Wired/local dns/records/api/actions/local dns record", + "summary": "Deletes a local DNS record", + "resource": "/organizations/{organizationId}/appliance/dns/local/records/{recordId}", + "operation": "destroy" + }, + { + "group": "Wired/local dns/records/api/actions/local dns record", + "summary": "Updates a local DNS record", + "resource": "/organizations/{organizationId}/appliance/dns/local/records/{recordId}", + "operation": "update" + }, + { + "group": "Wired/split dns/api/actions/bulk create", + "summary": "Assign the split DNS profile to networks in the organization", + "resource": "/organizations/{organizationId}/appliance/dns/split/profiles/assignments/bulkCreate", + "operation": "bulk_create" + }, + { + "group": "Wired/split dns/api/actions/bulk delete", + "summary": "Unassign the split DNS profile to networks in the organization", + "resource": "/organizations/{organizationId}/appliance/dns/split/profiles/assignments/bulkDelete", + "operation": "bulk_delete" + }, + { + "group": "Wired/split dns/api/actions/split dns profile", + "summary": "Create a new split DNS profile", + "resource": "/organizations/{organizationId}/appliance/dns/split/profiles", + "operation": "create" + }, + { + "group": "Wired/split dns/api/actions/split dns profile", + "summary": "Deletes a split DNS profile", + "resource": "/organizations/{organizationId}/appliance/dns/split/profiles/{profileId}", + "operation": "destroy" + }, + { + "group": "Wired/split dns/api/actions/split dns profile", + "summary": "Update a split DNS profile", + "resource": "/organizations/{organizationId}/appliance/dns/split/profiles/{profileId}", + "operation": "update" + }, { "group": "Wired/uplinks/settings", "summary": "Update the uplink settings for an MX appliance", diff --git a/openapi/spec3.json b/openapi/spec3.json index b7d8f32..eca7dbd 100644 --- a/openapi/spec3.json +++ b/openapi/spec3.json @@ -2,12 +2,12 @@ "openapi": "3.0.1", "info": { "title": "Meraki Dashboard API", - "description": "A RESTful API to programmatically manage and monitor Cisco Meraki networks at scale.\n\n> Date: 23 October, 2024\n>\n> [Recent Updates](https://meraki.io/whats-new/)\n\n---\n\n[API Documentation](https://meraki.io/api)\n\n[Community Support](https://meraki.io/community)\n\n[Meraki Homepage](https://www.meraki.com)\n", + "description": "A RESTful API to programmatically manage and monitor Cisco Meraki networks at scale.\n\n> Date: 30 October, 2024\n>\n> [Recent Updates](https://meraki.io/whats-new/)\n\n---\n\n[API Documentation](https://meraki.io/api)\n\n[Community Support](https://meraki.io/community)\n\n[Meraki Homepage](https://www.meraki.com)\n", "contact": { "name": "Meraki Developer Community", "url": "https://meraki.io/community" }, - "version": "1.51.1-beta.1" + "version": "1.51.1-beta.2" }, "servers": [ { @@ -399,7 +399,8 @@ "active", "canceled", "expired", - "inactive" + "inactive", + "out_of_compliance" ] } } @@ -549,7 +550,8 @@ "active", "canceled", "expired", - "inactive" + "inactive", + "out_of_compliance" ], "description": "Subscription status" }, @@ -847,7 +849,8 @@ "active", "canceled", "expired", - "inactive" + "inactive", + "out_of_compliance" ], "description": "Subscription status" }, @@ -1107,7 +1110,8 @@ "active", "canceled", "expired", - "inactive" + "inactive", + "out_of_compliance" ], "description": "Subscription status" }, @@ -19359,11 +19363,11 @@ "items": { "type": "object", "properties": { - "id": { + "doorLockId": { "type": "string", "description": "The Door Lock ID" }, - "displayName": { + "name": { "type": "string", "description": "The Door lock name" }, @@ -19445,8 +19449,8 @@ "enrollmentStartedAt": "complete", "doorLocks": [ { - "id": "1", - "displayName": "Door Lock 403", + "doorLockId": "1", + "name": "Door Lock 123", "shortId": "ABE123", "lqi": "1", "rssi": "1", @@ -32327,10 +32331,7 @@ "192.168.1.0/24", "192.168.128.0/24" ], - "vpnNatSubnet": "192.168.1.0/24", - "vpnNat": { - "enabled": true - } + "vpnNatSubnet": "192.168.1.0/24" } } } @@ -106766,10 +106767,10 @@ ] } }, - "/organizations/{organizationId}/appliance/sdwan/internetPolicies": { + "/organizations/{organizationId}/appliance/dns/local/profiles": { "get": { - "description": "Get the SDWAN internet traffic preferences for an MX network", - "operationId": "getOrganizationApplianceSdwanInternetPolicies", + "description": "Fetch the local DNS profiles used in the organization", + "operationId": "getOrganizationApplianceDnsLocalProfiles", "parameters": [ { "name": "organizationId", @@ -106781,492 +106782,16 @@ "required": true }, { - "name": "perPage", - "in": "query", - "description": "The number of entries per page returned. Acceptable range is 3 - 1000. Default is 50.", - "schema": { - "type": "integer" - } - }, - { - "name": "startingAfter", + "name": "profileIds", "in": "query", - "description": "A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.", - "schema": { - "type": "string" - } - }, - { - "name": "endingBefore", - "in": "query", - "description": "A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.", - "schema": { - "type": "string" - } - }, - { - "name": "wanTrafficUplinkPreferences", - "in": "query", - "description": "policies with respective traffic filters for an MX network", + "description": "Optional parameter to filter the results by profile IDs", "schema": { "type": "array", "items": { - "type": "object", - "properties": { - "preferredUplink": { - "type": "string", - "enum": [ - "bestForVoIP", - "defaultUplink", - "loadBalancing", - "wan1", - "wan2" - ], - "description": "Preferred uplink for uplink preference rule. Must be one of: 'wan1', 'wan2', 'bestForVoIP', 'loadBalancing' or 'defaultUplink'" - }, - "failOverCriterion": { - "type": "string", - "enum": [ - "poorPerformance", - "uplinkDown" - ], - "description": "WAN failover and failback behavior" - }, - "performanceClass": { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "builtin", - "custom" - ], - "description": "Type of this performance class. Must be one of: 'builtin' or 'custom'" - }, - "builtinPerformanceClassName": { - "type": "string", - "enum": [ - "VoIP" - ], - "description": "Name of builtin performance class. Must be present when performanceClass type is 'builtin' and value must be one of: 'VoIP'" - }, - "customPerformanceClassId": { - "type": "string", - "description": "ID of created custom performance class, must be present when performanceClass type is \"custom\"" - } - }, - "description": "Performance class setting for uplink preference rule" - }, - "trafficFilters": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "application", - "custom", - "majorApplication" - ], - "description": "Traffic filter type. Must be 'custom', 'major_application', 'application (NBAR)', if type is 'application', you can pass either an NBAR App Category or Application" - }, - "value": { - "type": "object", - "properties": { - "protocol": { - "type": "string", - "enum": [ - "any", - "icmp6", - "tcp", - "udp" - ], - "description": "Protocol of the traffic filter. Must be one of: 'tcp', 'udp', 'icmp6' or 'any'" - }, - "source": { - "type": "object", - "properties": { - "port": { - "type": "string", - "description": "E.g.: \"any\", \"0\" (also means \"any\"), \"8080\", \"1-1024\"" - }, - "cidr": { - "type": "string", - "description": "CIDR format address (e.g.\"192.168.10.1\", which is the same as \"192.168.10.1/32\"), or \"any\". Cannot be used in combination with the \"vlan\" property" - }, - "vlan": { - "type": "integer", - "description": "VLAN ID of the configured VLAN in the Meraki network. Cannot be used in combination with the \"cidr\" property and is currently only available under a template network." - }, - "host": { - "type": "integer", - "description": "Host ID in the VLAN. Should not exceed the VLAN subnet capacity. Must be used along with the \"vlan\" property and is currently only available under a template network." - } - }, - "description": "Source of traffic filter" - }, - "destination": { - "type": "object", - "properties": { - "port": { - "type": "string", - "description": "E.g.: \"any\", \"0\" (also means \"any\"), \"8080\", \"1-1024\"" - }, - "cidr": { - "type": "string", - "description": "CIDR format address (e.g.\"192.168.10.1\", which is the same as \"192.168.10.1/32\"), or \"any\"" - }, - "applications": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Id of the major application, or a list of NBAR Application Category or Application selections" - }, - "name": { - "type": "string", - "description": "Name of the major application or application category selected" - }, - "type": { - "type": "string", - "description": "app type (major or nbar)" - } - } - }, - "description": "list of application objects (either majorApplication or nbar)" - } - }, - "description": "Destination of 'custom' type traffic filter" - } - }, - "required": [ - "source", - "destination" - ], - "description": "Value of traffic filter" - } - }, - "required": [ - "type", - "value" - ] - }, - "description": "Traffic filters" - } - }, - "required": [ - "preferredUplink", - "trafficFilters" - ] - } - } - } - ], - "responses": { - "200": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "wanTrafficUplinkPreferences": { - "type": "array", - "items": { - "type": "object", - "properties": { - "preferredUplink": { - "type": "string", - "enum": [ - "bestForVoIP", - "defaultUplink", - "loadBalancing", - "wan1", - "wan2" - ], - "description": "Preferred uplink for uplink preference rule. Must be one of: 'wan1', 'wan2', 'bestForVoIP', 'loadBalancing' or 'defaultUplink'" - }, - "failOverCriterion": { - "type": "string", - "enum": [ - "poorPerformance", - "uplinkDown" - ], - "description": "WAN failover and failback behavior" - }, - "performanceClass": { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "builtin", - "custom" - ], - "description": "Type of this performance class. Must be one of: 'builtin' or 'custom'" - }, - "builtinPerformanceClassName": { - "type": "string", - "enum": [ - "VoIP" - ], - "description": "Name of builtin performance class. Must be present when performanceClass type is 'builtin' and value must be one of: 'VoIP'" - }, - "customPerformanceClassId": { - "type": "string", - "description": "ID of created custom performance class, must be present when performanceClass type is \"custom\"" - } - }, - "description": "Performance class setting for uplink preference rule" - }, - "trafficFilters": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "application", - "custom", - "majorApplication" - ], - "description": "Traffic filter type. Must be 'custom', 'major_application', 'application (NBAR)', if type is 'application', you can pass either an NBAR App Category or Application" - }, - "value": { - "type": "object", - "properties": { - "protocol": { - "type": "string", - "enum": [ - "any", - "icmp6", - "tcp", - "udp" - ], - "description": "Protocol of the traffic filter. Must be one of: 'tcp', 'udp', 'icmp6' or 'any'" - }, - "source": { - "type": "object", - "properties": { - "port": { - "type": "string", - "description": "E.g.: \"any\", \"0\" (also means \"any\"), \"8080\", \"1-1024\"" - }, - "cidr": { - "type": "string", - "description": "CIDR format address (e.g.\"192.168.10.1\", which is the same as \"192.168.10.1/32\"), or \"any\". Cannot be used in combination with the \"vlan\" property" - }, - "vlan": { - "type": "integer", - "description": "VLAN ID of the configured VLAN in the Meraki network. Cannot be used in combination with the \"cidr\" property and is currently only available under a template network." - }, - "host": { - "type": "integer", - "description": "Host ID in the VLAN. Should not exceed the VLAN subnet capacity. Must be used along with the \"vlan\" property and is currently only available under a template network." - } - }, - "description": "Source of traffic filter" - }, - "destination": { - "type": "object", - "properties": { - "port": { - "type": "string", - "description": "E.g.: \"any\", \"0\" (also means \"any\"), \"8080\", \"1-1024\"" - }, - "cidr": { - "type": "string", - "description": "CIDR format address (e.g.\"192.168.10.1\", which is the same as \"192.168.10.1/32\"), or \"any\"" - }, - "applications": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Id of the major application, or a list of NBAR Application Category or Application selections" - }, - "name": { - "type": "string", - "description": "Name of the major application or application category selected" - }, - "type": { - "type": "string", - "description": "app type (major or nbar)" - } - } - }, - "description": "list of application objects (either majorApplication or nbar)" - } - }, - "description": "Destination of 'custom' type traffic filter" - } - }, - "required": [ - "source", - "destination" - ], - "description": "Value of traffic filter" - } - }, - "required": [ - "type", - "value" - ] - }, - "description": "Traffic filters" - } - }, - "required": [ - "preferredUplink", - "trafficFilters" - ] - }, - "description": "policies with respective traffic filters for an MX network" - } - } - }, - "example": { - "wanTrafficUplinkPreferences": [ - { - "preferredUplink": "wan1", - "failOverCriterion": "poorPerformance", - "performanceClass": { - "type": "custom", - "builtinPerformanceClassName": "VoIP", - "customPerformanceClassId": "123456" - }, - "trafficFilters": [ - { - "type": "custom", - "value": { - "protocol": "tcp", - "source": { - "port": "1-1024", - "cidr": "192.168.1.0/24", - "vlan": 10, - "host": 254 - }, - "destination": { - "port": "any", - "cidr": "any", - "applications": [ - { - "id": "meraki:layer7/application/3", - "name": "DNS", - "type": "major" - } - ] - } - } - } - ] - } - ] - } - } - }, - "headers": { - "Link": { - "schema": { - "type": "string" - }, - "description": "A comma-separated list of first, last, prev, and next relative links used for subsequent paginated requests." + "type": "string" } } } - }, - "summary": "Get the SDWAN internet traffic preferences for an MX network", - "tags": [ - "appliance", - "configure", - "sdwan", - "internetPolicies" - ], - "x-release-stage": "beta" - } - }, - "/organizations/{organizationId}/appliance/security/events": { - "get": { - "description": "List the security events for an organization", - "operationId": "getOrganizationApplianceSecurityEvents", - "parameters": [ - { - "name": "organizationId", - "in": "path", - "description": "Organization ID", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "t0", - "in": "query", - "description": "The beginning of the timespan for the data. Data is gathered after the specified t0 value. The maximum lookback period is 365 days from today.", - "schema": { - "type": "string" - } - }, - { - "name": "t1", - "in": "query", - "description": "The end of the timespan for the data. t1 can be a maximum of 365 days after t0.", - "schema": { - "type": "string" - } - }, - { - "name": "timespan", - "in": "query", - "description": "The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 365 days. The default is 31 days.", - "schema": { - "type": "number", - "format": "float", - "maximum": 31536000 - } - }, - { - "name": "perPage", - "in": "query", - "description": "The number of entries per page returned. Acceptable range is 3 - 1000. Default is 100.", - "schema": { - "type": "integer" - } - }, - { - "name": "startingAfter", - "in": "query", - "description": "A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.", - "schema": { - "type": "string" - } - }, - { - "name": "endingBefore", - "in": "query", - "description": "A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.", - "schema": { - "type": "string" - } - }, - { - "name": "sortOrder", - "in": "query", - "description": "Sorted order of security events based on event detection time. Order options are 'ascending' or 'descending'. Default is ascending order.", - "schema": { - "type": "string", - "enum": [ - "ascending", - "descending" - ] - } - } ], "responses": { "200": { @@ -107277,116 +106802,41 @@ "type": "array", "items": { "type": "object", - "additionalProperties": true + "properties": { + "profileId": { + "type": "string", + "description": "Profile ID" + }, + "name": { + "type": "string", + "description": "Name of profile" + } + } } }, "example": [ { - "ts": "2018-02-11T00:00:00.090210Z", - "eventType": "File Scanned", - "clientName": "COMPUTER-M-V78J", - "clientMac": "10:dd:b1:eb:88:f8", - "clientIp": "192.168.128.2", - "srcIp": "192.168.128.2", - "destIp": "119.192.233.48", - "protocol": "http", - "uri": "http://www.favorite-icons.com/program/FavoriteIconsUninstall.exe", - "canonicalName": "PUA.Win.Dropper.Kraddare::1201", - "destinationPort": 80, - "fileHash": "3ec1b9a95fe62aa25fc959643a0f227b76d253094681934daaf628d3574b3463", - "fileType": "MS_EXE", - "fileSizeBytes": 193688, - "disposition": "Malicious", - "action": "Blocked" - }, - { - "ts": "2018-02-11T00:00:00.090210Z", - "eventType": "IDS Alert", - "deviceMac": "00:18:0a:01:02:03", - "clientMac": "A1:B2:C3:D4:E5:F6", - "srcIp": "1.2.3.4:34195", - "destIp": "10.20.30.40:80", - "protocol": "tcp/ip", - "priority": "2", - "classification": "4", - "blocked": true, - "message": "SERVER-WEBAPP JBoss JMX console access attempt", - "signature": "1:21516:9", - "sigSource": "", - "ruleId": "meraki:intrusion/snort/GID/1/SID/26267" + "profileId": "123456", + "name": "Default profile" } ] } - }, - "headers": { - "Link": { - "schema": { - "type": "string" - }, - "description": "A comma-separated list of first, last, prev, and next relative links used for subsequent paginated requests." - } - } - } - }, - "summary": "List the security events for an organization", - "tags": [ - "appliance", - "monitor", - "security", - "events" - ] - } - }, - "/organizations/{organizationId}/appliance/security/intrusion": { - "get": { - "description": "Returns all supported intrusion settings for an organization", - "operationId": "getOrganizationApplianceSecurityIntrusion", - "parameters": [ - { - "name": "organizationId", - "in": "path", - "description": "Organization ID", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "example": { - "allowedRules": [ - { - "ruleId": "meraki:intrusion/snort/GID/01/SID/688", - "message": "SQL sa login failed" - }, - { - "ruleId": "meraki:intrusion/snort/GID/01/SID/5805", - "message": "MALWARE-OTHER Trackware myway speedbar runtime detection - switch engines" - } - ] - } - } } } }, - "summary": "Returns all supported intrusion settings for an organization", + "summary": "Fetch the local DNS profiles used in the organization", "tags": [ "appliance", "configure", - "security", - "intrusion" - ] + "dns", + "local", + "profiles" + ], + "x-release-stage": "beta" }, - "put": { - "description": "Sets supported intrusion settings for an organization", - "operationId": "updateOrganizationApplianceSecurityIntrusion", + "post": { + "description": "Create a new local DNS profile", + "operationId": "createOrganizationApplianceDnsLocalProfile", "parameters": [ { "name": "organizationId", @@ -107404,41 +106854,16 @@ "schema": { "type": "object", "properties": { - "allowedRules": { - "type": "array", - "items": { - "type": "object", - "properties": { - "ruleId": { - "type": "string", - "description": "A rule identifier of the format meraki:intrusion/snort/GID//SID/. gid and sid can be obtained from either https://www.snort.org/rule-docs or as ruleIds from the security events in /organization/[orgId]/securityEvents" - }, - "message": { - "type": "string", - "description": "Message is optional and is ignored on a PUT call. It is allowed in order for PUT to be compatible with GET" - } - }, - "required": [ - "ruleId" - ] - }, - "description": "Sets a list of specific SNORT signatures to allow" + "name": { + "type": "string", + "description": "Name of profile" } }, "example": { - "allowedRules": [ - { - "ruleId": "meraki:intrusion/snort/GID/01/SID/688", - "message": "SQL sa login failed" - }, - { - "ruleId": "meraki:intrusion/snort/GID/01/SID/5805", - "message": "MALWARE-OTHER Trackware myway speedbar runtime detection - switch engines" - } - ] + "name": "Default profile" }, "required": [ - "allowedRules" + "name" ] } } @@ -107446,42 +106871,46 @@ "required": true }, "responses": { - "200": { + "201": { "description": "Successful operation", "content": { "application/json": { "schema": { - "type": "object" - }, - "example": { - "allowedRules": [ - { - "ruleId": "meraki:intrusion/snort/GID/01/SID/688", - "message": "SQL sa login failed" + "type": "object", + "properties": { + "profileId": { + "type": "string", + "description": "Profile ID" }, - { - "ruleId": "meraki:intrusion/snort/GID/01/SID/5805", - "message": "MALWARE-OTHER Trackware myway speedbar runtime detection - switch engines" + "name": { + "type": "string", + "description": "Name of profile" } - ] + } + }, + "example": { + "profileId": "123456", + "name": "Default profile" } } } } }, - "summary": "Sets supported intrusion settings for an organization", + "summary": "Create a new local DNS profile", "tags": [ "appliance", "configure", - "security", - "intrusion" - ] + "dns", + "local", + "profiles" + ], + "x-release-stage": "beta" } }, - "/organizations/{organizationId}/appliance/trafficShaping/vpnExclusions/byNetwork": { + "/organizations/{organizationId}/appliance/dns/local/profiles/assignments": { "get": { - "description": "Display VPN exclusion rules for MX networks.", - "operationId": "getOrganizationApplianceTrafficShapingVpnExclusionsByNetwork", + "description": "Fetch the local DNS profile assignments in the organization", + "operationId": "getOrganizationApplianceDnsLocalProfilesAssignments", "parameters": [ { "name": "organizationId", @@ -107493,27 +106922,2440 @@ "required": true }, { - "name": "perPage", - "in": "query", - "description": "The number of entries per page returned. Acceptable range is 3 - 1000. Default is 50.", - "schema": { - "type": "integer" - } - }, - { - "name": "startingAfter", + "name": "profileIds", "in": "query", - "description": "A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.", + "description": "Optional parameter to filter the results by profile IDs", "schema": { - "type": "string" - } - }, - { - "name": "endingBefore", - "in": "query", - "description": "A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.", - "schema": { - "type": "string" + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "name": "networkIds", + "in": "query", + "description": "Optional parameter to filter the results by network IDs", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + ], + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "type": "object", + "properties": { + "assignmentId": { + "type": "string", + "description": "ID of the assignment" + }, + "network": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "ID of the network" + } + }, + "description": "The network attached to the profile" + }, + "profile": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "ID of the profile" + } + }, + "description": "The profile the network is attached to" + } + } + }, + "description": "List of local DNS profile assignment" + }, + "meta": { + "type": "object", + "properties": { + "counts": { + "type": "object", + "properties": { + "items": { + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "The total number of items in the dataset" + }, + "remaining": { + "type": "integer", + "description": "The number of items in the dataset that are available on subsequent pages" + } + }, + "description": "Counts relating to the paginated items" + } + }, + "description": "Counts relating to the paginated dataset" + } + }, + "description": "Metadata relevant to the paginated dataset" + } + } + }, + "example": { + "items": [ + { + "assignmentId": "123456", + "network": { + "id": "N_123456" + }, + "profile": { + "id": "1234" + } + } + ], + "meta": { + "counts": { + "items": { + "total": 10, + "remaining": 0 + } + } + } + } + } + } + } + }, + "summary": "Fetch the local DNS profile assignments in the organization", + "tags": [ + "appliance", + "configure", + "dns", + "local", + "profiles", + "assignments" + ], + "x-release-stage": "beta" + } + }, + "/organizations/{organizationId}/appliance/dns/local/profiles/assignments/bulkCreate": { + "post": { + "description": "Assign the local DNS profile to networks in the organization", + "operationId": "createOrganizationApplianceDnsLocalProfilesAssignmentsBulkCreate", + "parameters": [ + { + "name": "organizationId", + "in": "path", + "description": "Organization ID", + "schema": { + "type": "string" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "type": "object", + "properties": { + "network": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "ID of the network" + } + }, + "description": "The network attached to the profile" + }, + "profile": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "ID of the profile" + } + }, + "description": "The profile the network is attached to" + } + } + }, + "description": "List containing the network ID and Profile ID" + } + }, + "example": { + "items": [ + { + "network": { + "id": "N_123456" + }, + "profile": { + "id": "1234" + } + } + ] + }, + "required": [ + "items" + ] + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "type": "object", + "properties": { + "assignmentId": { + "type": "string", + "description": "ID of the assignment" + }, + "network": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "ID of the network" + } + }, + "description": "The network attached to the profile" + }, + "profile": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "ID of the profile" + } + }, + "description": "The profile the network is attached to" + } + } + }, + "description": "List of local DNS profile assignment" + } + } + }, + "example": { + "items": [ + { + "assignmentId": "123456", + "network": { + "id": "N_123456" + }, + "profile": { + "id": "1234" + } + } + ] + } + } + } + } + }, + "summary": "Assign the local DNS profile to networks in the organization", + "tags": [ + "appliance", + "configure", + "dns", + "local", + "profiles", + "assignments", + "bulkCreate" + ], + "x-release-stage": "beta" + } + }, + "/organizations/{organizationId}/appliance/dns/local/profiles/assignments/bulkDelete": { + "post": { + "description": "Unassign the local DNS profile to networks in the organization", + "operationId": "createOrganizationApplianceDnsLocalProfilesAssignmentsBulkDelete", + "parameters": [ + { + "name": "organizationId", + "in": "path", + "description": "Organization ID", + "schema": { + "type": "string" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "type": "object", + "properties": { + "assignmentId": { + "type": "string", + "description": "ID of the assignment" + } + } + }, + "description": "List containing the assignment ID" + } + }, + "example": { + "items": [ + { + "assignmentId": "123456" + } + ] + }, + "required": [ + "items" + ] + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "type": "object", + "properties": { + "assignmentId": { + "type": "string", + "description": "ID of the assignment" + }, + "network": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "ID of the network" + } + }, + "description": "The network attached to the profile" + }, + "profile": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "ID of the profile" + } + }, + "description": "The profile the network is attached to" + } + } + }, + "description": "List of local DNS profile assignment" + } + } + }, + "example": { + "items": [ + { + "assignmentId": "123456", + "network": { + "id": "N_123456" + }, + "profile": { + "id": "1234" + } + } + ] + } + } + } + } + }, + "summary": "Unassign the local DNS profile to networks in the organization", + "tags": [ + "appliance", + "configure", + "dns", + "local", + "profiles", + "assignments", + "bulkDelete" + ], + "x-release-stage": "beta" + } + }, + "/organizations/{organizationId}/appliance/dns/local/profiles/{profileId}": { + "put": { + "description": "Update a local DNS profile", + "operationId": "updateOrganizationApplianceDnsLocalProfile", + "parameters": [ + { + "name": "organizationId", + "in": "path", + "description": "Organization ID", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "profileId", + "in": "path", + "description": "Profile ID", + "schema": { + "type": "string" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of profile" + } + }, + "example": { + "name": "Default profile" + }, + "required": [ + "name" + ] + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "profileId": { + "type": "string", + "description": "Profile ID" + }, + "name": { + "type": "string", + "description": "Name of profile" + } + } + }, + "example": { + "profileId": "123456", + "name": "Default profile" + } + } + } + } + }, + "summary": "Update a local DNS profile", + "tags": [ + "appliance", + "configure", + "dns", + "local", + "profiles" + ], + "x-release-stage": "beta" + }, + "delete": { + "description": "Deletes a local DNS profile", + "operationId": "deleteOrganizationApplianceDnsLocalProfile", + "parameters": [ + { + "name": "organizationId", + "in": "path", + "description": "Organization ID", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "profileId", + "in": "path", + "description": "Profile ID", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "204": { + "description": "Successful operation" + } + }, + "summary": "Deletes a local DNS profile", + "tags": [ + "appliance", + "configure", + "dns", + "local", + "profiles" + ], + "x-release-stage": "beta" + } + }, + "/organizations/{organizationId}/appliance/dns/local/records": { + "get": { + "description": "Fetch the DNS records used in local DNS profiles", + "operationId": "getOrganizationApplianceDnsLocalRecords", + "parameters": [ + { + "name": "organizationId", + "in": "path", + "description": "Organization ID", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "profileIds", + "in": "query", + "description": "Optional parameter to filter the results by profile IDs", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + ], + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "recordId": { + "type": "string", + "description": "Record ID" + }, + "hostname": { + "type": "string", + "description": "Hostname for the DNS record" + }, + "address": { + "type": "string", + "description": "IP for the DNS record" + }, + "profile": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Profile ID" + } + }, + "description": "The profile the DNS record is associated with" + } + } + } + }, + "example": [ + { + "recordId": "12345", + "hostname": "www.test.com", + "address": "10.1.1.0", + "profile": { + "id": "1" + } + } + ] + } + } + } + }, + "summary": "Fetch the DNS records used in local DNS profiles", + "tags": [ + "appliance", + "configure", + "dns", + "local", + "records" + ], + "x-release-stage": "beta" + }, + "post": { + "description": "Create a new local DNS record", + "operationId": "createOrganizationApplianceDnsLocalRecord", + "parameters": [ + { + "name": "organizationId", + "in": "path", + "description": "Organization ID", + "schema": { + "type": "string" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "hostname": { + "type": "string", + "description": "Hostname for the DNS record" + }, + "address": { + "type": "string", + "description": "IP for the DNS record" + }, + "profile": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Profile ID" + } + }, + "description": "The profile the DNS record is associated with" + } + }, + "example": { + "hostname": "www.test.com", + "address": "10.1.1.0", + "profile": { + "id": "1" + } + }, + "required": [ + "hostname", + "address", + "profile" + ] + } + } + }, + "required": true + }, + "responses": { + "201": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "recordId": { + "type": "string", + "description": "Record ID" + }, + "hostname": { + "type": "string", + "description": "Hostname for the DNS record" + }, + "address": { + "type": "string", + "description": "IP for the DNS record" + }, + "profile": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Profile ID" + } + }, + "description": "The profile the DNS record is associated with" + } + } + } + }, + "example": [ + { + "recordId": "12345", + "hostname": "www.test.com", + "address": "10.1.1.0", + "profile": { + "id": "1" + } + } + ] + } + } + } + }, + "summary": "Create a new local DNS record", + "tags": [ + "appliance", + "configure", + "dns", + "local", + "records" + ], + "x-release-stage": "beta" + } + }, + "/organizations/{organizationId}/appliance/dns/local/records/{recordId}": { + "put": { + "description": "Updates a local DNS record", + "operationId": "updateOrganizationApplianceDnsLocalRecord", + "parameters": [ + { + "name": "organizationId", + "in": "path", + "description": "Organization ID", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "recordId", + "in": "path", + "description": "Record ID", + "schema": { + "type": "string" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "hostname": { + "type": "string", + "description": "Hostname for the DNS record" + }, + "address": { + "type": "string", + "description": "IP for the DNS record" + }, + "profile": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Profile ID" + } + }, + "description": "The profile the DNS record is associated with" + } + }, + "example": { + "hostname": "www.test.com", + "address": "10.1.1.0", + "profile": { + "id": "1" + } + } + } + } + }, + "required": false + }, + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "recordId": { + "type": "string", + "description": "Record ID" + }, + "hostname": { + "type": "string", + "description": "Hostname for the DNS record" + }, + "address": { + "type": "string", + "description": "IP for the DNS record" + }, + "profile": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Profile ID" + } + }, + "description": "The profile the DNS record is associated with" + } + } + }, + "example": { + "recordId": "12345", + "hostname": "www.test.com", + "address": "10.1.1.0", + "profile": { + "id": "1" + } + } + } + } + } + }, + "summary": "Updates a local DNS record", + "tags": [ + "appliance", + "configure", + "dns", + "local", + "records" + ], + "x-release-stage": "beta" + }, + "delete": { + "description": "Deletes a local DNS record", + "operationId": "deleteOrganizationApplianceDnsLocalRecord", + "parameters": [ + { + "name": "organizationId", + "in": "path", + "description": "Organization ID", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "recordId", + "in": "path", + "description": "Record ID", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "204": { + "description": "Successful operation" + } + }, + "summary": "Deletes a local DNS record", + "tags": [ + "appliance", + "configure", + "dns", + "local", + "records" + ], + "x-release-stage": "beta" + } + }, + "/organizations/{organizationId}/appliance/dns/split/profiles": { + "get": { + "description": "Fetch the split DNS profiles used in the organization", + "operationId": "getOrganizationApplianceDnsSplitProfiles", + "parameters": [ + { + "name": "organizationId", + "in": "path", + "description": "Organization ID", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "profileIds", + "in": "query", + "description": "Optional parameter to filter the results by profile IDs", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + ], + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "profileId": { + "type": "string", + "description": "Profile ID" + }, + "name": { + "type": "string", + "description": "Name of profile" + }, + "hostnames": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The hostnames that should be redirected to the DNS server" + }, + "nameservers": { + "type": "object", + "properties": { + "addresses": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The DNS addresses the hostnames should resolve to" + } + }, + "description": "Contains the DNS addresses the hostnames should resolve to" + } + } + } + }, + "example": [ + { + "profileId": "123456", + "name": "Default profile", + "hostnames": [ + "*.test1.com", + "*.test2.com" + ], + "nameservers": { + "addresses": [ + "12.1.10.1" + ] + } + } + ] + } + } + } + }, + "summary": "Fetch the split DNS profiles used in the organization", + "tags": [ + "appliance", + "configure", + "dns", + "split", + "profiles" + ], + "x-release-stage": "beta" + }, + "post": { + "description": "Create a new split DNS profile", + "operationId": "createOrganizationApplianceDnsSplitProfile", + "parameters": [ + { + "name": "organizationId", + "in": "path", + "description": "Organization ID", + "schema": { + "type": "string" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of profile" + }, + "hostnames": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The hostnames that should be redirected to the DNS server" + }, + "nameservers": { + "type": "object", + "properties": { + "addresses": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The DNS addresses the hostnames should resolve to" + } + }, + "description": "Contains the DNS addresses the hostnames should resolve to" + } + }, + "example": { + "name": "Default profile", + "hostnames": [ + "*.test1.com", + "*.test2.com" + ], + "nameservers": { + "addresses": [ + "12.1.10.1" + ] + } + }, + "required": [ + "name", + "hostnames", + "nameservers" + ] + } + } + }, + "required": true + }, + "responses": { + "201": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "profileId": { + "type": "string", + "description": "Profile ID" + }, + "name": { + "type": "string", + "description": "Name of profile" + }, + "hostnames": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The hostnames that should be redirected to the DNS server" + }, + "nameservers": { + "type": "object", + "properties": { + "addresses": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The DNS addresses the hostnames should resolve to" + } + }, + "description": "Contains the DNS addresses the hostnames should resolve to" + } + } + }, + "example": { + "profileId": "123456", + "name": "Default profile", + "hostnames": [ + "*.test1.com", + "*.test2.com" + ], + "nameservers": { + "addresses": [ + "12.1.10.1" + ] + } + } + } + } + } + }, + "summary": "Create a new split DNS profile", + "tags": [ + "appliance", + "configure", + "dns", + "split", + "profiles" + ], + "x-release-stage": "beta" + } + }, + "/organizations/{organizationId}/appliance/dns/split/profiles/assignments": { + "get": { + "description": "Fetch the split DNS profile assignments in the organization", + "operationId": "getOrganizationApplianceDnsSplitProfilesAssignments", + "parameters": [ + { + "name": "organizationId", + "in": "path", + "description": "Organization ID", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "profileIds", + "in": "query", + "description": "Optional parameter to filter the results by profile IDs", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "name": "networkIds", + "in": "query", + "description": "Optional parameter to filter the results by network IDs", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + ], + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "ID of the assignment" + }, + "network": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "ID of the network" + } + }, + "description": "The network attached to the profile" + }, + "profile": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "ID of the profile" + } + }, + "description": "The profile the network is attached to" + } + } + }, + "description": "List of split DNS profile assignment" + }, + "meta": { + "type": "object", + "properties": { + "counts": { + "type": "object", + "properties": { + "items": { + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "The total number of items in the dataset" + }, + "remaining": { + "type": "integer", + "description": "The number of items in the dataset that are available on subsequent pages" + } + }, + "description": "Counts relating to the paginated items" + } + }, + "description": "Counts relating to the paginated dataset" + } + }, + "description": "Metadata relevant to the paginated dataset" + } + } + }, + "example": { + "items": [ + { + "id": "123456", + "network": { + "id": "N_123456" + }, + "profile": { + "id": "1234" + } + } + ], + "meta": { + "counts": { + "items": { + "total": 10, + "remaining": 0 + } + } + } + } + } + } + } + }, + "summary": "Fetch the split DNS profile assignments in the organization", + "tags": [ + "appliance", + "configure", + "dns", + "split", + "profiles", + "assignments" + ], + "x-release-stage": "beta" + } + }, + "/organizations/{organizationId}/appliance/dns/split/profiles/assignments/bulkCreate": { + "post": { + "description": "Assign the split DNS profile to networks in the organization", + "operationId": "createOrganizationApplianceDnsSplitProfilesAssignmentsBulkCreate", + "parameters": [ + { + "name": "organizationId", + "in": "path", + "description": "Organization ID", + "schema": { + "type": "string" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "type": "object", + "properties": { + "network": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "ID of the network" + } + }, + "description": "The network attached to the profile" + }, + "profile": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "ID of the profile" + } + }, + "description": "The profile the network is attached to" + } + } + }, + "description": "List containing the network ID and Profile ID" + } + }, + "example": { + "items": [ + { + "network": { + "id": "N_123456" + }, + "profile": { + "id": "1234" + } + } + ] + }, + "required": [ + "items" + ] + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "ID of the assignment" + }, + "network": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "ID of the network" + } + }, + "description": "The network attached to the profile" + }, + "profile": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "ID of the profile" + } + }, + "description": "The profile the network is attached to" + } + } + }, + "description": "List of split DNS profile assignment" + } + } + }, + "example": { + "items": [ + { + "id": "123456", + "network": { + "id": "N_123456" + }, + "profile": { + "id": "1234" + } + } + ] + } + } + } + } + }, + "summary": "Assign the split DNS profile to networks in the organization", + "tags": [ + "appliance", + "configure", + "dns", + "split", + "profiles", + "assignments", + "bulkCreate" + ], + "x-release-stage": "beta" + } + }, + "/organizations/{organizationId}/appliance/dns/split/profiles/assignments/bulkDelete": { + "post": { + "description": "Unassign the split DNS profile to networks in the organization", + "operationId": "createOrganizationApplianceDnsSplitProfilesAssignmentsBulkDelete", + "parameters": [ + { + "name": "organizationId", + "in": "path", + "description": "Organization ID", + "schema": { + "type": "string" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "ID of the assignment" + } + } + }, + "description": "List containing the assignment ID" + } + }, + "example": { + "items": [ + { + "id": "123456" + } + ] + }, + "required": [ + "items" + ] + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "ID of the assignment" + }, + "network": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "ID of the network" + } + }, + "description": "The network attached to the profile" + }, + "profile": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "ID of the profile" + } + }, + "description": "The profile the network is attached to" + } + } + }, + "description": "List of split DNS profile assignment" + } + } + }, + "example": { + "items": [ + { + "id": "123456", + "network": { + "id": "N_123456" + }, + "profile": { + "id": "1234" + } + } + ] + } + } + } + } + }, + "summary": "Unassign the split DNS profile to networks in the organization", + "tags": [ + "appliance", + "configure", + "dns", + "split", + "profiles", + "assignments", + "bulkDelete" + ], + "x-release-stage": "beta" + } + }, + "/organizations/{organizationId}/appliance/dns/split/profiles/{profileId}": { + "put": { + "description": "Update a split DNS profile", + "operationId": "updateOrganizationApplianceDnsSplitProfile", + "parameters": [ + { + "name": "organizationId", + "in": "path", + "description": "Organization ID", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "profileId", + "in": "path", + "description": "Profile ID", + "schema": { + "type": "string" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of profile" + }, + "hostnames": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The hostnames that should be redirected to the DNS server" + }, + "nameservers": { + "type": "object", + "properties": { + "addresses": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The DNS addresses the hostnames should resolve to" + } + }, + "description": "Contains the DNS addresses the hostnames should resolve to" + } + }, + "example": { + "name": "Default profile", + "hostnames": [ + "*.test1.com", + "*.test2.com" + ], + "nameservers": { + "addresses": [ + "12.1.10.1" + ] + } + } + } + } + }, + "required": false + }, + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "profileId": { + "type": "string", + "description": "Profile ID" + }, + "name": { + "type": "string", + "description": "Name of profile" + }, + "hostnames": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The hostnames that should be redirected to the DNS server" + }, + "nameservers": { + "type": "object", + "properties": { + "addresses": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The DNS addresses the hostnames should resolve to" + } + }, + "description": "Contains the DNS addresses the hostnames should resolve to" + } + } + }, + "example": { + "profileId": "123456", + "name": "Default profile", + "hostnames": [ + "*.test1.com", + "*.test2.com" + ], + "nameservers": { + "addresses": [ + "12.1.10.1" + ] + } + } + } + } + } + }, + "summary": "Update a split DNS profile", + "tags": [ + "appliance", + "configure", + "dns", + "split", + "profiles" + ], + "x-release-stage": "beta" + }, + "delete": { + "description": "Deletes a split DNS profile", + "operationId": "deleteOrganizationApplianceDnsSplitProfile", + "parameters": [ + { + "name": "organizationId", + "in": "path", + "description": "Organization ID", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "profileId", + "in": "path", + "description": "Profile ID", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "204": { + "description": "Successful operation" + } + }, + "summary": "Deletes a split DNS profile", + "tags": [ + "appliance", + "configure", + "dns", + "split", + "profiles" + ], + "x-release-stage": "beta" + } + }, + "/organizations/{organizationId}/appliance/sdwan/internetPolicies": { + "get": { + "description": "Get the SDWAN internet traffic preferences for an MX network", + "operationId": "getOrganizationApplianceSdwanInternetPolicies", + "parameters": [ + { + "name": "organizationId", + "in": "path", + "description": "Organization ID", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "perPage", + "in": "query", + "description": "The number of entries per page returned. Acceptable range is 3 - 1000. Default is 50.", + "schema": { + "type": "integer" + } + }, + { + "name": "startingAfter", + "in": "query", + "description": "A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.", + "schema": { + "type": "string" + } + }, + { + "name": "endingBefore", + "in": "query", + "description": "A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.", + "schema": { + "type": "string" + } + }, + { + "name": "wanTrafficUplinkPreferences", + "in": "query", + "description": "policies with respective traffic filters for an MX network", + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "preferredUplink": { + "type": "string", + "enum": [ + "bestForVoIP", + "defaultUplink", + "loadBalancing", + "wan1", + "wan2" + ], + "description": "Preferred uplink for uplink preference rule. Must be one of: 'wan1', 'wan2', 'bestForVoIP', 'loadBalancing' or 'defaultUplink'" + }, + "failOverCriterion": { + "type": "string", + "enum": [ + "poorPerformance", + "uplinkDown" + ], + "description": "WAN failover and failback behavior" + }, + "performanceClass": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "builtin", + "custom" + ], + "description": "Type of this performance class. Must be one of: 'builtin' or 'custom'" + }, + "builtinPerformanceClassName": { + "type": "string", + "enum": [ + "VoIP" + ], + "description": "Name of builtin performance class. Must be present when performanceClass type is 'builtin' and value must be one of: 'VoIP'" + }, + "customPerformanceClassId": { + "type": "string", + "description": "ID of created custom performance class, must be present when performanceClass type is \"custom\"" + } + }, + "description": "Performance class setting for uplink preference rule" + }, + "trafficFilters": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "application", + "custom", + "majorApplication" + ], + "description": "Traffic filter type. Must be 'custom', 'major_application', 'application (NBAR)', if type is 'application', you can pass either an NBAR App Category or Application" + }, + "value": { + "type": "object", + "properties": { + "protocol": { + "type": "string", + "enum": [ + "any", + "icmp6", + "tcp", + "udp" + ], + "description": "Protocol of the traffic filter. Must be one of: 'tcp', 'udp', 'icmp6' or 'any'" + }, + "source": { + "type": "object", + "properties": { + "port": { + "type": "string", + "description": "E.g.: \"any\", \"0\" (also means \"any\"), \"8080\", \"1-1024\"" + }, + "cidr": { + "type": "string", + "description": "CIDR format address (e.g.\"192.168.10.1\", which is the same as \"192.168.10.1/32\"), or \"any\". Cannot be used in combination with the \"vlan\" property" + }, + "vlan": { + "type": "integer", + "description": "VLAN ID of the configured VLAN in the Meraki network. Cannot be used in combination with the \"cidr\" property and is currently only available under a template network." + }, + "host": { + "type": "integer", + "description": "Host ID in the VLAN. Should not exceed the VLAN subnet capacity. Must be used along with the \"vlan\" property and is currently only available under a template network." + } + }, + "description": "Source of traffic filter" + }, + "destination": { + "type": "object", + "properties": { + "port": { + "type": "string", + "description": "E.g.: \"any\", \"0\" (also means \"any\"), \"8080\", \"1-1024\"" + }, + "cidr": { + "type": "string", + "description": "CIDR format address (e.g.\"192.168.10.1\", which is the same as \"192.168.10.1/32\"), or \"any\"" + }, + "applications": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Id of the major application, or a list of NBAR Application Category or Application selections" + }, + "name": { + "type": "string", + "description": "Name of the major application or application category selected" + }, + "type": { + "type": "string", + "description": "app type (major or nbar)" + } + } + }, + "description": "list of application objects (either majorApplication or nbar)" + } + }, + "description": "Destination of 'custom' type traffic filter" + } + }, + "required": [ + "source", + "destination" + ], + "description": "Value of traffic filter" + } + }, + "required": [ + "type", + "value" + ] + }, + "description": "Traffic filters" + } + }, + "required": [ + "preferredUplink", + "trafficFilters" + ] + } + } + } + ], + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "wanTrafficUplinkPreferences": { + "type": "array", + "items": { + "type": "object", + "properties": { + "preferredUplink": { + "type": "string", + "enum": [ + "bestForVoIP", + "defaultUplink", + "loadBalancing", + "wan1", + "wan2" + ], + "description": "Preferred uplink for uplink preference rule. Must be one of: 'wan1', 'wan2', 'bestForVoIP', 'loadBalancing' or 'defaultUplink'" + }, + "failOverCriterion": { + "type": "string", + "enum": [ + "poorPerformance", + "uplinkDown" + ], + "description": "WAN failover and failback behavior" + }, + "performanceClass": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "builtin", + "custom" + ], + "description": "Type of this performance class. Must be one of: 'builtin' or 'custom'" + }, + "builtinPerformanceClassName": { + "type": "string", + "enum": [ + "VoIP" + ], + "description": "Name of builtin performance class. Must be present when performanceClass type is 'builtin' and value must be one of: 'VoIP'" + }, + "customPerformanceClassId": { + "type": "string", + "description": "ID of created custom performance class, must be present when performanceClass type is \"custom\"" + } + }, + "description": "Performance class setting for uplink preference rule" + }, + "trafficFilters": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "application", + "custom", + "majorApplication" + ], + "description": "Traffic filter type. Must be 'custom', 'major_application', 'application (NBAR)', if type is 'application', you can pass either an NBAR App Category or Application" + }, + "value": { + "type": "object", + "properties": { + "protocol": { + "type": "string", + "enum": [ + "any", + "icmp6", + "tcp", + "udp" + ], + "description": "Protocol of the traffic filter. Must be one of: 'tcp', 'udp', 'icmp6' or 'any'" + }, + "source": { + "type": "object", + "properties": { + "port": { + "type": "string", + "description": "E.g.: \"any\", \"0\" (also means \"any\"), \"8080\", \"1-1024\"" + }, + "cidr": { + "type": "string", + "description": "CIDR format address (e.g.\"192.168.10.1\", which is the same as \"192.168.10.1/32\"), or \"any\". Cannot be used in combination with the \"vlan\" property" + }, + "vlan": { + "type": "integer", + "description": "VLAN ID of the configured VLAN in the Meraki network. Cannot be used in combination with the \"cidr\" property and is currently only available under a template network." + }, + "host": { + "type": "integer", + "description": "Host ID in the VLAN. Should not exceed the VLAN subnet capacity. Must be used along with the \"vlan\" property and is currently only available under a template network." + } + }, + "description": "Source of traffic filter" + }, + "destination": { + "type": "object", + "properties": { + "port": { + "type": "string", + "description": "E.g.: \"any\", \"0\" (also means \"any\"), \"8080\", \"1-1024\"" + }, + "cidr": { + "type": "string", + "description": "CIDR format address (e.g.\"192.168.10.1\", which is the same as \"192.168.10.1/32\"), or \"any\"" + }, + "applications": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Id of the major application, or a list of NBAR Application Category or Application selections" + }, + "name": { + "type": "string", + "description": "Name of the major application or application category selected" + }, + "type": { + "type": "string", + "description": "app type (major or nbar)" + } + } + }, + "description": "list of application objects (either majorApplication or nbar)" + } + }, + "description": "Destination of 'custom' type traffic filter" + } + }, + "required": [ + "source", + "destination" + ], + "description": "Value of traffic filter" + } + }, + "required": [ + "type", + "value" + ] + }, + "description": "Traffic filters" + } + }, + "required": [ + "preferredUplink", + "trafficFilters" + ] + }, + "description": "policies with respective traffic filters for an MX network" + } + } + }, + "example": { + "wanTrafficUplinkPreferences": [ + { + "preferredUplink": "wan1", + "failOverCriterion": "poorPerformance", + "performanceClass": { + "type": "custom", + "builtinPerformanceClassName": "VoIP", + "customPerformanceClassId": "123456" + }, + "trafficFilters": [ + { + "type": "custom", + "value": { + "protocol": "tcp", + "source": { + "port": "1-1024", + "cidr": "192.168.1.0/24", + "vlan": 10, + "host": 254 + }, + "destination": { + "port": "any", + "cidr": "any", + "applications": [ + { + "id": "meraki:layer7/application/3", + "name": "DNS", + "type": "major" + } + ] + } + } + } + ] + } + ] + } + } + }, + "headers": { + "Link": { + "schema": { + "type": "string" + }, + "description": "A comma-separated list of first, last, prev, and next relative links used for subsequent paginated requests." + } + } + } + }, + "summary": "Get the SDWAN internet traffic preferences for an MX network", + "tags": [ + "appliance", + "configure", + "sdwan", + "internetPolicies" + ], + "x-release-stage": "beta" + } + }, + "/organizations/{organizationId}/appliance/security/events": { + "get": { + "description": "List the security events for an organization", + "operationId": "getOrganizationApplianceSecurityEvents", + "parameters": [ + { + "name": "organizationId", + "in": "path", + "description": "Organization ID", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "t0", + "in": "query", + "description": "The beginning of the timespan for the data. Data is gathered after the specified t0 value. The maximum lookback period is 365 days from today.", + "schema": { + "type": "string" + } + }, + { + "name": "t1", + "in": "query", + "description": "The end of the timespan for the data. t1 can be a maximum of 365 days after t0.", + "schema": { + "type": "string" + } + }, + { + "name": "timespan", + "in": "query", + "description": "The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 365 days. The default is 31 days.", + "schema": { + "type": "number", + "format": "float", + "maximum": 31536000 + } + }, + { + "name": "perPage", + "in": "query", + "description": "The number of entries per page returned. Acceptable range is 3 - 1000. Default is 100.", + "schema": { + "type": "integer" + } + }, + { + "name": "startingAfter", + "in": "query", + "description": "A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.", + "schema": { + "type": "string" + } + }, + { + "name": "endingBefore", + "in": "query", + "description": "A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "Sorted order of security events based on event detection time. Order options are 'ascending' or 'descending'. Default is ascending order.", + "schema": { + "type": "string", + "enum": [ + "ascending", + "descending" + ] + } + } + ], + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": true + } + }, + "example": [ + { + "ts": "2018-02-11T00:00:00.090210Z", + "eventType": "File Scanned", + "clientName": "COMPUTER-M-V78J", + "clientMac": "10:dd:b1:eb:88:f8", + "clientIp": "192.168.128.2", + "srcIp": "192.168.128.2", + "destIp": "119.192.233.48", + "protocol": "http", + "uri": "http://www.favorite-icons.com/program/FavoriteIconsUninstall.exe", + "canonicalName": "PUA.Win.Dropper.Kraddare::1201", + "destinationPort": 80, + "fileHash": "3ec1b9a95fe62aa25fc959643a0f227b76d253094681934daaf628d3574b3463", + "fileType": "MS_EXE", + "fileSizeBytes": 193688, + "disposition": "Malicious", + "action": "Blocked" + }, + { + "ts": "2018-02-11T00:00:00.090210Z", + "eventType": "IDS Alert", + "deviceMac": "00:18:0a:01:02:03", + "clientMac": "A1:B2:C3:D4:E5:F6", + "srcIp": "1.2.3.4:34195", + "destIp": "10.20.30.40:80", + "protocol": "tcp/ip", + "priority": "2", + "classification": "4", + "blocked": true, + "message": "SERVER-WEBAPP JBoss JMX console access attempt", + "signature": "1:21516:9", + "sigSource": "", + "ruleId": "meraki:intrusion/snort/GID/1/SID/26267" + } + ] + } + }, + "headers": { + "Link": { + "schema": { + "type": "string" + }, + "description": "A comma-separated list of first, last, prev, and next relative links used for subsequent paginated requests." + } + } + } + }, + "summary": "List the security events for an organization", + "tags": [ + "appliance", + "monitor", + "security", + "events" + ] + } + }, + "/organizations/{organizationId}/appliance/security/intrusion": { + "get": { + "description": "Returns all supported intrusion settings for an organization", + "operationId": "getOrganizationApplianceSecurityIntrusion", + "parameters": [ + { + "name": "organizationId", + "in": "path", + "description": "Organization ID", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "example": { + "allowedRules": [ + { + "ruleId": "meraki:intrusion/snort/GID/01/SID/688", + "message": "SQL sa login failed" + }, + { + "ruleId": "meraki:intrusion/snort/GID/01/SID/5805", + "message": "MALWARE-OTHER Trackware myway speedbar runtime detection - switch engines" + } + ] + } + } + } + } + }, + "summary": "Returns all supported intrusion settings for an organization", + "tags": [ + "appliance", + "configure", + "security", + "intrusion" + ] + }, + "put": { + "description": "Sets supported intrusion settings for an organization", + "operationId": "updateOrganizationApplianceSecurityIntrusion", + "parameters": [ + { + "name": "organizationId", + "in": "path", + "description": "Organization ID", + "schema": { + "type": "string" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "allowedRules": { + "type": "array", + "items": { + "type": "object", + "properties": { + "ruleId": { + "type": "string", + "description": "A rule identifier of the format meraki:intrusion/snort/GID//SID/. gid and sid can be obtained from either https://www.snort.org/rule-docs or as ruleIds from the security events in /organization/[orgId]/securityEvents" + }, + "message": { + "type": "string", + "description": "Message is optional and is ignored on a PUT call. It is allowed in order for PUT to be compatible with GET" + } + }, + "required": [ + "ruleId" + ] + }, + "description": "Sets a list of specific SNORT signatures to allow" + } + }, + "example": { + "allowedRules": [ + { + "ruleId": "meraki:intrusion/snort/GID/01/SID/688", + "message": "SQL sa login failed" + }, + { + "ruleId": "meraki:intrusion/snort/GID/01/SID/5805", + "message": "MALWARE-OTHER Trackware myway speedbar runtime detection - switch engines" + } + ] + }, + "required": [ + "allowedRules" + ] + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "example": { + "allowedRules": [ + { + "ruleId": "meraki:intrusion/snort/GID/01/SID/688", + "message": "SQL sa login failed" + }, + { + "ruleId": "meraki:intrusion/snort/GID/01/SID/5805", + "message": "MALWARE-OTHER Trackware myway speedbar runtime detection - switch engines" + } + ] + } + } + } + } + }, + "summary": "Sets supported intrusion settings for an organization", + "tags": [ + "appliance", + "configure", + "security", + "intrusion" + ] + } + }, + "/organizations/{organizationId}/appliance/trafficShaping/vpnExclusions/byNetwork": { + "get": { + "description": "Display VPN exclusion rules for MX networks.", + "operationId": "getOrganizationApplianceTrafficShapingVpnExclusionsByNetwork", + "parameters": [ + { + "name": "organizationId", + "in": "path", + "description": "Organization ID", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "perPage", + "in": "query", + "description": "The number of entries per page returned. Acceptable range is 3 - 1000. Default is 50.", + "schema": { + "type": "integer" + } + }, + { + "name": "startingAfter", + "in": "query", + "description": "A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.", + "schema": { + "type": "string" + } + }, + { + "name": "endingBefore", + "in": "query", + "description": "A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.", + "schema": { + "type": "string" } }, { @@ -109634,8 +111476,10 @@ "crc_errors", "crc_errors_error", "crc_errors_warning", + "dashboard_config_generation_failure", "detected_country_mismatch", "device_access_issue", + "device_config_failure", "device_no_space", "device_reporting", "dfs_event_pattern", @@ -109849,6 +111693,7 @@ "Catalyst AP", "Catalyst Controller", "Catalyst Switch", + "MCG", "MG", "MR", "MS", @@ -110233,8 +112078,10 @@ "crc_errors", "crc_errors_error", "crc_errors_warning", + "dashboard_config_generation_failure", "detected_country_mismatch", "device_access_issue", + "device_config_failure", "device_no_space", "device_reporting", "dfs_event_pattern", @@ -110433,6 +112280,7 @@ "Catalyst AP", "Catalyst Controller", "Catalyst Switch", + "MCG", "MG", "MR", "MS", @@ -110670,8 +112518,10 @@ "crc_errors", "crc_errors_error", "crc_errors_warning", + "dashboard_config_generation_failure", "detected_country_mismatch", "device_access_issue", + "device_config_failure", "device_no_space", "device_reporting", "dfs_event_pattern", @@ -110870,6 +112720,7 @@ "Catalyst AP", "Catalyst Controller", "Catalyst Switch", + "MCG", "MG", "MR", "MS", @@ -111156,8 +113007,10 @@ "crc_errors", "crc_errors_error", "crc_errors_warning", + "dashboard_config_generation_failure", "detected_country_mismatch", "device_access_issue", + "device_config_failure", "device_no_space", "device_reporting", "dfs_event_pattern", @@ -111371,6 +113224,7 @@ "Catalyst AP", "Catalyst Controller", "Catalyst Switch", + "MCG", "MG", "MR", "MS", @@ -111596,8 +113450,10 @@ "crc_errors", "crc_errors_error", "crc_errors_warning", + "dashboard_config_generation_failure", "detected_country_mismatch", "device_access_issue", + "device_config_failure", "device_no_space", "device_reporting", "dfs_event_pattern", @@ -111797,6 +113653,7 @@ "Catalyst AP", "Catalyst Controller", "Catalyst Switch", + "MCG", "MG", "MR", "MS", @@ -123034,7 +124891,7 @@ { "name": "productTypes", "in": "query", - "description": "Optional parameter to filter device availabilities by device product types. This filter uses multiple exact matches. Valid types are wireless, appliance, switch, camera, cellularGateway, sensor, and wirelessController", + "description": "Optional parameter to filter device availabilities by device product types. This filter uses multiple exact matches. Valid types are wireless, appliance, switch, camera, cellularGateway, sensor, wirelessController, and campusGateway", "schema": { "type": "array", "items": { @@ -124294,10 +126151,10 @@ "name": "file_name", "startTime": "2018-02-11T00:00:00.090210Z", "ports": "1, 2", - "status": "new", + "status": "completed", "errorMessage": "Some error message", - "outputType": "upload_to_cloud", - "captureSource": "automatic", + "outputType": "cloudshark", + "captureSource": "proactive", "captureReason": "capture reason", "fileSize": 1066, "duration": 60, @@ -124571,10 +126428,10 @@ "name": "file_name", "startTime": "2018-02-11T00:00:00.090210Z", "ports": "1, 2", - "status": "new", + "status": "completed", "errorMessage": "Some error message", - "outputType": "upload_to_cloud", - "captureSource": "automatic", + "outputType": "cloudshark", + "captureSource": "proactive", "captureReason": "capture reason", "fileSize": 1066, "duration": 60, @@ -124921,10 +126778,10 @@ "name": "file_name", "startTime": "2018-02-11T00:00:00.090210Z", "ports": "1, 2", - "status": "new", + "status": "completed", "errorMessage": "Some error message", - "outputType": "upload_to_cloud", - "captureSource": "automatic", + "outputType": "cloudshark", + "captureSource": "proactive", "captureReason": "capture reason", "fileSize": 1066, "duration": 60, @@ -136500,10 +138357,11 @@ "full", "guest-ambassador", "monitor-only", + "port-tags", "read-only", "ssid-admin" ], - "description": "The privilege of the SAML administrator on the network. Can be one of 'full', 'read-only', 'guest-ambassador', 'monitor-only' or 'ssid-admin'" + "description": "The privilege of the SAML administrator on the network. Can be one of 'full', 'read-only', 'guest-ambassador', 'monitor-only', 'ssid-admin' or 'port-tags'" } }, "required": [ @@ -136863,10 +138721,11 @@ "full", "guest-ambassador", "monitor-only", + "port-tags", "read-only", "ssid-admin" ], - "description": "The privilege of the SAML administrator on the network. Can be one of 'full', 'read-only', 'guest-ambassador', 'monitor-only' or 'ssid-admin'" + "description": "The privilege of the SAML administrator on the network. Can be one of 'full', 'read-only', 'guest-ambassador', 'monitor-only', 'ssid-admin' or 'port-tags'" } }, "required": [ @@ -149809,6 +151668,25 @@ } } }, + { + "name": "networkIds", + "in": "query", + "description": "Optional parameter to filter the result set by the associated networks.", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "name": "isOrganizationWide", + "in": "query", + "description": "Optional parameter to filter the result set by automations org-wide flag.", + "schema": { + "type": "string" + } + }, { "name": "searchQuery", "in": "query", @@ -149984,6 +151862,27 @@ } }, "description": "Count of assigned entities to a automation profile" + }, + "isOrganizationWide": { + "type": "boolean", + "description": "Whether or not this profile is a organization wide profile" + }, + "networks": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The ID of the network / associated node group" + }, + "name": { + "type": "string", + "description": "The name of network / associated node group" + } + } + }, + "description": "List of Associated Networks" } } }, @@ -150065,7 +151964,14 @@ "ports": 51, "networks": 1 } - } + }, + "isOrganizationWide": false, + "networks": [ + { + "id": "N_11865", + "name": "Wonderland-Dev" + } + ] } ], "meta": { @@ -150400,6 +152306,437 @@ } }, "description": "Count of assigned entities to a automation profile" + }, + "isOrganizationWide": { + "type": "boolean", + "description": "Whether or not this profile is a organization wide profile" + }, + "networks": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The ID of the network / associated node group" + }, + "name": { + "type": "string", + "description": "The name of network / associated node group" + } + } + }, + "description": "List of Associated Networks" + } + } + }, + "example": { + "id": "1284392014819", + "name": "Automation 1", + "description": "A full length description of the automation.", + "types": [ + "Custom", + "Built-in" + ], + "fallbackProfile": { + "id": "1284392014819", + "name": "Profile 1" + }, + "rules": [ + { + "priority": 1, + "conditions": [ + { + "attribute": "LLDP system description", + "values": [ + "Meraki MR*", + "*Wireless*" + ] + } + ], + "profile": { + "id": "32", + "name": "Profile 2" + } + } + ], + "assignedSwitchPorts": [ + { + "portIds": [ + "1", + "2", + "3", + "1_C3850-NM-8-10G_1", + "1_C3850-NM-8-10G_2" + ], + "switch": { + "serial": "Q234-ABCD-5678" + } + } + ], + "counts": { + "assigned": { + "devices": 2, + "ports": 51, + "networks": 1 + } + }, + "isOrganizationWide": false, + "networks": [ + { + "id": "N_11865", + "name": "Wonderland-Dev" + } + ] + } + } + } + } + }, + "summary": "Create a port profile automation for an organization", + "tags": [ + "switch", + "configure", + "ports", + "profiles", + "automations" + ], + "x-release-stage": "beta" + } + }, + "/organizations/{organizationId}/switch/ports/profiles/automations/{id}": { + "put": { + "description": "Update a port profile automation in an organization", + "operationId": "updateOrganizationSwitchPortsProfilesAutomation", + "parameters": [ + { + "name": "organizationId", + "in": "path", + "description": "Organization ID", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "id", + "in": "path", + "description": "ID", + "schema": { + "type": "string" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the port profile automation." + }, + "description": { + "type": "string", + "description": "Text describing the port profile automation." + }, + "fallbackProfile": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Default port profile Id" + }, + "name": { + "type": "string", + "description": "Default port profile name" + } + }, + "description": "Configuration settings for port profile" + }, + "rules": { + "type": "array", + "items": { + "type": "object", + "properties": { + "priority": { + "type": "integer", + "description": "Priority of automation rule in sequence" + }, + "conditions": { + "type": "array", + "items": { + "type": "object", + "properties": { + "attribute": { + "type": "string", + "enum": [ + "LLDP system description", + "MAC address" + ], + "description": "Type of the condition" + }, + "values": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Value of the condition" + } + } + }, + "description": "Configuration settings for port profile automation conditions" + }, + "profile": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "ID of port profile" + }, + "name": { + "type": "string", + "description": "Name of port profile" + } + }, + "description": "ID of the port profile which applies to the rule" + } + } + }, + "description": "Configuration settings for port profile automation rules" + }, + "assignedSwitchPorts": { + "type": "array", + "items": { + "type": "object", + "properties": { + "switch": { + "type": "object", + "properties": { + "portIds": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of port ids" + }, + "serial": { + "type": "string", + "description": "Serial number of the switch" + } + }, + "description": "Configuration settings for switch" + } + } + }, + "description": "assigned switch ports" + } + }, + "example": { + "name": "Automation 1", + "description": "A full length description of the automation.", + "fallbackProfile": { + "id": "1284392014819", + "name": "Profile 1" + }, + "rules": [ + { + "priority": 1, + "conditions": [ + { + "attribute": "LLDP system description", + "values": [ + "Meraki MR*", + "*Wireless*" + ] + } + ], + "profile": { + "id": "32", + "name": "Profile 2" + } + } + ], + "assignedSwitchPorts": [ + { + "switch": { + "portIds": [ + "1", + "2", + "3", + "1_C3850-NM-8-10G_1", + "1_C3850-NM-8-10G_2" + ], + "serial": "Q234-ABCD-5678" + } + } + ] + } + } + } + }, + "required": false + }, + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Switch port profile automation Id" + }, + "name": { + "type": "string", + "description": "Automation port profile name" + }, + "description": { + "type": "string", + "description": "Text describing the automation profile" + }, + "types": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Type of the profile" + }, + "fallbackProfile": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Default port profile Id" + }, + "name": { + "type": "string", + "description": "Default port profile name" + } + }, + "description": "Fallback port profile" + }, + "rules": { + "type": "array", + "items": { + "type": "object", + "properties": { + "priority": { + "type": "integer", + "description": "Automation sequence" + }, + "conditions": { + "type": "array", + "items": { + "type": "object", + "properties": { + "attribute": { + "type": "string", + "description": "Match attribute/type for the given automaton rule" + }, + "values": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Match criteria/values for the given automaton rule" + } + } + }, + "description": "Match type and criteria rule for target ports" + }, + "profile": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Switch port profile Id" + }, + "name": { + "type": "string", + "description": "Default port profile name" + } + }, + "description": "Profile to be applied" + } + } + }, + "description": "Automation rules configurations" + }, + "assignedSwitchPorts": { + "type": "array", + "items": { + "type": "object", + "properties": { + "portIds": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of port ids" + }, + "switch": { + "type": "object", + "properties": { + "serial": { + "type": "string", + "description": "Switch serial" + } + }, + "description": "Switch details" + } + } + }, + "description": "Assign switch port with the given profile" + }, + "counts": { + "type": "object", + "properties": { + "assigned": { + "type": "object", + "properties": { + "devices": { + "type": "integer", + "description": "Count of devices assigned to the profile" + }, + "ports": { + "type": "integer", + "description": "Count of ports assigned to the profile" + }, + "networks": { + "type": "integer", + "description": "Count of networks assigned to the profile" + } + }, + "description": "Count of assigned devices, ports, networks to a automation profile" + } + }, + "description": "Count of assigned entities to a automation profile" + }, + "isOrganizationWide": { + "type": "boolean", + "description": "Whether or not this profile is a organization wide profile" + }, + "networks": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The ID of the network / associated node group" + }, + "name": { + "type": "string", + "description": "The name of network / associated node group" + } + } + }, + "description": "List of Associated Networks" } } }, @@ -150453,392 +152790,17 @@ "ports": 51, "networks": 1 } - } - } - } - } - } - }, - "summary": "Create a port profile automation for an organization", - "tags": [ - "switch", - "configure", - "ports", - "profiles", - "automations" - ], - "x-release-stage": "beta" - } - }, - "/organizations/{organizationId}/switch/ports/profiles/automations/{id}": { - "put": { - "description": "Update a port profile automation in an organization", - "operationId": "updateOrganizationSwitchPortsProfilesAutomation", - "parameters": [ - { - "name": "organizationId", - "in": "path", - "description": "Organization ID", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "id", - "in": "path", - "description": "ID", - "schema": { - "type": "string" - }, - "required": true - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the port profile automation." - }, - "description": { - "type": "string", - "description": "Text describing the port profile automation." - }, - "fallbackProfile": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Default port profile Id" - }, - "name": { - "type": "string", - "description": "Default port profile name" - } - }, - "description": "Configuration settings for port profile" - }, - "rules": { - "type": "array", - "items": { - "type": "object", - "properties": { - "priority": { - "type": "integer", - "description": "Priority of automation rule in sequence" - }, - "conditions": { - "type": "array", - "items": { - "type": "object", - "properties": { - "attribute": { - "type": "string", - "enum": [ - "LLDP system description", - "MAC address" - ], - "description": "Type of the condition" - }, - "values": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Value of the condition" - } - } - }, - "description": "Configuration settings for port profile automation conditions" - }, - "profile": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "ID of port profile" - }, - "name": { - "type": "string", - "description": "Name of port profile" - } - }, - "description": "ID of the port profile which applies to the rule" - } - } - }, - "description": "Configuration settings for port profile automation rules" }, - "assignedSwitchPorts": { - "type": "array", - "items": { - "type": "object", - "properties": { - "switch": { - "type": "object", - "properties": { - "portIds": { - "type": "array", - "items": { - "type": "string" - }, - "description": "List of port ids" - }, - "serial": { - "type": "string", - "description": "Serial number of the switch" - } - }, - "description": "Configuration settings for switch" - } - } - }, - "description": "assigned switch ports" - } - }, - "example": { - "name": "Automation 1", - "description": "A full length description of the automation.", - "fallbackProfile": { - "id": "1284392014819", - "name": "Profile 1" - }, - "rules": [ - { - "priority": 1, - "conditions": [ - { - "attribute": "LLDP system description", - "values": [ - "Meraki MR*", - "*Wireless*" - ] - } - ], - "profile": { - "id": "32", - "name": "Profile 2" - } - } - ], - "assignedSwitchPorts": [ + "isOrganizationWide": false, + "networks": [ { - "switch": { - "portIds": [ - "1", - "2", - "3", - "1_C3850-NM-8-10G_1", - "1_C3850-NM-8-10G_2" - ], - "serial": "Q234-ABCD-5678" - } + "id": "N_11865", + "name": "Wonderland-Dev" } ] } } } - }, - "required": false - }, - "responses": { - "200": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Switch port profile automation Id" - }, - "name": { - "type": "string", - "description": "Automation port profile name" - }, - "description": { - "type": "string", - "description": "Text describing the automation profile" - }, - "types": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Type of the profile" - }, - "fallbackProfile": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Default port profile Id" - }, - "name": { - "type": "string", - "description": "Default port profile name" - } - }, - "description": "Fallback port profile" - }, - "rules": { - "type": "array", - "items": { - "type": "object", - "properties": { - "priority": { - "type": "integer", - "description": "Automation sequence" - }, - "conditions": { - "type": "array", - "items": { - "type": "object", - "properties": { - "attribute": { - "type": "string", - "description": "Match attribute/type for the given automaton rule" - }, - "values": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Match criteria/values for the given automaton rule" - } - } - }, - "description": "Match type and criteria rule for target ports" - }, - "profile": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Switch port profile Id" - }, - "name": { - "type": "string", - "description": "Default port profile name" - } - }, - "description": "Profile to be applied" - } - } - }, - "description": "Automation rules configurations" - }, - "assignedSwitchPorts": { - "type": "array", - "items": { - "type": "object", - "properties": { - "portIds": { - "type": "array", - "items": { - "type": "string" - }, - "description": "List of port ids" - }, - "switch": { - "type": "object", - "properties": { - "serial": { - "type": "string", - "description": "Switch serial" - } - }, - "description": "Switch details" - } - } - }, - "description": "Assign switch port with the given profile" - }, - "counts": { - "type": "object", - "properties": { - "assigned": { - "type": "object", - "properties": { - "devices": { - "type": "integer", - "description": "Count of devices assigned to the profile" - }, - "ports": { - "type": "integer", - "description": "Count of ports assigned to the profile" - }, - "networks": { - "type": "integer", - "description": "Count of networks assigned to the profile" - } - }, - "description": "Count of assigned devices, ports, networks to a automation profile" - } - }, - "description": "Count of assigned entities to a automation profile" - } - } - }, - "example": { - "id": "1284392014819", - "name": "Automation 1", - "description": "A full length description of the automation.", - "types": [ - "Custom", - "Built-in" - ], - "fallbackProfile": { - "id": "1284392014819", - "name": "Profile 1" - }, - "rules": [ - { - "priority": 1, - "conditions": [ - { - "attribute": "LLDP system description", - "values": [ - "Meraki MR*", - "*Wireless*" - ] - } - ], - "profile": { - "id": "32", - "name": "Profile 2" - } - } - ], - "assignedSwitchPorts": [ - { - "portIds": [ - "1", - "2", - "3", - "1_C3850-NM-8-10G_1", - "1_C3850-NM-8-10G_2" - ], - "switch": { - "serial": "Q234-ABCD-5678" - } - } - ], - "counts": { - "assigned": { - "devices": 2, - "ports": 51, - "networks": 1 - } - } - } - } - } } }, "summary": "Update a port profile automation in an organization", @@ -160019,8 +161981,7 @@ "radio", "autoRf", "channels" - ], - "x-release-stage": "beta" + ] } }, "/organizations/{organizationId}/wireless/rfProfiles/assignments/byDevice": { @@ -160580,10 +162541,10 @@ ] } }, - "/organizations/{organizationId}/wireless/zigbee": { + "/organizations/{organizationId}/wireless/zigbee/byNetwork": { "get": { "description": "Return list of Zigbee configs", - "operationId": "getOrganizationWirelessZigbee", + "operationId": "getOrganizationWirelessZigbeeByNetwork", "parameters": [ { "name": "organizationId", @@ -160750,7 +162711,8 @@ "tags": [ "wireless", "configure", - "zigbee" + "zigbee", + "byNetwork" ], "x-release-stage": "beta" } @@ -160885,7 +162847,10 @@ "description": "The serial number of the MR node" }, "tags": { - "type": "string", + "type": "array", + "items": { + "type": "string" + }, "description": "The tags assocated with the MR node" } }, @@ -160939,7 +162904,10 @@ "name": "MR Client", "mac": "e4:55:a8:38:f2:06", "serial": "1234-4567-5678", - "tags": "" + "tags": [ + "tag1", + "tag2" + ] }, "counts": { "doorLocks": { @@ -161248,11 +163216,11 @@ "items": { "type": "object", "properties": { - "id": { + "doorLockId": { "type": "string", "description": "The Door Lock ID" }, - "displayName": { + "name": { "type": "string", "description": "The Door lock name" }, @@ -161323,8 +163291,8 @@ }, "example": [ { - "id": "1", - "displayName": "Door Lock 403", + "doorLockId": "1", + "name": "Door Lock 123", "shortId": "ABE123", "lqi": "1", "rssi": "1", @@ -161394,7 +163362,7 @@ "type": "string", "description": "Unique Meraki Idenfier" }, - "displayName": { + "name": { "type": "string", "description": "Display Name to Update" } @@ -161407,7 +163375,7 @@ "doorLocks": [ { "id": "1234", - "displayName": "group_name" + "name": "group_name" } ] }, @@ -161429,11 +163397,11 @@ "items": { "type": "object", "properties": { - "id": { + "doorLockId": { "type": "string", "description": "The Door Lock ID" }, - "displayName": { + "name": { "type": "string", "description": "The Door lock name" }, @@ -161504,8 +163472,8 @@ }, "example": [ { - "id": "1", - "displayName": "Door Lock 403", + "doorLockId": "1", + "name": "Door Lock 123", "shortId": "ABE123", "lqi": "1", "rssi": "1", @@ -165210,6 +167178,12 @@ { "name": "bulk" }, + { + "name": "bulkCreate" + }, + { + "name": "bulkDelete" + }, { "name": "bulkEnrollment" }, @@ -165423,6 +167397,9 @@ { "name": "disenrollments" }, + { + "name": "dns" + }, { "name": "doorLocks" }, @@ -165615,6 +167592,9 @@ { "name": "lldpCdp" }, + { + "name": "local" + }, { "name": "locationScanning" }, @@ -165831,6 +167811,9 @@ { "name": "recent" }, + { + "name": "records" + }, { "name": "redundancy" }, @@ -165975,6 +167958,9 @@ { "name": "splashLoginAttempts" }, + { + "name": "split" + }, { "name": "ssids" }, @@ -167750,6 +169736,84 @@ "resource": "/organizations/{organizationId}/cellularGateway/esims/swap/{id}", "operation": "status" }, + { + "group": "Wired/local dns/api/actions/bulk create", + "summary": "Assign the local DNS profile to networks in the organization", + "resource": "/organizations/{organizationId}/appliance/dns/local/profiles/assignments/bulkCreate", + "operation": "bulk_create" + }, + { + "group": "Wired/local dns/api/actions/bulk delete", + "summary": "Unassign the local DNS profile to networks in the organization", + "resource": "/organizations/{organizationId}/appliance/dns/local/profiles/assignments/bulkDelete", + "operation": "bulk_delete" + }, + { + "group": "Wired/local dns/profiles/api/actions/local dns profile", + "summary": "Create a new local DNS profile", + "resource": "/organizations/{organizationId}/appliance/dns/local/profiles", + "operation": "create" + }, + { + "group": "Wired/local dns/profiles/api/actions/local dns profile", + "summary": "Deletes a local DNS profile", + "resource": "/organizations/{organizationId}/appliance/dns/local/profiles/{profileId}", + "operation": "destroy" + }, + { + "group": "Wired/local dns/profiles/api/actions/local dns profile", + "summary": "Update a local DNS profile", + "resource": "/organizations/{organizationId}/appliance/dns/local/profiles/{profileId}", + "operation": "update" + }, + { + "group": "Wired/local dns/records/api/actions/local dns record", + "summary": "Create a new local DNS record", + "resource": "/organizations/{organizationId}/appliance/dns/local/records", + "operation": "create" + }, + { + "group": "Wired/local dns/records/api/actions/local dns record", + "summary": "Deletes a local DNS record", + "resource": "/organizations/{organizationId}/appliance/dns/local/records/{recordId}", + "operation": "destroy" + }, + { + "group": "Wired/local dns/records/api/actions/local dns record", + "summary": "Updates a local DNS record", + "resource": "/organizations/{organizationId}/appliance/dns/local/records/{recordId}", + "operation": "update" + }, + { + "group": "Wired/split dns/api/actions/bulk create", + "summary": "Assign the split DNS profile to networks in the organization", + "resource": "/organizations/{organizationId}/appliance/dns/split/profiles/assignments/bulkCreate", + "operation": "bulk_create" + }, + { + "group": "Wired/split dns/api/actions/bulk delete", + "summary": "Unassign the split DNS profile to networks in the organization", + "resource": "/organizations/{organizationId}/appliance/dns/split/profiles/assignments/bulkDelete", + "operation": "bulk_delete" + }, + { + "group": "Wired/split dns/api/actions/split dns profile", + "summary": "Create a new split DNS profile", + "resource": "/organizations/{organizationId}/appliance/dns/split/profiles", + "operation": "create" + }, + { + "group": "Wired/split dns/api/actions/split dns profile", + "summary": "Deletes a split DNS profile", + "resource": "/organizations/{organizationId}/appliance/dns/split/profiles/{profileId}", + "operation": "destroy" + }, + { + "group": "Wired/split dns/api/actions/split dns profile", + "summary": "Update a split DNS profile", + "resource": "/organizations/{organizationId}/appliance/dns/split/profiles/{profileId}", + "operation": "update" + }, { "group": "Wired/uplinks/settings", "summary": "Update the uplink settings for an MX appliance",