openapi: 3.0.0 info: title: 'Akamai: API Endpoint Definition Access tokens Network lists API' version: '2' license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html servers: - url: https://{hostname}/api-definitions/v2 tags: - name: Network lists paths: /network-lists: post: description: Creates a new network list. operationId: post-network-lists summary: Akamai Create a New Network List tags: - Network lists externalDocs: description: See documentation for this operation in Akamai's Network Lists API url: https://techdocs.akamai.com/network-lists/reference/post-network-lists requestBody: required: true content: application/json: example: contractId: K-0N7RAK7 description: Notes about this network list groupId: 517014 name: My Network List type: IP list: [] schema: additionalProperties: false type: object required: - name - type - list properties: contractId: description: Identifies the contract where you want to create the list. You need to have write access to lists in the contract you specify. If you provide a `contractId`, you need to pair it with a `groupId`. example: '{{contractId}}' maxLength: 20 minLength: 5 type: string description: description: Detailed description of the list. example: '{{description}}' maxLength: 255 minLength: 1 type: string groupId: description: Identifies the group where you want to create the list. You need to have write access to the group you specify. If you include a `groupId`, you need to pair it with a `contractId`. example: '{{groupId}}' type: number list: description: Defines the network list's set of elements. If the `type` is `IP`, values are any combination of IPv4 addresses, IPv6 addresses, or CIDR blocks. If the `type` is `GEO`, values are ISO 3166 two-character country codes. This array does not appear in the object if you get it with the `includeElements` query parameter set to `false`. type: array items: example: FR minLength: 0 type: string name: description: Display name of the network list. example: '{{name}}' maxLength: 100 minLength: 1 type: string type: description: The network list type, either `IP` for IP addresses and CIDR blocks, or `GEO` for two-letter country codes. example: '{{type}}' type: string enum: - IP - GEO x-akamai: file-path: schemas/create.yaml responses: '201': description: Successful response. content: application/json: example: contractId: K-0N7RAK7 elementCount: 13 groupId: 517014 name: My Network List networkListType: networkListResponse readOnly: true shared: true syncPoint: 65 type: IP uniqueId: 1024_NETWORKLIST list: - 192.0.2.135/24 - 12.129.0.0/15 - 12.211.0.0/15 - 192.0.2.248/24 - 192.0.2.204/24 - 12.231.0.0/14 - 12.235.0.0/14 - 192.0.2.161/24 - 192.0.2.62/24 - 192.0.2.38/24 - 192.0.2.158/24 - 192.0.2.108/24 - 192.0.2.200/24 links: activateInProduction: href: /network-list/v2/network-lists/1024_AMAZONELASTICCOMPUTECLOU/environments/PRODUCTION/activate method: POST activateInStaging: href: /network-list/v2/network-lists/1024_AMAZONELASTICCOMPUTECLOU/environments/STAGING/activate method: POST appendItems: href: /network-list/v2/network-lists/1024_AMAZONELASTICCOMPUTECLOU/append method: POST retrieve: href: /network-list/v2/network-lists/1024_AMAZONELASTICCOMPUTECLOU statusInProduction: href: /network-list/v2/network-lists/1024_AMAZONELASTICCOMPUTECLOU/environments/PRODUCTION/status statusInStaging: href: /network-list/v2/network-lists/1024_AMAZONELASTICCOMPUTECLOU/environments/STAGING/status update: href: /network-list/v2/network-lists/1024_AMAZONELASTICCOMPUTECLOU method: PUT schema: additionalProperties: false description: Encapsulates information about each network list. type: object required: - name - syncPoint - type - uniqueId properties: accessControlGroup: description: Name of this network list's access control group (ACG). type: string contractId: description: Identifies the contract where you want to create the list. You need to have write access to the contract you specify. If you include a `contractId`, you need to pair it with a `groupId`. maxLength: 20 minLength: 5 type: string createDate: description: ISO 8601 timestamp indicating when the network list was first created. Available only when using the `extended` query parameter to retrieve network list data. example: '2017-06-01T15:13:40.36Z' format: date-time type: string createdBy: description: Username of this list's creator. Available only when using the `extended` query parameter to retrieve network list data. type: string description: description: Detailed description of the list. maxLength: 255 minLength: 1 type: string elementCount: description: Reflects the number of elements in the `list` array, which may not necessarily appear in the object when retrieving the list with the `includeElements` query parameter set to `false`. type: integer expeditedProductionActivationStatus: description: For clients with access to _expedited_ activations on select servers, provides the most recent activation status in the `PRODUCTION` environment. See [Activation States](https://techdocs.akamai.com/network-lists/reference/activation-states) for details on each activation state. Available only when using the `extended` query parameter to retrieve network list data. example: INACTIVE type: string enum: - INACTIVE - ACTIVE - MODIFIED - PENDING_ACTIVATION - FAILED - PENDING_DEACTIVATION expeditedStagingActivationStatus: description: For clients with access to _expedited_ activations on select servers, provides the most recent activation status in the `STAGING` environment. See [Activation States](https://techdocs.akamai.com/network-lists/reference/activation-states) for details on each activation state. Available only when using the `extended` query parameter to retrieve network list data. example: INACTIVE type: string enum: - INACTIVE - ACTIVE - MODIFIED - PENDING_ACTIVATION - FAILED - PENDING_DEACTIVATION groupId: description: Identifies the group where you want to create the list. You need to have write access to the group you specify. If you include a `groupId`, you need to pair it with a `contractId`. type: number links: additionalProperties: false description: Encapsulates the set of [API hypermedia](https://techdocs.akamai.com/network-lists/reference/api-hypermedia) to access a set of resources related to this network list. The object is arranged as a hash of keys, each of which represents a link relation. type: object properties: activateInProduction: additionalProperties: false description: A link to [Activate a network list](https://techdocs.akamai.com/network-lists/reference/post-network-list-activate) in the `PRODUCTION` environment. type: object required: - href properties: detail: description: Any additional information about the target of the link. type: string href: description: URL to access or perform the action on a related resource. May be expressed as an absolute server path, or relative to the current URL call. type: string method: default: GET description: The HTTP method with which to call the `href`, `GET` by default. type: string x-akamai: file-path: schemas/link.yaml activateInStaging: additionalProperties: false description: A link to [Activate a network list](https://techdocs.akamai.com/network-lists/reference/post-network-list-activate) in the `STAGING` environment. type: object required: - href properties: detail: description: Any additional information about the target of the link. type: string href: description: URL to access or perform the action on a related resource. May be expressed as an absolute server path, or relative to the current URL call. type: string method: default: GET description: The HTTP method with which to call the `href`, `GET` by default. type: string x-akamai: file-path: schemas/link.yaml activationDetails: additionalProperties: false description: A link to [Get activation details](https://techdocs.akamai.com/network-lists/reference/get-activation). type: object required: - href properties: detail: description: Any additional information about the target of the link. type: string href: description: URL to access or perform the action on a related resource. May be expressed as an absolute server path, or relative to the current URL call. type: string method: default: GET description: The HTTP method with which to call the `href`, `GET` by default. type: string x-akamai: file-path: schemas/link.yaml appendItems: additionalProperties: false description: A link to [Append elements to a network list](https://techdocs.akamai.com/network-lists/reference/post-network-list-append). type: object required: - href properties: detail: description: Any additional information about the target of the link. type: string href: description: URL to access or perform the action on a related resource. May be expressed as an absolute server path, or relative to the current URL call. type: string method: default: GET description: The HTTP method with which to call the `href`, `GET` by default. type: string x-akamai: file-path: schemas/link.yaml retrieve: additionalProperties: false description: A link to [Get a network list](https://techdocs.akamai.com/network-lists/reference/get-network-list). type: object required: - href properties: detail: description: Any additional information about the target of the link. type: string href: description: URL to access or perform the action on a related resource. May be expressed as an absolute server path, or relative to the current URL call. type: string method: default: GET description: The HTTP method with which to call the `href`, `GET` by default. type: string x-akamai: file-path: schemas/link.yaml statusInProduction: additionalProperties: false description: A link to [Get activation status](https://techdocs.akamai.com/network-lists/reference/get-network-list-status) for the `PRODUCTION` environment. type: object required: - href properties: detail: description: Any additional information about the target of the link. type: string href: description: URL to access or perform the action on a related resource. May be expressed as an absolute server path, or relative to the current URL call. type: string method: default: GET description: The HTTP method with which to call the `href`, `GET` by default. type: string x-akamai: file-path: schemas/link.yaml statusInStaging: additionalProperties: false description: A link to [Get activation status](https://techdocs.akamai.com/network-lists/reference/get-network-list-status) for the `STAGING` environment. type: object required: - href properties: detail: description: Any additional information about the target of the link. type: string href: description: URL to access or perform the action on a related resource. May be expressed as an absolute server path, or relative to the current URL call. type: string method: default: GET description: The HTTP method with which to call the `href`, `GET` by default. type: string x-akamai: file-path: schemas/link.yaml update: additionalProperties: false description: A link to [Update a network list](https://techdocs.akamai.com/network-lists/reference/put-network-list). type: object required: - href properties: detail: description: Any additional information about the target of the link. type: string href: description: URL to access or perform the action on a related resource. May be expressed as an absolute server path, or relative to the current URL call. type: string method: default: GET description: The HTTP method with which to call the `href`, `GET` by default. type: string x-akamai: file-path: schemas/link.yaml list: description: Defines the network list's set of elements. If the `type` is `IP`, values are any combination of IPv4 addresses, IPv6 addresses, or CIDR blocks. If the `type` is `GEO`, values are ISO 3166 two-character country codes. This array does not appear in the object if you get it with the `includeElements` query parameter set to `false`. type: array items: example: FR minLength: 0 type: string name: description: Display name of the network list. maxLength: 100 minLength: 1 type: string networkListType: description: If set to `extendedNetworkListResponse`, indicates that the current data features members enabled with the `extended` query parameter. Otherwise a plain `networkListResponse` value indicates this additional data is absent. example: extendedNetworkListResponse type: string enum: - networkListResponse - extendedNetworkListResponse productionActivationStatus: description: The most recent activation status of the current list in the `PRODUCTION` environment. See [Activation States](https://techdocs.akamai.com/network-lists/reference/activation-states) for details on each activation state. Available only when using the `extended` query parameter to retrieve network list data. example: INACTIVE type: string enum: - INACTIVE - ACTIVE - MODIFIED - PENDING_ACTIVATION - FAILED - PENDING_DEACTIVATION readOnly: default: false description: If `true`, indicates that you don't have permission to modify the network list. This may indicate either a network list that Akamai manages, or insufficient permission for your API client's identity to modify a customer-managed list. The default value is `false`. type: boolean shared: default: false description: Indicates if this list has been shared with you by Akamai or some other account. Shared lists are always read-only. type: boolean stagingActivationStatus: description: The most recent activation status of the current list in the `STAGING` environment. See [Activation States](https://techdocs.akamai.com/network-lists/reference/activation-states) for details on each activation state. Available only when using the `extended` query parameter to retrieve network list data. example: INACTIVE type: string enum: - INACTIVE - ACTIVE - MODIFIED - PENDING_ACTIVATION - FAILED - PENDING_DEACTIVATION syncPoint: default: 0 description: Identifies each version of the network list, which increments each time it's modified. You need to include this value in any requests to modify the list. See [Concurrency control](https://techdocs.akamai.com/network-lists/reference/concurrency-control) for details. minimum: 0 type: integer type: description: The network list type, either `IP` for IP addresses and CIDR blocks, or `GEO` for two-letter country codes. type: string enum: - IP - GEO uniqueId: description: A unique identifier for each network list, corresponding to the `networkListId` URL parameter. minLength: 3 readOnly: true type: string updateDate: description: ISO 8601 timestamp indicating when the network list was last modified. Available only when using the `extended` query parameter to retrieve network list data. example: '2017-06-01T15:13:40.36Z' format: date-time type: string updatedBy: description: Username of this list's creator. Available only when using the `extended` query parameter to retrieve network list data. type: string x-akamai: file-path: schemas/retrieve.yaml '400': description: Incorrect client input. See the field errors provided in the response for more information. This error may also be returned in place of a 404 if a URL parameter was provided in an incorrect format. content: application/problem+json: schema: additionalProperties: false type: object required: - type - status - title properties: detail: description: Detailed error message provided by the server. type: string errors: type: array items: additionalProperties: false type: object required: - type - status - title properties: detail: description: Detailed error message provided by the server. type: string fieldErrors: description: Pointers to fields for which invalid input was provided, whose values are messages detailing the reason this input was invalid for this field. type: object additionalProperties: type: string instance: description: Referenceable URL for this error occurrence. example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749 type: string status: description: HTTP status code. example: 404 type: integer title: description: Title for the error. example: Not Found type: string type: description: URL for the error type. example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND type: string x-akamai: file-path: schemas/error-nested.yaml fieldErrors: description: Pointers to fields for which invalid input was provided, whose values are messages detailing the reason this input was invalid for this field. type: object additionalProperties: type: string instance: description: Referenceable URL for this error occurrence. example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749 type: string status: description: HTTP status code. example: 404 type: integer title: description: Title for the error. example: Not Found type: string type: description: URL for the error type. example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND type: string x-akamai: file-path: schemas/error.yaml '403': description: Forbidden. You don't have permission to perform that function on this network list. Check that your user has the required privileges. content: application/problem+json: schema: additionalProperties: false type: object required: - type - status - title properties: detail: description: Detailed error message provided by the server. type: string errors: type: array items: additionalProperties: false type: object required: - type - status - title properties: detail: description: Detailed error message provided by the server. type: string fieldErrors: description: Pointers to fields for which invalid input was provided, whose values are messages detailing the reason this input was invalid for this field. type: object additionalProperties: type: string instance: description: Referenceable URL for this error occurrence. example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749 type: string status: description: HTTP status code. example: 404 type: integer title: description: Title for the error. example: Not Found type: string type: description: URL for the error type. example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND type: string x-akamai: file-path: schemas/error-nested.yaml fieldErrors: description: Pointers to fields for which invalid input was provided, whose values are messages detailing the reason this input was invalid for this field. type: object additionalProperties: type: string instance: description: Referenceable URL for this error occurrence. example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749 type: string status: description: HTTP status code. example: 404 type: integer title: description: Title for the error. example: Not Found type: string type: description: URL for the error type. example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND type: string x-akamai: file-path: schemas/error.yaml '404': description: Incorrect URL. Check that the network list ID and other URL parameters are valid. content: application/problem+json: schema: additionalProperties: false type: object required: - type - status - title properties: detail: description: Detailed error message provided by the server. type: string errors: type: array items: additionalProperties: false type: object required: - type - status - title properties: detail: description: Detailed error message provided by the server. type: string fieldErrors: description: Pointers to fields for which invalid input was provided, whose values are messages detailing the reason this input was invalid for this field. type: object additionalProperties: type: string instance: description: Referenceable URL for this error occurrence. example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749 type: string status: description: HTTP status code. example: 404 type: integer title: description: Title for the error. example: Not Found type: string type: description: URL for the error type. example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND type: string x-akamai: file-path: schemas/error-nested.yaml fieldErrors: description: Pointers to fields for which invalid input was provided, whose values are messages detailing the reason this input was invalid for this field. type: object additionalProperties: type: string instance: description: Referenceable URL for this error occurrence. example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749 type: string status: description: HTTP status code. example: 404 type: integer title: description: Title for the error. example: Not Found type: string type: description: URL for the error type. example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND type: string x-akamai: file-path: schemas/error.yaml '500': description: We encountered an unexpected issue while processing your request. Please follow the advice provided in the message. content: application/problem+json: schema: additionalProperties: false type: object required: - type - status - title properties: detail: description: Detailed error message provided by the server. type: string errors: type: array items: additionalProperties: false type: object required: - type - status - title properties: detail: description: Detailed error message provided by the server. type: string fieldErrors: description: Pointers to fields for which invalid input was provided, whose values are messages detailing the reason this input was invalid for this field. type: object additionalProperties: type: string instance: description: Referenceable URL for this error occurrence. example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749 type: string status: description: HTTP status code. example: 404 type: integer title: description: Title for the error. example: Not Found type: string type: description: URL for the error type. example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND type: string x-akamai: file-path: schemas/error-nested.yaml fieldErrors: description: Pointers to fields for which invalid input was provided, whose values are messages detailing the reason this input was invalid for this field. type: object additionalProperties: type: string instance: description: Referenceable URL for this error occurrence. example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749 type: string status: description: HTTP status code. example: 404 type: integer title: description: Title for the error. example: Not Found type: string type: description: URL for the error type. example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND type: string x-akamai: file-path: schemas/error.yaml parameters: - description: For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys). example: '{{accountSwitchKey}}' in: query name: accountSwitchKey required: false schema: example: 1-5C0YLB:1-8BYUX type: string get: description: List all network lists available for an authenticated user who belongs to a group, optionally filtered by `listType` or based on a `search` string. Results appear within the `networkLists` array, which might be empty if no network lists are available to the client. operationId: get-network-lists summary: Akamai List Network Lists tags: - Network lists externalDocs: description: See documentation for this operation in Akamai's Network Lists API url: https://techdocs.akamai.com/network-lists/reference/get-network-lists responses: '200': description: Successful response. content: application/json: example: links: create: href: /network-list/v2/network-lists/ method: POST networkLists: - accessControlGroup: 'KSD with ION 3-13H1234' elementCount: 3011 name: General List networkListType: networkListResponse readOnly: false shared: false syncPoint: 22 type: IP uniqueId: 25614_GENERALLIST links: activateInProduction: href: /network-list/v2/network-lists/25614_GENERALLIST/environments/PRODUCTION/activate method: POST activateInStaging: href: /network-list/v2/network-lists/25614_GENERALLIST/environments/STAGING/activate method: POST appendItems: href: /network-list/v2/network-lists/25614_GENERALLIST method: POST retrieve: href: /network-list/v2/network-lists/25614_GENERALLIST statusInProduction: href: /network-list/v2/network-lists/25614_GENERALLIST/environments/PRODUCTION/status statusInStaging: href: /network-list/v2/network-lists/25614_GENERALLIST/environments/STAGING/status update: href: /network-list/v2/network-lists/25614_GENERALLIST method: PUT - elementCount: 235 name: Ec2 Akamai Network List networkListType: networkListResponse readOnly: true shared: true syncPoint: 65 type: IP uniqueId: 1024_AMAZONELASTICCOMPUTECLOU links: activateInProduction: href: /network-list/v2/network-lists/1024_AMAZONELASTICCOMPUTECLOU/environments/PRODUCTION/activate method: POST activateInStaging: href: /network-list/v2/network-lists/1024_AMAZONELASTICCOMPUTECLOU/environments/STAGING/activate method: POST appendItems: href: /network-list/v2/network-lists/1024_AMAZONELASTICCOMPUTECLOU/append method: POST retrieve: href: /network-list/v2/network-lists/1024_AMAZONELASTICCOMPUTECLOU statusInProduction: href: /network-list/v2/network-lists/1024_AMAZONELASTICCOMPUTECLOU/environments/PRODUCTION/status statusInStaging: href: /network-list/v2/network-lists/1024_AMAZONELASTICCOMPUTECLOU/environments/STAGING/status update: href: /network-list/v2/network-lists/1024_AMAZONELASTICCOMPUTECLOU method: PUT - accessControlGroup: 'KSD Test - 3-13H5523' elementCount: 16 name: GeoList_1913New networkListType: networkListResponse readOnly: false shared: false syncPoint: 2 type: GEO uniqueId: 26732_GEOLIST1913 links: activateInProduction: href: /network-list/v2/network-lists/26732_GEOLIST1913/environments/PRODUCTION/activate method: POST activateInStaging: href: /network-list/v2/network-lists/26732_GEOLIST1913/environments/STAGING/activate method: POST appendItems: href: /network-list/v2/network-lists/26732_GEOLIST1913/append method: POST retrieve: href: /network-list/v2/network-lists/26732_GEOLIST1913 statusInProduction: href: /network-list/v2/network-lists/26732_GEOLIST1913/environments/PRODUCTION/status statusInStaging: href: /network-list/v2/network-lists/26732_GEOLIST1913/environments/STAGING/status update: href: /network-list/v2/network-lists/26732_GEOLIST1913 method: PUT schema: additionalProperties: false type: object required: - networkLists properties: links: properties: create: additionalProperties: false description: When [listing network lists](https://techdocs.akamai.com/network-lists/reference/put-network-list), provides a link to [Create a new network list](https://techdocs.akamai.com/network-lists/reference/post-network-lists). type: object required: - href properties: detail: description: Any additional information about the target of the link. type: string href: description: URL to access or perform the action on a related resource. May be expressed as an absolute server path, or relative to the current URL call. type: string method: default: GET description: The HTTP method with which to call the `href`, `GET` by default. type: string x-akamai: file-path: schemas/link.yaml networkLists: description: The set of network lists. type: array items: additionalProperties: false description: Encapsulates information about each network list. type: object required: - name - syncPoint - uniqueId - type properties: accessControlGroup: description: Name of this network list's access control group (ACG). type: string contractId: description: Identifies the contract where you want to create the list. You need to have write access to the contract you specify. If you include a `contractId`, you need to pair it with a `groupId`. maxLength: 20 minLength: 5 type: string createDate: description: ISO 8601 timestamp indicating when the network list was first created. Available only when using the `extended` query parameter to retrieve network list data. example: '2017-06-01T15:13:40.36Z' format: date-time readOnly: true type: string createdBy: description: Username of this list's creator. Available only when using the `extended` query parameter to retrieve network list data. readOnly: true type: string description: description: Detailed description of the list. maxLength: 255 minLength: 1 type: string elementCount: description: Reflects the number of elements in the `list` array, which may not necessarily appear in the object when retrieving the list with the `includeElements` query parameter set to `false`. readOnly: true type: integer expeditedProductionActivationStatus: description: For clients with access to _expedited_ activations on select servers, provides the most recent activation status in the `PRODUCTION` environment. See [Activation States](https://techdocs.akamai.com/network-lists/reference/activation-states) for details on each activation state. Available only when using the `extended` query parameter to retrieve network list data. example: INACTIVE readOnly: true type: string enum: - INACTIVE - ACTIVE - MODIFIED - PENDING_ACTIVATION - FAILED - PENDING_DEACTIVATION expeditedStagingActivationStatus: description: For clients with access to _expedited_ activations on select servers, provides the most recent activation status in the `STAGING` environment. See [Activation States](https://techdocs.akamai.com/network-lists/reference/activation-states) for details on each activation state. Available only when using the `extended` query parameter to retrieve network list data. example: INACTIVE readOnly: true type: string enum: - INACTIVE - ACTIVE - MODIFIED - PENDING_ACTIVATION - FAILED - PENDING_DEACTIVATION groupId: description: Identifies the group where you want to create the list. You need to have write access to the group you specify. If you include a `groupId`, you need to pair it with a `contractId`. type: number links: additionalProperties: false description: Encapsulates the set of [API hypermedia](https://techdocs.akamai.com/network-lists/reference/api-hypermedia) to access a set of resources related to this network list. The object is arranged as a hash of keys, each of which represents a link relation. type: object properties: activateInProduction: additionalProperties: false description: A link to [Activate a network list](https://techdocs.akamai.com/network-lists/reference/post-network-list-activate) in the `PRODUCTION` environment. type: object required: - href properties: detail: description: Any additional information about the target of the link. type: string href: description: URL to access or perform the action on a related resource. May be expressed as an absolute server path, or relative to the current URL call. type: string method: default: GET description: The HTTP method with which to call the `href`, `GET` by default. type: string x-akamai: file-path: schemas/link.yaml activateInStaging: additionalProperties: false description: A link to [Activate a network list](https://techdocs.akamai.com/network-lists/reference/post-network-list-activate) in the `STAGING` environment. type: object required: - href properties: detail: description: Any additional information about the target of the link. type: string href: description: URL to access or perform the action on a related resource. May be expressed as an absolute server path, or relative to the current URL call. type: string method: default: GET description: The HTTP method with which to call the `href`, `GET` by default. type: string x-akamai: file-path: schemas/link.yaml activationDetails: additionalProperties: false description: A link to [Get activation details](https://techdocs.akamai.com/network-lists/reference/get-activation). type: object required: - href properties: detail: description: Any additional information about the target of the link. type: string href: description: URL to access or perform the action on a related resource. May be expressed as an absolute server path, or relative to the current URL call. type: string method: default: GET description: The HTTP method with which to call the `href`, `GET` by default. type: string x-akamai: file-path: schemas/link.yaml appendItems: additionalProperties: false description: A link to [Append elements to a network list](https://techdocs.akamai.com/network-lists/reference/post-network-list-append). type: object required: - href properties: detail: description: Any additional information about the target of the link. type: string href: description: URL to access or perform the action on a related resource. May be expressed as an absolute server path, or relative to the current URL call. type: string method: default: GET description: The HTTP method with which to call the `href`, `GET` by default. type: string x-akamai: file-path: schemas/link.yaml retrieve: additionalProperties: false description: A link to [Get a network list](https://techdocs.akamai.com/network-lists/reference/get-network-list). type: object required: - href properties: detail: description: Any additional information about the target of the link. type: string href: description: URL to access or perform the action on a related resource. May be expressed as an absolute server path, or relative to the current URL call. type: string method: default: GET description: The HTTP method with which to call the `href`, `GET` by default. type: string x-akamai: file-path: schemas/link.yaml statusInProduction: additionalProperties: false description: A link to [Get activation status](https://techdocs.akamai.com/network-lists/reference/get-network-list-status) for the `PRODUCTION` environment. type: object required: - href properties: detail: description: Any additional information about the target of the link. type: string href: description: URL to access or perform the action on a related resource. May be expressed as an absolute server path, or relative to the current URL call. type: string method: default: GET description: The HTTP method with which to call the `href`, `GET` by default. type: string x-akamai: file-path: schemas/link.yaml statusInStaging: additionalProperties: false description: A link to [Get activation status](https://techdocs.akamai.com/network-lists/reference/get-network-list-status) for the `STAGING` environment. type: object required: - href properties: detail: description: Any additional information about the target of the link. type: string href: description: URL to access or perform the action on a related resource. May be expressed as an absolute server path, or relative to the current URL call. type: string method: default: GET description: The HTTP method with which to call the `href`, `GET` by default. type: string x-akamai: file-path: schemas/link.yaml update: additionalProperties: false description: A link to [Update a network list](https://techdocs.akamai.com/network-lists/reference/put-network-list). type: object required: - href properties: detail: description: Any additional information about the target of the link. type: string href: description: URL to access or perform the action on a related resource. May be expressed as an absolute server path, or relative to the current URL call. type: string method: default: GET description: The HTTP method with which to call the `href`, `GET` by default. type: string x-akamai: file-path: schemas/link.yaml list: description: Defines the network list's set of elements. If the `type` is `IP`, values are any combination of IPv4 addresses, IPv6 addresses, or CIDR blocks. If the `type` is `GEO`, values are ISO 3166 two-character country codes. This array does not appear in the object if you get it with the `includeElements` query parameter set to `false`. type: array items: example: FR minLength: 0 type: string name: description: Display name of the network list. maxLength: 100 minLength: 1 type: string networkListType: description: If set to `extendedNetworkListResponse`, indicates that the current data features members enabled with the `extended` query parameter. Otherwise a plain `networkListResponse` value indicates this additional data is absent. example: extendedNetworkListResponse type: string enum: - networkListResponse - extendedNetworkListResponse productionActivationStatus: description: The most recent activation status of the current list in the `PRODUCTION` environment. See [Activation States](https://techdocs.akamai.com/network-lists/reference/activation-states) for details on each activation state. Available only when using the `extended` query parameter to retrieve network list data. example: INACTIVE readOnly: true type: string enum: - INACTIVE - ACTIVE - MODIFIED - PENDING_ACTIVATION - FAILED - PENDING_DEACTIVATION readOnly: default: false description: If `true`, indicates that you don't have permission to modify the network list. This may indicate either a network list that Akamai manages, or insufficient permission for your API client's identity to modify a customer-managed list. readOnly: true type: boolean shared: default: false description: If `true`, indicates that this list has been shared with you by Akamai or some other account. Shared lists are always read-only. readOnly: true type: boolean stagingActivationStatus: description: The most recent activation status of the current list in the `STAGING` environment. See [Activation States](https://techdocs.akamai.com/network-lists/reference/activation-states) for details on each activation state. Available only when using the `extended` query parameter to retrieve network list data. example: INACTIVE readOnly: true type: string enum: - INACTIVE - ACTIVE - MODIFIED - PENDING_ACTIVATION - FAILED - PENDING_DEACTIVATION syncPoint: default: 0 description: Identifies each version of the network list, which increments each time it's modified. You need to include this value in any requests to modify the list. See [Concurrency control](https://techdocs.akamai.com/network-lists/reference/concurrency-control) for details. minimum: 0 type: integer type: description: The network list type, either `IP` for IP addresses and CIDR blocks, or `GEO` for two-letter country codes. type: string enum: - IP - GEO uniqueId: description: A unique identifier for each network list, corresponding to the `networkListId` URL parameter. minLength: 3 readOnly: true type: string updateDate: description: ISO 8601 timestamp indicating when the network list was last modified. Available only when using the `extended` query parameter to retrieve network list data. example: '2017-06-01T15:13:40.36Z' format: date-time readOnly: true type: string updatedBy: description: Username of this list's creator. Available only when using the `extended` query parameter to retrieve network list data. readOnly: true type: string x-akamai: file-path: schemas/network-list.yaml x-akamai: file-path: schemas/lists.yaml '400': description: Incorrect client input. See the field errors provided in the response for more information. This error may also be returned in place of a 404 if a URL parameter was provided in an incorrect format. content: application/problem+json: schema: additionalProperties: false type: object required: - type - status - title properties: detail: description: Detailed error message provided by the server. type: string errors: type: array items: additionalProperties: false type: object required: - type - status - title properties: detail: description: Detailed error message provided by the server. type: string fieldErrors: description: Pointers to fields for which invalid input was provided, whose values are messages detailing the reason this input was invalid for this field. type: object additionalProperties: type: string instance: description: Referenceable URL for this error occurrence. example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749 type: string status: description: HTTP status code. example: 404 type: integer title: description: Title for the error. example: Not Found type: string type: description: URL for the error type. example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND type: string x-akamai: file-path: schemas/error-nested.yaml fieldErrors: description: Pointers to fields for which invalid input was provided, whose values are messages detailing the reason this input was invalid for this field. type: object additionalProperties: type: string instance: description: Referenceable URL for this error occurrence. example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749 type: string status: description: HTTP status code. example: 404 type: integer title: description: Title for the error. example: Not Found type: string type: description: URL for the error type. example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND type: string x-akamai: file-path: schemas/error.yaml '404': description: Incorrect URL. Check that the network list ID and other URL parameters are valid. content: application/problem+json: schema: additionalProperties: false type: object required: - type - status - title properties: detail: description: Detailed error message provided by the server. type: string errors: type: array items: additionalProperties: false type: object required: - type - status - title properties: detail: description: Detailed error message provided by the server. type: string fieldErrors: description: Pointers to fields for which invalid input was provided, whose values are messages detailing the reason this input was invalid for this field. type: object additionalProperties: type: string instance: description: Referenceable URL for this error occurrence. example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749 type: string status: description: HTTP status code. example: 404 type: integer title: description: Title for the error. example: Not Found type: string type: description: URL for the error type. example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND type: string x-akamai: file-path: schemas/error-nested.yaml fieldErrors: description: Pointers to fields for which invalid input was provided, whose values are messages detailing the reason this input was invalid for this field. type: object additionalProperties: type: string instance: description: Referenceable URL for this error occurrence. example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749 type: string status: description: HTTP status code. example: 404 type: integer title: description: Title for the error. example: Not Found type: string type: description: URL for the error type. example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND type: string x-akamai: file-path: schemas/error.yaml '500': description: We encountered an unexpected issue while processing your request. Please follow the advice provided in the message. content: application/problem+json: schema: additionalProperties: false type: object required: - type - status - title properties: detail: description: Detailed error message provided by the server. type: string errors: type: array items: additionalProperties: false type: object required: - type - status - title properties: detail: description: Detailed error message provided by the server. type: string fieldErrors: description: Pointers to fields for which invalid input was provided, whose values are messages detailing the reason this input was invalid for this field. type: object additionalProperties: type: string instance: description: Referenceable URL for this error occurrence. example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749 type: string status: description: HTTP status code. example: 404 type: integer title: description: Title for the error. example: Not Found type: string type: description: URL for the error type. example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND type: string x-akamai: file-path: schemas/error-nested.yaml fieldErrors: description: Pointers to fields for which invalid input was provided, whose values are messages detailing the reason this input was invalid for this field. type: object additionalProperties: type: string instance: description: Referenceable URL for this error occurrence. example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749 type: string status: description: HTTP status code. example: 404 type: integer title: description: Title for the error. example: Not Found type: string type: description: URL for the error type. example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND type: string x-akamai: file-path: schemas/error.yaml parameters: - description: If enabled, the response `list` includes all items. For large network lists, this may slow responses and yield large response objects. The default `false` value when listing more than one network list omits the network list's elements and only provides higher-level metadata. example: '{{includeElements}}' in: query name: includeElements schema: default: false example: true type: boolean x-akamai: file-path: parameters/includeElements-query.yaml - description: Only list items that match the specified substring in any network list's `name` or `list` of items. example: '{{search}}' in: query name: search schema: example: 192.168. type: string x-akamai: file-path: parameters/search-query.yaml - description: __Enum__ Filters the output to lists of only the given type of network lists if provided, either `IP` or `GEO`. This corresponds to the network list object's `type` member. example: '{{listType}}' in: query name: listType schema: example: IP type: string enum: - IP - GEO x-akamai: file-path: parameters/listType_listType.yaml - description: When enabled, provides additional response data identifying who created and updated the list and when, and the network list's deployment status in both `STAGING` and `PRODUCTION` environments. This data takes longer to provide. example: '{{extended}}' in: query name: extended schema: default: false example: true type: boolean x-akamai: file-path: parameters/extended_extended.yaml - description: For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys). example: '{{accountSwitchKey}}' in: query name: accountSwitchKey required: false schema: example: 1-5C0YLB:1-8BYUX type: string /network-lists/{networkListId}: parameters: - description: Unique identifier for each network list. example: '{{networkListId}}' in: path name: networkListId required: true schema: example: 12345_BLACKLISTEDGEOS type: string x-akamai: file-path: parameters/networkListId-path.yaml get: description: Gets a network list's most recent `syncPoint` version. operationId: get-network-list summary: Akamai Get a Network List tags: - Network lists externalDocs: description: See documentation for this operation in Akamai's Network Lists API url: https://techdocs.akamai.com/network-lists/reference/get-network-list responses: '200': description: Successful response. content: application/json: example: contractId: K-0N7RAK7 elementCount: 13 groupId: 517014 name: My Network List networkListType: networkListResponse readOnly: true shared: true syncPoint: 65 type: IP uniqueId: 1024_NETWORKLIST list: - 192.0.2.127/24 - 12.129.0.0/15 - 12.211.0.0/15 - 192.0.2.161/24 - 192.0.2.113/24 - 12.231.0.0/14 - 12.235.0.0/14 - 192.0.2.111/24 - 192.0.2.165/24 - 192.0.2.57/24 - 192.0.2.98/24 - 192.0.2.103/24 - 192.0.2.139/24 links: activateInProduction: href: /network-list/v2/network-lists/1024_AMAZONELASTICCOMPUTECLOU/environments/PRODUCTION/activate method: POST activateInStaging: href: /network-list/v2/network-lists/1024_AMAZONELASTICCOMPUTECLOU/environments/STAGING/activate method: POST appendItems: href: /network-list/v2/network-lists/1024_AMAZONELASTICCOMPUTECLOU/append method: POST retrieve: href: /network-list/v2/network-lists/1024_AMAZONELASTICCOMPUTECLOU statusInProduction: href: /network-list/v2/network-lists/1024_AMAZONELASTICCOMPUTECLOU/environments/PRODUCTION/status statusInStaging: href: /network-list/v2/network-lists/1024_AMAZONELASTICCOMPUTECLOU/environments/STAGING/status update: href: /network-list/v2/network-lists/1024_AMAZONELASTICCOMPUTECLOU method: PUT schema: additionalProperties: false description: Encapsulates information about each network list. type: object required: - name - syncPoint - type - uniqueId properties: accessControlGroup: description: Name of this network list's access control group (ACG). type: string contractId: description: Identifies the contract where you want to create the list. You need to have write access to the contract you specify. If you include a `contractId`, you need to pair it with a `groupId`. maxLength: 20 minLength: 5 type: string createDate: description: ISO 8601 timestamp indicating when the network list was first created. Available only when using the `extended` query parameter to retrieve network list data. example: '2017-06-01T15:13:40.36Z' format: date-time type: string createdBy: description: Username of this list's creator. Available only when using the `extended` query parameter to retrieve network list data. type: string description: description: Detailed description of the list. maxLength: 255 minLength: 1 type: string elementCount: description: Reflects the number of elements in the `list` array, which may not necessarily appear in the object when retrieving the list with the `includeElements` query parameter set to `false`. type: integer expeditedProductionActivationStatus: description: For clients with access to _expedited_ activations on select servers, provides the most recent activation status in the `PRODUCTION` environment. See [Activation States](https://techdocs.akamai.com/network-lists/reference/activation-states) for details on each activation state. Available only when using the `extended` query parameter to retrieve network list data. example: INACTIVE type: string enum: - INACTIVE - ACTIVE - MODIFIED - PENDING_ACTIVATION - FAILED - PENDING_DEACTIVATION expeditedStagingActivationStatus: description: For clients with access to _expedited_ activations on select servers, provides the most recent activation status in the `STAGING` environment. See [Activation States](https://techdocs.akamai.com/network-lists/reference/activation-states) for details on each activation state. Available only when using the `extended` query parameter to retrieve network list data. example: INACTIVE type: string enum: - INACTIVE - ACTIVE - MODIFIED - PENDING_ACTIVATION - FAILED - PENDING_DEACTIVATION groupId: description: Identifies the group where you want to create the list. You need to have write access to the group you specify. If you include a `groupId`, you need to pair it with a `contractId`. type: number links: additionalProperties: false description: Encapsulates the set of [API hypermedia](https://techdocs.akamai.com/network-lists/reference/api-hypermedia) to access a set of resources related to this network list. The object is arranged as a hash of keys, each of which represents a link relation. type: object properties: activateInProduction: additionalProperties: false description: A link to [Activate a network list](https://techdocs.akamai.com/network-lists/reference/post-network-list-activate) in the `PRODUCTION` environment. type: object required: - href properties: detail: description: Any additional information about the target of the link. type: string href: description: URL to access or perform the action on a related resource. May be expressed as an absolute server path, or relative to the current URL call. type: string method: default: GET description: The HTTP method with which to call the `href`, `GET` by default. type: string x-akamai: file-path: schemas/link.yaml activateInStaging: additionalProperties: false description: A link to [Activate a network list](https://techdocs.akamai.com/network-lists/reference/post-network-list-activate) in the `STAGING` environment. type: object required: - href properties: detail: description: Any additional information about the target of the link. type: string href: description: URL to access or perform the action on a related resource. May be expressed as an absolute server path, or relative to the current URL call. type: string method: default: GET description: The HTTP method with which to call the `href`, `GET` by default. type: string x-akamai: file-path: schemas/link.yaml activationDetails: additionalProperties: false description: A link to [Get activation details](https://techdocs.akamai.com/network-lists/reference/get-activation). type: object required: - href properties: detail: description: Any additional information about the target of the link. type: string href: description: URL to access or perform the action on a related resource. May be expressed as an absolute server path, or relative to the current URL call. type: string method: default: GET description: The HTTP method with which to call the `href`, `GET` by default. type: string x-akamai: file-path: schemas/link.yaml appendItems: additionalProperties: false description: A link to [Append elements to a network list](https://techdocs.akamai.com/network-lists/reference/post-network-list-append). type: object required: - href properties: detail: description: Any additional information about the target of the link. type: string href: description: URL to access or perform the action on a related resource. May be expressed as an absolute server path, or relative to the current URL call. type: string method: default: GET description: The HTTP method with which to call the `href`, `GET` by default. type: string x-akamai: file-path: schemas/link.yaml retrieve: additionalProperties: false description: A link to [Get a network list](https://techdocs.akamai.com/network-lists/reference/get-network-list). type: object required: - href properties: detail: description: Any additional information about the target of the link. type: string href: description: URL to access or perform the action on a related resource. May be expressed as an absolute server path, or relative to the current URL call. type: string method: default: GET description: The HTTP method with which to call the `href`, `GET` by default. type: string x-akamai: file-path: schemas/link.yaml statusInProduction: additionalProperties: false description: A link to [Get activation status](https://techdocs.akamai.com/network-lists/reference/get-network-list-status) for the `PRODUCTION` environment. type: object required: - href properties: detail: description: Any additional information about the target of the link. type: string href: description: URL to access or perform the action on a related resource. May be expressed as an absolute server path, or relative to the current URL call. type: string method: default: GET description: The HTTP method with which to call the `href`, `GET` by default. type: string x-akamai: file-path: schemas/link.yaml statusInStaging: additionalProperties: false description: A link to [Get activation status](https://techdocs.akamai.com/network-lists/reference/get-network-list-status) for the `STAGING` environment. type: object required: - href properties: detail: description: Any additional information about the target of the link. type: string href: description: URL to access or perform the action on a related resource. May be expressed as an absolute server path, or relative to the current URL call. type: string method: default: GET description: The HTTP method with which to call the `href`, `GET` by default. type: string x-akamai: file-path: schemas/link.yaml update: additionalProperties: false description: A link to [Update a network list](https://techdocs.akamai.com/network-lists/reference/put-network-list). type: object required: - href properties: detail: description: Any additional information about the target of the link. type: string href: description: URL to access or perform the action on a related resource. May be expressed as an absolute server path, or relative to the current URL call. type: string method: default: GET description: The HTTP method with which to call the `href`, `GET` by default. type: string x-akamai: file-path: schemas/link.yaml list: description: Defines the network list's set of elements. If the `type` is `IP`, values are any combination of IPv4 addresses, IPv6 addresses, or CIDR blocks. If the `type` is `GEO`, values are ISO 3166 two-character country codes. This array does not appear in the object if you get it with the `includeElements` query parameter set to `false`. type: array items: example: FR minLength: 0 type: string name: description: Display name of the network list. maxLength: 100 minLength: 1 type: string networkListType: description: If set to `extendedNetworkListResponse`, indicates that the current data features members enabled with the `extended` query parameter. Otherwise a plain `networkListResponse` value indicates this additional data is absent. example: extendedNetworkListResponse type: string enum: - networkListResponse - extendedNetworkListResponse productionActivationStatus: description: The most recent activation status of the current list in the `PRODUCTION` environment. See [Activation States](https://techdocs.akamai.com/network-lists/reference/activation-states) for details on each activation state. Available only when using the `extended` query parameter to retrieve network list data. example: INACTIVE type: string enum: - INACTIVE - ACTIVE - MODIFIED - PENDING_ACTIVATION - FAILED - PENDING_DEACTIVATION readOnly: default: false description: If `true`, indicates that you don't have permission to modify the network list. This may indicate either a network list that Akamai manages, or insufficient permission for your API client's identity to modify a customer-managed list. The default value is `false`. type: boolean shared: default: false description: Indicates if this list has been shared with you by Akamai or some other account. Shared lists are always read-only. type: boolean stagingActivationStatus: description: The most recent activation status of the current list in the `STAGING` environment. See [Activation States](https://techdocs.akamai.com/network-lists/reference/activation-states) for details on each activation state. Available only when using the `extended` query parameter to retrieve network list data. example: INACTIVE type: string enum: - INACTIVE - ACTIVE - MODIFIED - PENDING_ACTIVATION - FAILED - PENDING_DEACTIVATION syncPoint: default: 0 description: Identifies each version of the network list, which increments each time it's modified. You need to include this value in any requests to modify the list. See [Concurrency control](https://techdocs.akamai.com/network-lists/reference/concurrency-control) for details. minimum: 0 type: integer type: description: The network list type, either `IP` for IP addresses and CIDR blocks, or `GEO` for two-letter country codes. type: string enum: - IP - GEO uniqueId: description: A unique identifier for each network list, corresponding to the `networkListId` URL parameter. minLength: 3 readOnly: true type: string updateDate: description: ISO 8601 timestamp indicating when the network list was last modified. Available only when using the `extended` query parameter to retrieve network list data. example: '2017-06-01T15:13:40.36Z' format: date-time type: string updatedBy: description: Username of this list's creator. Available only when using the `extended` query parameter to retrieve network list data. type: string x-akamai: file-path: schemas/retrieve.yaml '400': description: Incorrect client input. See the field errors provided in the response for more information. This error may also be returned in place of a 404 if a URL parameter was provided in an incorrect format. content: application/problem+json: schema: additionalProperties: false type: object required: - type - status - title properties: detail: description: Detailed error message provided by the server. type: string errors: type: array items: additionalProperties: false type: object required: - type - status - title properties: detail: description: Detailed error message provided by the server. type: string fieldErrors: description: Pointers to fields for which invalid input was provided, whose values are messages detailing the reason this input was invalid for this field. type: object additionalProperties: type: string instance: description: Referenceable URL for this error occurrence. example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749 type: string status: description: HTTP status code. example: 404 type: integer title: description: Title for the error. example: Not Found type: string type: description: URL for the error type. example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND type: string x-akamai: file-path: schemas/error-nested.yaml fieldErrors: description: Pointers to fields for which invalid input was provided, whose values are messages detailing the reason this input was invalid for this field. type: object additionalProperties: type: string instance: description: Referenceable URL for this error occurrence. example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749 type: string status: description: HTTP status code. example: 404 type: integer title: description: Title for the error. example: Not Found type: string type: description: URL for the error type. example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND type: string x-akamai: file-path: schemas/error.yaml '404': description: Incorrect URL. Check that the network list ID and other URL parameters are valid. content: application/problem+json: schema: additionalProperties: false type: object required: - type - status - title properties: detail: description: Detailed error message provided by the server. type: string errors: type: array items: additionalProperties: false type: object required: - type - status - title properties: detail: description: Detailed error message provided by the server. type: string fieldErrors: description: Pointers to fields for which invalid input was provided, whose values are messages detailing the reason this input was invalid for this field. type: object additionalProperties: type: string instance: description: Referenceable URL for this error occurrence. example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749 type: string status: description: HTTP status code. example: 404 type: integer title: description: Title for the error. example: Not Found type: string type: description: URL for the error type. example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND type: string x-akamai: file-path: schemas/error-nested.yaml fieldErrors: description: Pointers to fields for which invalid input was provided, whose values are messages detailing the reason this input was invalid for this field. type: object additionalProperties: type: string instance: description: Referenceable URL for this error occurrence. example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749 type: string status: description: HTTP status code. example: 404 type: integer title: description: Title for the error. example: Not Found type: string type: description: URL for the error type. example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND type: string x-akamai: file-path: schemas/error.yaml '500': description: We encountered an unexpected issue while processing your request. Please follow the advice provided in the message. content: application/problem+json: schema: additionalProperties: false type: object required: - type - status - title properties: detail: description: Detailed error message provided by the server. type: string errors: type: array items: additionalProperties: false type: object required: - type - status - title properties: detail: description: Detailed error message provided by the server. type: string fieldErrors: description: Pointers to fields for which invalid input was provided, whose values are messages detailing the reason this input was invalid for this field. type: object additionalProperties: type: string instance: description: Referenceable URL for this error occurrence. example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749 type: string status: description: HTTP status code. example: 404 type: integer title: description: Title for the error. example: Not Found type: string type: description: URL for the error type. example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND type: string x-akamai: file-path: schemas/error-nested.yaml fieldErrors: description: Pointers to fields for which invalid input was provided, whose values are messages detailing the reason this input was invalid for this field. type: object additionalProperties: type: string instance: description: Referenceable URL for this error occurrence. example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749 type: string status: description: HTTP status code. example: 404 type: integer title: description: Title for the error. example: Not Found type: string type: description: URL for the error type. example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND type: string x-akamai: file-path: schemas/error.yaml parameters: - description: When enabled, provides additional response data identifying who created and updated the list and when, and the network list's deployment status in both `STAGING` and `PRODUCTION` environments. This data takes longer to provide. example: '{{extended}}' in: query name: extended schema: default: false example: true type: boolean x-akamai: file-path: parameters/extended_extended.yaml - description: If enabled, the response `list` includes all items. For large network lists, this may slow responses and yield large response objects. The default `true` value includes the list's contents. example: '{{includeElements}}' in: query name: includeElements schema: default: true example: true type: boolean x-akamai: file-path: parameters/includeElements_includeElements.yaml - description: For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys). example: '{{accountSwitchKey}}' in: query name: accountSwitchKey required: false schema: example: 1-5C0YLB:1-8BYUX type: string put: description: Modify the network list items and properties. Allows you to set the name, description and set of network list items to the resource. The current state of the list will be replaced with the properties and items you provide. The type cannot be changed. operationId: put-network-list summary: Akamai Update a Network List tags: - Network lists externalDocs: description: See documentation for this operation in Akamai's Network Lists API url: https://techdocs.akamai.com/network-lists/reference/put-network-list requestBody: required: true content: application/json: example: description: Updated notes about this network list name: My Updated Open List syncPoint: 1 type: IP list: - 192.0.2.225/24 - 192.0.2.83 - 192.0.2.169 schema: additionalProperties: false type: object required: - name - type - list - syncPoint properties: description: description: Detailed description of the list. example: '{{description}}' maxLength: 255 minLength: 1 type: string list: description: Defines the network list's set of elements. If the `type` is `IP`, values are any combination of IPv4 addresses, IPv6 addresses, or CIDR blocks. If the `type` is `GEO`, values are ISO 3166 two-character country codes. This array does not appear in the object if you get it with the `includeElements` query parameter set to `false`. type: array items: example: FR minLength: 0 type: string name: description: Display name of the network list. example: '{{name}}' maxLength: 100 minLength: 1 type: string syncPoint: default: 0 description: Identifies each version of the network list, which increments each time it's modified. You need to include this value in any requests to modify the list. See [Concurrency control](https://techdocs.akamai.com/network-lists/reference/concurrency-control) for details. example: '{{syncPoint}}' minimum: 0 type: integer type: description: The network list type, either `IP` for IP addresses and CIDR blocks, or `GEO` for two-letter country codes. example: '{{type}}' type: string enum: - IP - GEO uniqueId: description: A unique identifier for each network list, corresponding to the `networkListId` URL parameter. example: '{{uniqueId}}' minLength: 3 readOnly: true type: string x-akamai: file-path: schemas/update.yaml responses: '200': description: Successful response. content: application/json: example: contractId: K-0N7RAK7 elementCount: 13 groupId: 517014 name: My Network List networkListType: networkListResponse readOnly: true shared: true syncPoint: 65 type: IP uniqueId: 1024_NETWORKLIST list: - 192.0.2.166/24 - 12.129.0.0/15 - 12.211.0.0/15 - 192.0.2.71/24 - 192.0.2.149/24 - 12.231.0.0/14 - 12.235.0.0/14 - 192.0.2.187/24 - 192.0.2.24/24 - 192.0.2.201/24 - 192.0.2.30/24 - 192.0.2.184/24 - 192.0.2.87/24 links: activateInProduction: href: /network-list/v2/network-lists/1024_AMAZONELASTICCOMPUTECLOU/environments/PRODUCTION/activate method: POST activateInStaging: href: /network-list/v2/network-lists/1024_AMAZONELASTICCOMPUTECLOU/environments/STAGING/activate method: POST appendItems: href: /network-list/v2/network-lists/1024_AMAZONELASTICCOMPUTECLOU/append method: POST retrieve: href: /network-list/v2/network-lists/1024_AMAZONELASTICCOMPUTECLOU statusInProduction: href: /network-list/v2/network-lists/1024_AMAZONELASTICCOMPUTECLOU/environments/PRODUCTION/status statusInStaging: href: /network-list/v2/network-lists/1024_AMAZONELASTICCOMPUTECLOU/environments/STAGING/status update: href: /network-list/v2/network-lists/1024_AMAZONELASTICCOMPUTECLOU method: PUT schema: additionalProperties: false description: Encapsulates information about each network list. type: object required: - name - syncPoint - type - uniqueId properties: accessControlGroup: description: Name of this network list's access control group (ACG). type: string contractId: description: Identifies the contract where you want to create the list. You need to have write access to the contract you specify. If you include a `contractId`, you need to pair it with a `groupId`. maxLength: 20 minLength: 5 type: string createDate: description: ISO 8601 timestamp indicating when the network list was first created. Available only when using the `extended` query parameter to retrieve network list data. example: '2017-06-01T15:13:40.36Z' format: date-time type: string createdBy: description: Username of this list's creator. Available only when using the `extended` query parameter to retrieve network list data. type: string description: description: Detailed description of the list. maxLength: 255 minLength: 1 type: string elementCount: description: Reflects the number of elements in the `list` array, which may not necessarily appear in the object when retrieving the list with the `includeElements` query parameter set to `false`. type: integer expeditedProductionActivationStatus: description: For clients with access to _expedited_ activations on select servers, provides the most recent activation status in the `PRODUCTION` environment. See [Activation States](https://techdocs.akamai.com/network-lists/reference/activation-states) for details on each activation state. Available only when using the `extended` query parameter to retrieve network list data. example: INACTIVE type: string enum: - INACTIVE - ACTIVE - MODIFIED - PENDING_ACTIVATION - FAILED - PENDING_DEACTIVATION expeditedStagingActivationStatus: description: For clients with access to _expedited_ activations on select servers, provides the most recent activation status in the `STAGING` environment. See [Activation States](https://techdocs.akamai.com/network-lists/reference/activation-states) for details on each activation state. Available only when using the `extended` query parameter to retrieve network list data. example: INACTIVE type: string enum: - INACTIVE - ACTIVE - MODIFIED - PENDING_ACTIVATION - FAILED - PENDING_DEACTIVATION groupId: description: Identifies the group where you want to create the list. You need to have write access to the group you specify. If you include a `groupId`, you need to pair it with a `contractId`. type: number links: additionalProperties: false description: Encapsulates the set of [API hypermedia](https://techdocs.akamai.com/network-lists/reference/api-hypermedia) to access a set of resources related to this network list. The object is arranged as a hash of keys, each of which represents a link relation. type: object properties: activateInProduction: additionalProperties: false description: A link to [Activate a network list](https://techdocs.akamai.com/network-lists/reference/post-network-list-activate) in the `PRODUCTION` environment. type: object required: - href properties: detail: description: Any additional information about the target of the link. type: string href: description: URL to access or perform the action on a related resource. May be expressed as an absolute server path, or relative to the current URL call. type: string method: default: GET description: The HTTP method with which to call the `href`, `GET` by default. type: string x-akamai: file-path: schemas/link.yaml activateInStaging: additionalProperties: false description: A link to [Activate a network list](https://techdocs.akamai.com/network-lists/reference/post-network-list-activate) in the `STAGING` environment. type: object required: - href properties: detail: description: Any additional information about the target of the link. type: string href: description: URL to access or perform the action on a related resource. May be expressed as an absolute server path, or relative to the current URL call. type: string method: default: GET description: The HTTP method with which to call the `href`, `GET` by default. type: string x-akamai: file-path: schemas/link.yaml activationDetails: additionalProperties: false description: A link to [Get activation details](https://techdocs.akamai.com/network-lists/reference/get-activation). type: object required: - href properties: detail: description: Any additional information about the target of the link. type: string href: description: URL to access or perform the action on a related resource. May be expressed as an absolute server path, or relative to the current URL call. type: string method: default: GET description: The HTTP method with which to call the `href`, `GET` by default. type: string x-akamai: file-path: schemas/link.yaml appendItems: additionalProperties: false description: A link to [Append elements to a network list](https://techdocs.akamai.com/network-lists/reference/post-network-list-append). type: object required: - href properties: detail: description: Any additional information about the target of the link. type: string href: description: URL to access or perform the action on a related resource. May be expressed as an absolute server path, or relative to the current URL call. type: string method: default: GET description: The HTTP method with which to call the `href`, `GET` by default. type: string x-akamai: file-path: schemas/link.yaml retrieve: additionalProperties: false description: A link to [Get a network list](https://techdocs.akamai.com/network-lists/reference/get-network-list). type: object required: - href properties: detail: description: Any additional information about the target of the link. type: string href: description: URL to access or perform the action on a related resource. May be expressed as an absolute server path, or relative to the current URL call. type: string method: default: GET description: The HTTP method with which to call the `href`, `GET` by default. type: string x-akamai: file-path: schemas/link.yaml statusInProduction: additionalProperties: false description: A link to [Get activation status](https://techdocs.akamai.com/network-lists/reference/get-network-list-status) for the `PRODUCTION` environment. type: object required: - href properties: detail: description: Any additional information about the target of the link. type: string href: description: URL to access or perform the action on a related resource. May be expressed as an absolute server path, or relative to the current URL call. type: string method: default: GET description: The HTTP method with which to call the `href`, `GET` by default. type: string x-akamai: file-path: schemas/link.yaml statusInStaging: additionalProperties: false description: A link to [Get activation status](https://techdocs.akamai.com/network-lists/reference/get-network-list-status) for the `STAGING` environment. type: object required: - href properties: detail: description: Any additional information about the target of the link. type: string href: description: URL to access or perform the action on a related resource. May be expressed as an absolute server path, or relative to the current URL call. type: string method: default: GET description: The HTTP method with which to call the `href`, `GET` by default. type: string x-akamai: file-path: schemas/link.yaml update: additionalProperties: false description: A link to [Update a network list](https://techdocs.akamai.com/network-lists/reference/put-network-list). type: object required: - href properties: detail: description: Any additional information about the target of the link. type: string href: description: URL to access or perform the action on a related resource. May be expressed as an absolute server path, or relative to the current URL call. type: string method: default: GET description: The HTTP method with which to call the `href`, `GET` by default. type: string x-akamai: file-path: schemas/link.yaml list: description: Defines the network list's set of elements. If the `type` is `IP`, values are any combination of IPv4 addresses, IPv6 addresses, or CIDR blocks. If the `type` is `GEO`, values are ISO 3166 two-character country codes. This array does not appear in the object if you get it with the `includeElements` query parameter set to `false`. type: array items: example: FR minLength: 0 type: string name: description: Display name of the network list. maxLength: 100 minLength: 1 type: string networkListType: description: If set to `extendedNetworkListResponse`, indicates that the current data features members enabled with the `extended` query parameter. Otherwise a plain `networkListResponse` value indicates this additional data is absent. example: extendedNetworkListResponse type: string enum: - networkListResponse - extendedNetworkListResponse productionActivationStatus: description: The most recent activation status of the current list in the `PRODUCTION` environment. See [Activation States](https://techdocs.akamai.com/network-lists/reference/activation-states) for details on each activation state. Available only when using the `extended` query parameter to retrieve network list data. example: INACTIVE type: string enum: - INACTIVE - ACTIVE - MODIFIED - PENDING_ACTIVATION - FAILED - PENDING_DEACTIVATION readOnly: default: false description: If `true`, indicates that you don't have permission to modify the network list. This may indicate either a network list that Akamai manages, or insufficient permission for your API client's identity to modify a customer-managed list. The default value is `false`. type: boolean shared: default: false description: Indicates if this list has been shared with you by Akamai or some other account. Shared lists are always read-only. type: boolean stagingActivationStatus: description: The most recent activation status of the current list in the `STAGING` environment. See [Activation States](https://techdocs.akamai.com/network-lists/reference/activation-states) for details on each activation state. Available only when using the `extended` query parameter to retrieve network list data. example: INACTIVE type: string enum: - INACTIVE - ACTIVE - MODIFIED - PENDING_ACTIVATION - FAILED - PENDING_DEACTIVATION syncPoint: default: 0 description: Identifies each version of the network list, which increments each time it's modified. You need to include this value in any requests to modify the list. See [Concurrency control](https://techdocs.akamai.com/network-lists/reference/concurrency-control) for details. minimum: 0 type: integer type: description: The network list type, either `IP` for IP addresses and CIDR blocks, or `GEO` for two-letter country codes. type: string enum: - IP - GEO uniqueId: description: A unique identifier for each network list, corresponding to the `networkListId` URL parameter. minLength: 3 readOnly: true type: string updateDate: description: ISO 8601 timestamp indicating when the network list was last modified. Available only when using the `extended` query parameter to retrieve network list data. example: '2017-06-01T15:13:40.36Z' format: date-time type: string updatedBy: description: Username of this list's creator. Available only when using the `extended` query parameter to retrieve network list data. type: string x-akamai: file-path: schemas/retrieve.yaml '400': description: Incorrect client input. See the field errors provided in the response for more information. This error may also be returned in place of a 404 if a URL parameter was provided in an incorrect format. content: application/problem+json: schema: additionalProperties: false type: object required: - type - status - title properties: detail: description: Detailed error message provided by the server. type: string errors: type: array items: additionalProperties: false type: object required: - type - status - title properties: detail: description: Detailed error message provided by the server. type: string fieldErrors: description: Pointers to fields for which invalid input was provided, whose values are messages detailing the reason this input was invalid for this field. type: object additionalProperties: type: string instance: description: Referenceable URL for this error occurrence. example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749 type: string status: description: HTTP status code. example: 404 type: integer title: description: Title for the error. example: Not Found type: string type: description: URL for the error type. example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND type: string x-akamai: file-path: schemas/error-nested.yaml fieldErrors: description: Pointers to fields for which invalid input was provided, whose values are messages detailing the reason this input was invalid for this field. type: object additionalProperties: type: string instance: description: Referenceable URL for this error occurrence. example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749 type: string status: description: HTTP status code. example: 404 type: integer title: description: Title for the error. example: Not Found type: string type: description: URL for the error type. example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND type: string x-akamai: file-path: schemas/error.yaml '403': description: Forbidden. You don't have permission to perform that function on this network list. Check that your user has the required privileges. content: application/problem+json: schema: additionalProperties: false type: object required: - type - status - title properties: detail: description: Detailed error message provided by the server. type: string errors: type: array items: additionalProperties: false type: object required: - type - status - title properties: detail: description: Detailed error message provided by the server. type: string fieldErrors: description: Pointers to fields for which invalid input was provided, whose values are messages detailing the reason this input was invalid for this field. type: object additionalProperties: type: string instance: description: Referenceable URL for this error occurrence. example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749 type: string status: description: HTTP status code. example: 404 type: integer title: description: Title for the error. example: Not Found type: string type: description: URL for the error type. example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND type: string x-akamai: file-path: schemas/error-nested.yaml fieldErrors: description: Pointers to fields for which invalid input was provided, whose values are messages detailing the reason this input was invalid for this field. type: object additionalProperties: type: string instance: description: Referenceable URL for this error occurrence. example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749 type: string status: description: HTTP status code. example: 404 type: integer title: description: Title for the error. example: Not Found type: string type: description: URL for the error type. example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND type: string x-akamai: file-path: schemas/error.yaml '404': description: Incorrect URL. Check that the network list ID and other URL parameters are valid. content: application/problem+json: schema: additionalProperties: false type: object required: - type - status - title properties: detail: description: Detailed error message provided by the server. type: string errors: type: array items: additionalProperties: false type: object required: - type - status - title properties: detail: description: Detailed error message provided by the server. type: string fieldErrors: description: Pointers to fields for which invalid input was provided, whose values are messages detailing the reason this input was invalid for this field. type: object additionalProperties: type: string instance: description: Referenceable URL for this error occurrence. example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749 type: string status: description: HTTP status code. example: 404 type: integer title: description: Title for the error. example: Not Found type: string type: description: URL for the error type. example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND type: string x-akamai: file-path: schemas/error-nested.yaml fieldErrors: description: Pointers to fields for which invalid input was provided, whose values are messages detailing the reason this input was invalid for this field. type: object additionalProperties: type: string instance: description: Referenceable URL for this error occurrence. example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749 type: string status: description: HTTP status code. example: 404 type: integer title: description: Title for the error. example: Not Found type: string type: description: URL for the error type. example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND type: string x-akamai: file-path: schemas/error.yaml '409': description: This error will be presented if the submitted sync point is differs from sync point provided in the most recent retrieve action for this network list. The most common cause of this is multiple users simultaneously editing the same network list. content: application/problem+json: schema: additionalProperties: false type: object required: - type - status - title properties: detail: description: Detailed error message provided by the server. type: string errors: type: array items: additionalProperties: false type: object required: - type - status - title properties: detail: description: Detailed error message provided by the server. type: string fieldErrors: description: Pointers to fields for which invalid input was provided, whose values are messages detailing the reason this input was invalid for this field. type: object additionalProperties: type: string instance: description: Referenceable URL for this error occurrence. example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749 type: string status: description: HTTP status code. example: 404 type: integer title: description: Title for the error. example: Not Found type: string type: description: URL for the error type. example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND type: string x-akamai: file-path: schemas/error-nested.yaml fieldErrors: description: Pointers to fields for which invalid input was provided, whose values are messages detailing the reason this input was invalid for this field. type: object additionalProperties: type: string instance: description: Referenceable URL for this error occurrence. example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749 type: string status: description: HTTP status code. example: 404 type: integer title: description: Title for the error. example: Not Found type: string type: description: URL for the error type. example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND type: string x-akamai: file-path: schemas/error.yaml '500': description: We encountered an unexpected issue while processing your request. Please follow the advice provided in the message. content: application/problem+json: schema: additionalProperties: false type: object required: - type - status - title properties: detail: description: Detailed error message provided by the server. type: string errors: type: array items: additionalProperties: false type: object required: - type - status - title properties: detail: description: Detailed error message provided by the server. type: string fieldErrors: description: Pointers to fields for which invalid input was provided, whose values are messages detailing the reason this input was invalid for this field. type: object additionalProperties: type: string instance: description: Referenceable URL for this error occurrence. example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749 type: string status: description: HTTP status code. example: 404 type: integer title: description: Title for the error. example: Not Found type: string type: description: URL for the error type. example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND type: string x-akamai: file-path: schemas/error-nested.yaml fieldErrors: description: Pointers to fields for which invalid input was provided, whose values are messages detailing the reason this input was invalid for this field. type: object additionalProperties: type: string instance: description: Referenceable URL for this error occurrence. example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749 type: string status: description: HTTP status code. example: 404 type: integer title: description: Title for the error. example: Not Found type: string type: description: URL for the error type. example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND type: string x-akamai: file-path: schemas/error.yaml parameters: - description: When enabled, provides additional response data identifying who created and updated the list and when, and the network list's deployment status in both `STAGING` and `PRODUCTION` environments. This data takes longer to provide. example: '{{extended}}' in: query name: extended schema: default: false example: true type: boolean x-akamai: file-path: parameters/extended_extended.yaml - description: If enabled, the response `list` includes all items. For large network lists, this may slow responses and yield large response objects. The default `true` value includes the list's contents. example: '{{includeElements}}' in: query name: includeElements schema: default: true example: true type: boolean x-akamai: file-path: parameters/includeElements_includeElements.yaml - description: For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys). example: '{{accountSwitchKey}}' in: query name: accountSwitchKey required: false schema: example: 1-5C0YLB:1-8BYUX type: string delete: description: Removes a network list. You can only remove network lists that never activated. To deactivate a list, you can empty out its `list` of elements. operationId: delete-network-list summary: Akamai Delete a Network List tags: - Network lists externalDocs: description: See documentation for this operation in Akamai's Network Lists API url: https://techdocs.akamai.com/network-lists/reference/delete-network-list responses: '200': description: A confirmation message that the network list has been removed. content: application/json: example: status: 200 syncPoint: 4 uniqueId: 33501_TESTLIST schema: additionalProperties: false description: A common object that responds to DELETE requests. type: object required: - status properties: status: description: HTTP status code used for the response. type: integer syncPoint: description: In cases where a network list still exists after the operation, this is the `syncPoint` required to perform update or delete operations on the list. See [Concurrency control](https://techdocs.akamai.com/network-lists/reference/concurrency-control) for details. type: integer uniqueId: description: In cases where a network list still exists after the operation, this is the unique ID required to perform further operations on the network list. type: string x-akamai: file-path: schemas/message.yaml '400': description: Incorrect client input. See the field errors provided in the response for more information. This error may also be returned in place of a 404 if a URL parameter was provided in an incorrect format. content: application/problem+json: schema: additionalProperties: false type: object required: - type - status - title properties: detail: description: Detailed error message provided by the server. type: string errors: type: array items: additionalProperties: false type: object required: - type - status - title properties: detail: description: Detailed error message provided by the server. type: string fieldErrors: description: Pointers to fields for which invalid input was provided, whose values are messages detailing the reason this input was invalid for this field. type: object additionalProperties: type: string instance: description: Referenceable URL for this error occurrence. example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749 type: string status: description: HTTP status code. example: 404 type: integer title: description: Title for the error. example: Not Found type: string type: description: URL for the error type. example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND type: string x-akamai: file-path: schemas/error-nested.yaml fieldErrors: description: Pointers to fields for which invalid input was provided, whose values are messages detailing the reason this input was invalid for this field. type: object additionalProperties: type: string instance: description: Referenceable URL for this error occurrence. example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749 type: string status: description: HTTP status code. example: 404 type: integer title: description: Title for the error. example: Not Found type: string type: description: URL for the error type. example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND type: string x-akamai: file-path: schemas/error.yaml '403': description: Forbidden. You don't have permission to perform that function on this network list. Check that your user has the required privileges. content: application/problem+json: schema: additionalProperties: false type: object required: - type - status - title properties: detail: description: Detailed error message provided by the server. type: string errors: type: array items: additionalProperties: false type: object required: - type - status - title properties: detail: description: Detailed error message provided by the server. type: string fieldErrors: description: Pointers to fields for which invalid input was provided, whose values are messages detailing the reason this input was invalid for this field. type: object additionalProperties: type: string instance: description: Referenceable URL for this error occurrence. example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749 type: string status: description: HTTP status code. example: 404 type: integer title: description: Title for the error. example: Not Found type: string type: description: URL for the error type. example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND type: string x-akamai: file-path: schemas/error-nested.yaml fieldErrors: description: Pointers to fields for which invalid input was provided, whose values are messages detailing the reason this input was invalid for this field. type: object additionalProperties: type: string instance: description: Referenceable URL for this error occurrence. example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749 type: string status: description: HTTP status code. example: 404 type: integer title: description: Title for the error. example: Not Found type: string type: description: URL for the error type. example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND type: string x-akamai: file-path: schemas/error.yaml '404': description: Incorrect URL. Check that the network list ID and other URL parameters are valid. content: application/problem+json: schema: additionalProperties: false type: object required: - type - status - title properties: detail: description: Detailed error message provided by the server. type: string errors: type: array items: additionalProperties: false type: object required: - type - status - title properties: detail: description: Detailed error message provided by the server. type: string fieldErrors: description: Pointers to fields for which invalid input was provided, whose values are messages detailing the reason this input was invalid for this field. type: object additionalProperties: type: string instance: description: Referenceable URL for this error occurrence. example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749 type: string status: description: HTTP status code. example: 404 type: integer title: description: Title for the error. example: Not Found type: string type: description: URL for the error type. example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND type: string x-akamai: file-path: schemas/error-nested.yaml fieldErrors: description: Pointers to fields for which invalid input was provided, whose values are messages detailing the reason this input was invalid for this field. type: object additionalProperties: type: string instance: description: Referenceable URL for this error occurrence. example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749 type: string status: description: HTTP status code. example: 404 type: integer title: description: Title for the error. example: Not Found type: string type: description: URL for the error type. example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND type: string x-akamai: file-path: schemas/error.yaml '409': description: A HTTP 409 response will be presented if the list is currently activated in staging or production. Active network lists cannot be deleted. Use the status APIs to determine if this list is active. content: application/problem+json: schema: additionalProperties: false type: object required: - type - status - title properties: detail: description: Detailed error message provided by the server. type: string errors: type: array items: additionalProperties: false type: object required: - type - status - title properties: detail: description: Detailed error message provided by the server. type: string fieldErrors: description: Pointers to fields for which invalid input was provided, whose values are messages detailing the reason this input was invalid for this field. type: object additionalProperties: type: string instance: description: Referenceable URL for this error occurrence. example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749 type: string status: description: HTTP status code. example: 404 type: integer title: description: Title for the error. example: Not Found type: string type: description: URL for the error type. example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND type: string x-akamai: file-path: schemas/error-nested.yaml fieldErrors: description: Pointers to fields for which invalid input was provided, whose values are messages detailing the reason this input was invalid for this field. type: object additionalProperties: type: string instance: description: Referenceable URL for this error occurrence. example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749 type: string status: description: HTTP status code. example: 404 type: integer title: description: Title for the error. example: Not Found type: string type: description: URL for the error type. example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND type: string x-akamai: file-path: schemas/error.yaml '500': description: We encountered an unexpected issue while processing your request. Please follow the advice provided in the message. content: application/problem+json: schema: additionalProperties: false type: object required: - type - status - title properties: detail: description: Detailed error message provided by the server. type: string errors: type: array items: additionalProperties: false type: object required: - type - status - title properties: detail: description: Detailed error message provided by the server. type: string fieldErrors: description: Pointers to fields for which invalid input was provided, whose values are messages detailing the reason this input was invalid for this field. type: object additionalProperties: type: string instance: description: Referenceable URL for this error occurrence. example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749 type: string status: description: HTTP status code. example: 404 type: integer title: description: Title for the error. example: Not Found type: string type: description: URL for the error type. example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND type: string x-akamai: file-path: schemas/error-nested.yaml fieldErrors: description: Pointers to fields for which invalid input was provided, whose values are messages detailing the reason this input was invalid for this field. type: object additionalProperties: type: string instance: description: Referenceable URL for this error occurrence. example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749 type: string status: description: HTTP status code. example: 404 type: integer title: description: Title for the error. example: Not Found type: string type: description: URL for the error type. example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND type: string x-akamai: file-path: schemas/error.yaml parameters: - description: For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys). example: '{{accountSwitchKey}}' in: query name: accountSwitchKey required: false schema: example: 1-5C0YLB:1-8BYUX type: string /network-lists/{networkListId}/append: parameters: - description: Unique identifier for each network list. example: '{{networkListId}}' in: path name: networkListId required: true schema: example: 12345_BLACKLISTEDGEOS type: string x-akamai: file-path: parameters/networkListId-path.yaml post: description: Appends a set of elements to a network list. If the networks list's `type` is `IP`, the submitted `list` is a series of IP addresses or CIDR blocks. If the type is `GEO`, it's a set of two-character country codes. (See the [EdgeScape Documentation](https://control.akamai.com/apps/download-center/#/products/3;name=EdgeScape) for more information. For a list of countries, go to __Data Codes__ ⇒ __Country Code__.) operationId: post-network-list-append summary: Akamai Append Elements to a Network List tags: - Network lists externalDocs: description: See documentation for this operation in Akamai's Network Lists API url: https://techdocs.akamai.com/network-lists/reference/post-network-list-append requestBody: required: true content: application/json: example: list: - 192.0.2.157 - 192.0.2.212/24 schema: additionalProperties: false type: object required: - list properties: list: description: Defines the network list's set of elements. If the `type` is `IP`, values are any combination of IPv4 addresses, IPv6 addresses, or CIDR blocks. If the `type` is `GEO`, values are ISO 3166 two-character country codes. This array does not appear in the object if you get it with the `includeElements` query parameter set to `false`. type: array items: example: FR minLength: 0 type: string x-akamai: file-path: schemas/append.yaml responses: '202': description: Counter to its ordinary usage, a 202 response here indicates a complete response, the same as a 200. content: application/json: example: contractId: K-0N7RAK7 elementCount: 13 groupId: 517014 name: My Network List networkListType: networkListResponse readOnly: true shared: true syncPoint: 65 type: IP uniqueId: 1024_NETWORKLIST list: - 192.0.2.166/24 - 12.129.0.0/15 - 12.211.0.0/15 - 192.0.2.143/24 - 192.0.2.182/24 - 12.231.0.0/14 - 12.235.0.0/14 - 192.0.2.68/24 - 192.0.2.191/24 - 192.0.2.115/24 - 192.0.2.145/24 - 192.0.2.158/24 - 192.0.2.25/24 links: activateInProduction: href: /network-list/v2/network-lists/1024_AMAZONELASTICCOMPUTECLOU/environments/PRODUCTION/activate method: POST activateInStaging: href: /network-list/v2/network-lists/1024_AMAZONELASTICCOMPUTECLOU/environments/STAGING/activate method: POST appendItems: href: /network-list/v2/network-lists/1024_AMAZONELASTICCOMPUTECLOU/append method: POST retrieve: href: /network-list/v2/network-lists/1024_AMAZONELASTICCOMPUTECLOU statusInProduction: href: /network-list/v2/network-lists/1024_AMAZONELASTICCOMPUTECLOU/environments/PRODUCTION/status statusInStaging: href: /network-list/v2/network-lists/1024_AMAZONELASTICCOMPUTECLOU/environments/STAGING/status update: href: /network-list/v2/network-lists/1024_AMAZONELASTICCOMPUTECLOU method: PUT schema: additionalProperties: false description: Encapsulates information about each network list. type: object required: - name - syncPoint - type - uniqueId properties: accessControlGroup: description: Name of this network list's access control group (ACG). type: string contractId: description: Identifies the contract where you want to create the list. You need to have write access to the contract you specify. If you include a `contractId`, you need to pair it with a `groupId`. maxLength: 20 minLength: 5 type: string createDate: description: ISO 8601 timestamp indicating when the network list was first created. Available only when using the `extended` query parameter to retrieve network list data. example: '2017-06-01T15:13:40.36Z' format: date-time type: string createdBy: description: Username of this list's creator. Available only when using the `extended` query parameter to retrieve network list data. type: string description: description: Detailed description of the list. maxLength: 255 minLength: 1 type: string elementCount: description: Reflects the number of elements in the `list` array, which may not necessarily appear in the object when retrieving the list with the `includeElements` query parameter set to `false`. type: integer expeditedProductionActivationStatus: description: For clients with access to _expedited_ activations on select servers, provides the most recent activation status in the `PRODUCTION` environment. See [Activation States](https://techdocs.akamai.com/network-lists/reference/activation-states) for details on each activation state. Available only when using the `extended` query parameter to retrieve network list data. example: INACTIVE type: string enum: - INACTIVE - ACTIVE - MODIFIED - PENDING_ACTIVATION - FAILED - PENDING_DEACTIVATION expeditedStagingActivationStatus: description: For clients with access to _expedited_ activations on select servers, provides the most recent activation status in the `STAGING` environment. See [Activation States](https://techdocs.akamai.com/network-lists/reference/activation-states) for details on each activation state. Available only when using the `extended` query parameter to retrieve network list data. example: INACTIVE type: string enum: - INACTIVE - ACTIVE - MODIFIED - PENDING_ACTIVATION - FAILED - PENDING_DEACTIVATION groupId: description: Identifies the group where you want to create the list. You need to have write access to the group you specify. If you include a `groupId`, you need to pair it with a `contractId`. type: number links: additionalProperties: false description: Encapsulates the set of [API hypermedia](https://techdocs.akamai.com/network-lists/reference/api-hypermedia) to access a set of resources related to this network list. The object is arranged as a hash of keys, each of which represents a link relation. type: object properties: activateInProduction: additionalProperties: false description: A link to [Activate a network list](https://techdocs.akamai.com/network-lists/reference/post-network-list-activate) in the `PRODUCTION` environment. type: object required: - href properties: detail: description: Any additional information about the target of the link. type: string href: description: URL to access or perform the action on a related resource. May be expressed as an absolute server path, or relative to the current URL call. type: string method: default: GET description: The HTTP method with which to call the `href`, `GET` by default. type: string x-akamai: file-path: schemas/link.yaml activateInStaging: additionalProperties: false description: A link to [Activate a network list](https://techdocs.akamai.com/network-lists/reference/post-network-list-activate) in the `STAGING` environment. type: object required: - href properties: detail: description: Any additional information about the target of the link. type: string href: description: URL to access or perform the action on a related resource. May be expressed as an absolute server path, or relative to the current URL call. type: string method: default: GET description: The HTTP method with which to call the `href`, `GET` by default. type: string x-akamai: file-path: schemas/link.yaml activationDetails: additionalProperties: false description: A link to [Get activation details](https://techdocs.akamai.com/network-lists/reference/get-activation). type: object required: - href properties: detail: description: Any additional information about the target of the link. type: string href: description: URL to access or perform the action on a related resource. May be expressed as an absolute server path, or relative to the current URL call. type: string method: default: GET description: The HTTP method with which to call the `href`, `GET` by default. type: string x-akamai: file-path: schemas/link.yaml appendItems: additionalProperties: false description: A link to [Append elements to a network list](https://techdocs.akamai.com/network-lists/reference/post-network-list-append). type: object required: - href properties: detail: description: Any additional information about the target of the link. type: string href: description: URL to access or perform the action on a related resource. May be expressed as an absolute server path, or relative to the current URL call. type: string method: default: GET description: The HTTP method with which to call the `href`, `GET` by default. type: string x-akamai: file-path: schemas/link.yaml retrieve: additionalProperties: false description: A link to [Get a network list](https://techdocs.akamai.com/network-lists/reference/get-network-list). type: object required: - href properties: detail: description: Any additional information about the target of the link. type: string href: description: URL to access or perform the action on a related resource. May be expressed as an absolute server path, or relative to the current URL call. type: string method: default: GET description: The HTTP method with which to call the `href`, `GET` by default. type: string x-akamai: file-path: schemas/link.yaml statusInProduction: additionalProperties: false description: A link to [Get activation status](https://techdocs.akamai.com/network-lists/reference/get-network-list-status) for the `PRODUCTION` environment. type: object required: - href properties: detail: description: Any additional information about the target of the link. type: string href: description: URL to access or perform the action on a related resource. May be expressed as an absolute server path, or relative to the current URL call. type: string method: default: GET description: The HTTP method with which to call the `href`, `GET` by default. type: string x-akamai: file-path: schemas/link.yaml statusInStaging: additionalProperties: false description: A link to [Get activation status](https://techdocs.akamai.com/network-lists/reference/get-network-list-status) for the `STAGING` environment. type: object required: - href properties: detail: description: Any additional information about the target of the link. type: string href: description: URL to access or perform the action on a related resource. May be expressed as an absolute server path, or relative to the current URL call. type: string method: default: GET description: The HTTP method with which to call the `href`, `GET` by default. type: string x-akamai: file-path: schemas/link.yaml update: additionalProperties: false description: A link to [Update a network list](https://techdocs.akamai.com/network-lists/reference/put-network-list). type: object required: - href properties: detail: description: Any additional information about the target of the link. type: string href: description: URL to access or perform the action on a related resource. May be expressed as an absolute server path, or relative to the current URL call. type: string method: default: GET description: The HTTP method with which to call the `href`, `GET` by default. type: string x-akamai: file-path: schemas/link.yaml list: description: Defines the network list's set of elements. If the `type` is `IP`, values are any combination of IPv4 addresses, IPv6 addresses, or CIDR blocks. If the `type` is `GEO`, values are ISO 3166 two-character country codes. This array does not appear in the object if you get it with the `includeElements` query parameter set to `false`. type: array items: example: FR minLength: 0 type: string name: description: Display name of the network list. maxLength: 100 minLength: 1 type: string networkListType: description: If set to `extendedNetworkListResponse`, indicates that the current data features members enabled with the `extended` query parameter. Otherwise a plain `networkListResponse` value indicates this additional data is absent. example: extendedNetworkListResponse type: string enum: - networkListResponse - extendedNetworkListResponse productionActivationStatus: description: The most recent activation status of the current list in the `PRODUCTION` environment. See [Activation States](https://techdocs.akamai.com/network-lists/reference/activation-states) for details on each activation state. Available only when using the `extended` query parameter to retrieve network list data. example: INACTIVE type: string enum: - INACTIVE - ACTIVE - MODIFIED - PENDING_ACTIVATION - FAILED - PENDING_DEACTIVATION readOnly: default: false description: If `true`, indicates that you don't have permission to modify the network list. This may indicate either a network list that Akamai manages, or insufficient permission for your API client's identity to modify a customer-managed list. The default value is `false`. type: boolean shared: default: false description: Indicates if this list has been shared with you by Akamai or some other account. Shared lists are always read-only. type: boolean stagingActivationStatus: description: The most recent activation status of the current list in the `STAGING` environment. See [Activation States](https://techdocs.akamai.com/network-lists/reference/activation-states) for details on each activation state. Available only when using the `extended` query parameter to retrieve network list data. example: INACTIVE type: string enum: - INACTIVE - ACTIVE - MODIFIED - PENDING_ACTIVATION - FAILED - PENDING_DEACTIVATION syncPoint: default: 0 description: Identifies each version of the network list, which increments each time it's modified. You need to include this value in any requests to modify the list. See [Concurrency control](https://techdocs.akamai.com/network-lists/reference/concurrency-control) for details. minimum: 0 type: integer type: description: The network list type, either `IP` for IP addresses and CIDR blocks, or `GEO` for two-letter country codes. type: string enum: - IP - GEO uniqueId: description: A unique identifier for each network list, corresponding to the `networkListId` URL parameter. minLength: 3 readOnly: true type: string updateDate: description: ISO 8601 timestamp indicating when the network list was last modified. Available only when using the `extended` query parameter to retrieve network list data. example: '2017-06-01T15:13:40.36Z' format: date-time type: string updatedBy: description: Username of this list's creator. Available only when using the `extended` query parameter to retrieve network list data. type: string x-akamai: file-path: schemas/retrieve.yaml '400': description: Incorrect client input. See the field errors provided in the response for more information. This error may also be returned in place of a 404 if a URL parameter was provided in an incorrect format. content: application/problem+json: schema: additionalProperties: false type: object required: - type - status - title properties: detail: description: Detailed error message provided by the server. type: string errors: type: array items: additionalProperties: false type: object required: - type - status - title properties: detail: description: Detailed error message provided by the server. type: string fieldErrors: description: Pointers to fields for which invalid input was provided, whose values are messages detailing the reason this input was invalid for this field. type: object additionalProperties: type: string instance: description: Referenceable URL for this error occurrence. example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749 type: string status: description: HTTP status code. example: 404 type: integer title: description: Title for the error. example: Not Found type: string type: description: URL for the error type. example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND type: string x-akamai: file-path: schemas/error-nested.yaml fieldErrors: description: Pointers to fields for which invalid input was provided, whose values are messages detailing the reason this input was invalid for this field. type: object additionalProperties: type: string instance: description: Referenceable URL for this error occurrence. example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749 type: string status: description: HTTP status code. example: 404 type: integer title: description: Title for the error. example: Not Found type: string type: description: URL for the error type. example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND type: string x-akamai: file-path: schemas/error.yaml '403': description: Forbidden. You don't have permission to perform that function on this network list. Check that your user has the required privileges. content: application/problem+json: schema: additionalProperties: false type: object required: - type - status - title properties: detail: description: Detailed error message provided by the server. type: string errors: type: array items: additionalProperties: false type: object required: - type - status - title properties: detail: description: Detailed error message provided by the server. type: string fieldErrors: description: Pointers to fields for which invalid input was provided, whose values are messages detailing the reason this input was invalid for this field. type: object additionalProperties: type: string instance: description: Referenceable URL for this error occurrence. example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749 type: string status: description: HTTP status code. example: 404 type: integer title: description: Title for the error. example: Not Found type: string type: description: URL for the error type. example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND type: string x-akamai: file-path: schemas/error-nested.yaml fieldErrors: description: Pointers to fields for which invalid input was provided, whose values are messages detailing the reason this input was invalid for this field. type: object additionalProperties: type: string instance: description: Referenceable URL for this error occurrence. example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749 type: string status: description: HTTP status code. example: 404 type: integer title: description: Title for the error. example: Not Found type: string type: description: URL for the error type. example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND type: string x-akamai: file-path: schemas/error.yaml '404': description: Incorrect URL. Check that the network list ID and other URL parameters are valid. content: application/problem+json: schema: additionalProperties: false type: object required: - type - status - title properties: detail: description: Detailed error message provided by the server. type: string errors: type: array items: additionalProperties: false type: object required: - type - status - title properties: detail: description: Detailed error message provided by the server. type: string fieldErrors: description: Pointers to fields for which invalid input was provided, whose values are messages detailing the reason this input was invalid for this field. type: object additionalProperties: type: string instance: description: Referenceable URL for this error occurrence. example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749 type: string status: description: HTTP status code. example: 404 type: integer title: description: Title for the error. example: Not Found type: string type: description: URL for the error type. example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND type: string x-akamai: file-path: schemas/error-nested.yaml fieldErrors: description: Pointers to fields for which invalid input was provided, whose values are messages detailing the reason this input was invalid for this field. type: object additionalProperties: type: string instance: description: Referenceable URL for this error occurrence. example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749 type: string status: description: HTTP status code. example: 404 type: integer title: description: Title for the error. example: Not Found type: string type: description: URL for the error type. example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND type: string x-akamai: file-path: schemas/error.yaml '500': description: We encountered an unexpected issue while processing your request. Please follow the advice provided in the message. content: application/problem+json: schema: additionalProperties: false type: object required: - type - status - title properties: detail: description: Detailed error message provided by the server. type: string errors: type: array items: additionalProperties: false type: object required: - type - status - title properties: detail: description: Detailed error message provided by the server. type: string fieldErrors: description: Pointers to fields for which invalid input was provided, whose values are messages detailing the reason this input was invalid for this field. type: object additionalProperties: type: string instance: description: Referenceable URL for this error occurrence. example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749 type: string status: description: HTTP status code. example: 404 type: integer title: description: Title for the error. example: Not Found type: string type: description: URL for the error type. example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND type: string x-akamai: file-path: schemas/error-nested.yaml fieldErrors: description: Pointers to fields for which invalid input was provided, whose values are messages detailing the reason this input was invalid for this field. type: object additionalProperties: type: string instance: description: Referenceable URL for this error occurrence. example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749 type: string status: description: HTTP status code. example: 404 type: integer title: description: Title for the error. example: Not Found type: string type: description: URL for the error type. example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND type: string x-akamai: file-path: schemas/error.yaml parameters: - description: For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys). example: '{{accountSwitchKey}}' in: query name: accountSwitchKey required: false schema: example: 1-5C0YLB:1-8BYUX type: string /network-lists/{networkListId}/details: parameters: - description: Unique identifier for each network list. example: '{{networkListId}}' in: path name: networkListId required: true schema: example: 12345_BLACKLISTEDGEOS type: string x-akamai: file-path: parameters/networkListId-path.yaml put: description: Update a network list's name or description. operationId: put-network-list-details summary: Akamai Update Network List Details tags: - Network lists externalDocs: description: See documentation for this operation in Akamai's Network Lists API url: https://techdocs.akamai.com/network-lists/reference/put-network-list-details requestBody: required: true content: application/json: example: description: Updated notes about this network list name: My Updated Open List schema: additionalProperties: false type: object required: - name properties: description: description: Detailed description of the list. example: '{{description}}' maxLength: 255 minLength: 1 type: string name: description: Display name of the network list. example: '{{name}}' maxLength: 100 minLength: 1 type: string x-akamai: file-path: schemas/update-details.yaml responses: '204': description: Updated successfully. content: '*/*': {} '400': description: Incorrect client input. See the field errors provided in the response for more information. This error may also be returned in place of a 404 if a URL parameter was provided in an incorrect format. content: application/problem+json: schema: additionalProperties: false type: object required: - type - status - title properties: detail: description: Detailed error message provided by the server. type: string errors: type: array items: additionalProperties: false type: object required: - type - status - title properties: detail: description: Detailed error message provided by the server. type: string fieldErrors: description: Pointers to fields for which invalid input was provided, whose values are messages detailing the reason this input was invalid for this field. type: object additionalProperties: type: string instance: description: Referenceable URL for this error occurrence. example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749 type: string status: description: HTTP status code. example: 404 type: integer title: description: Title for the error. example: Not Found type: string type: description: URL for the error type. example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND type: string x-akamai: file-path: schemas/error-nested.yaml fieldErrors: description: Pointers to fields for which invalid input was provided, whose values are messages detailing the reason this input was invalid for this field. type: object additionalProperties: type: string instance: description: Referenceable URL for this error occurrence. example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749 type: string status: description: HTTP status code. example: 404 type: integer title: description: Title for the error. example: Not Found type: string type: description: URL for the error type. example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND type: string x-akamai: file-path: schemas/error.yaml '403': description: Forbidden. You don't have permission to perform that function on this network list. Check that your user has the required privileges. content: application/problem+json: schema: additionalProperties: false type: object required: - type - status - title properties: detail: description: Detailed error message provided by the server. type: string errors: type: array items: additionalProperties: false type: object required: - type - status - title properties: detail: description: Detailed error message provided by the server. type: string fieldErrors: description: Pointers to fields for which invalid input was provided, whose values are messages detailing the reason this input was invalid for this field. type: object additionalProperties: type: string instance: description: Referenceable URL for this error occurrence. example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749 type: string status: description: HTTP status code. example: 404 type: integer title: description: Title for the error. example: Not Found type: string type: description: URL for the error type. example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND type: string x-akamai: file-path: schemas/error-nested.yaml fieldErrors: description: Pointers to fields for which invalid input was provided, whose values are messages detailing the reason this input was invalid for this field. type: object additionalProperties: type: string instance: description: Referenceable URL for this error occurrence. example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749 type: string status: description: HTTP status code. example: 404 type: integer title: description: Title for the error. example: Not Found type: string type: description: URL for the error type. example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND type: string x-akamai: file-path: schemas/error.yaml '404': description: Incorrect URL. Check that the network list ID and other URL parameters are valid. content: application/problem+json: schema: additionalProperties: false type: object required: - type - status - title properties: detail: description: Detailed error message provided by the server. type: string errors: type: array items: additionalProperties: false type: object required: - type - status - title properties: detail: description: Detailed error message provided by the server. type: string fieldErrors: description: Pointers to fields for which invalid input was provided, whose values are messages detailing the reason this input was invalid for this field. type: object additionalProperties: type: string instance: description: Referenceable URL for this error occurrence. example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749 type: string status: description: HTTP status code. example: 404 type: integer title: description: Title for the error. example: Not Found type: string type: description: URL for the error type. example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND type: string x-akamai: file-path: schemas/error-nested.yaml fieldErrors: description: Pointers to fields for which invalid input was provided, whose values are messages detailing the reason this input was invalid for this field. type: object additionalProperties: type: string instance: description: Referenceable URL for this error occurrence. example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749 type: string status: description: HTTP status code. example: 404 type: integer title: description: Title for the error. example: Not Found type: string type: description: URL for the error type. example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND type: string x-akamai: file-path: schemas/error.yaml '500': description: We encountered an unexpected issue while processing your request. Please follow the advice provided in the message. content: application/problem+json: schema: additionalProperties: false type: object required: - type - status - title properties: detail: description: Detailed error message provided by the server. type: string errors: type: array items: additionalProperties: false type: object required: - type - status - title properties: detail: description: Detailed error message provided by the server. type: string fieldErrors: description: Pointers to fields for which invalid input was provided, whose values are messages detailing the reason this input was invalid for this field. type: object additionalProperties: type: string instance: description: Referenceable URL for this error occurrence. example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749 type: string status: description: HTTP status code. example: 404 type: integer title: description: Title for the error. example: Not Found type: string type: description: URL for the error type. example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND type: string x-akamai: file-path: schemas/error-nested.yaml fieldErrors: description: Pointers to fields for which invalid input was provided, whose values are messages detailing the reason this input was invalid for this field. type: object additionalProperties: type: string instance: description: Referenceable URL for this error occurrence. example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749 type: string status: description: HTTP status code. example: 404 type: integer title: description: Title for the error. example: Not Found type: string type: description: URL for the error type. example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND type: string x-akamai: file-path: schemas/error.yaml parameters: - description: For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys). example: '{{accountSwitchKey}}' in: query name: accountSwitchKey required: false schema: example: 1-5C0YLB:1-8BYUX type: string externalDocs: description: See documentation for Akamai's API Endpoint Definition API url: https://techdocs.akamai.com/api-definitions/reference x-readme: samples-languages: - curl - python - node