---
updatedAt: 2026-03-01T18:59:38.000Z
agentTools:
  siteIndex: https://techdocs.akamai.com/llms.txt
  projectIndex: https://techdocs.akamai.com/test-ctr/llms.txt
---

# Generate a test suite with child objects

Generates a default test suite with test cases and variables for a specific property version and a URL. Based on property settings and its behaviors and the URL, Test Center generates a default test suite object with test cases and variables. You can modify the generated test suite and add it to Test Center using the [Create a test suite with child objects](ref:post-test-suites-with-child-objects) operation.

# OpenAPI definition

```json
{
  "externalDocs": {
    "description": "See documentation for Akamai's Test Center API",
    "url": "https://techdocs.akamai.com/test-ctr/reference"
  },
  "info": {
    "license": {
      "name": "Apache 2.0",
      "url": "https://www.apache.org/licenses/LICENSE-2.0.html"
    },
    "title": "Functional testing",
    "version": "v3"
  },
  "openapi": "3.0.0",
  "paths": {
    "/functional/test-suites/auto-generate": {
      "post": {
        "description": "Generates a default test suite with test cases and variables for a specific property version and a URL. Based on property settings and its behaviors and the URL, Test Center generates a default test suite object with test cases and variables. You can modify the generated test suite and add it to Test Center using the [Create a test suite with child objects](https://techdocs.akamai.com/test-ctr/reference/post-test-suites-with-child-objects) operation.",
        "externalDocs": {
          "description": "See documentation for this operation in Akamai's Test Center API",
          "url": "https://techdocs.akamai.com/test-ctr/reference/post-auto-generate-test-suite"
        },
        "operationId": "post-auto-generate-test-suite",
        "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).",
            "in": "query",
            "name": "accountSwitchKey",
            "required": false,
            "schema": {
              "example": "1-5C0YLB:1-8BYUX",
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "example": {
                "configs": {
                  "propertyManager": {
                    "propertyName": "config_user8",
                    "propertyVersion": 79
                  }
                },
                "testRequestUrls": [
                  "https://www.user8.example.com/image/cart.png"
                ]
              },
              "schema": {
                "additionalProperties": false,
                "description": "Contains information for auto-generating a test suite with test cases and variables.",
                "properties": {
                  "configs": {
                    "additionalProperties": false,
                    "description": "Specifies associated Property Manager property.",
                    "properties": {
                      "propertyManager": {
                        "additionalProperties": false,
                        "description": "Property Manager property the test suite is generated for.",
                        "oneOf": [
                          {
                            "required": [
                              "propertyId",
                              "propertyVersion"
                            ],
                            "title": "Property ID and version"
                          },
                          {
                            "required": [
                              "propertyName",
                              "propertyVersion"
                            ],
                            "title": "Property name and version"
                          }
                        ],
                        "properties": {
                          "propertyId": {
                            "description": "Unique identifier of a property.",
                            "minimum": 1,
                            "type": "integer"
                          },
                          "propertyName": {
                            "description": "Name of a property.",
                            "minLength": 1,
                            "type": "string"
                          },
                          "propertyVersion": {
                            "description": "Version of a property.",
                            "minimum": 1,
                            "type": "integer"
                          }
                        },
                        "type": "object"
                      }
                    },
                    "required": [
                      "propertyManager"
                    ],
                    "type": "object"
                  },
                  "testRequestUrls": {
                    "description": "URLs you want to use to generate the test suite.",
                    "items": {
                      "format": "uri",
                      "type": "string"
                    },
                    "minItems": 1,
                    "type": "array",
                    "uniqueItems": true
                  }
                },
                "required": [
                  "configs",
                  "testRequestUrls"
                ],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "example": {
                  "configs": {
                    "propertyManager": {
                      "propertyId": 2321,
                      "propertyName": "config_user8",
                      "propertyVersion": 79
                    }
                  },
                  "isLocked": true,
                  "isStateful": false,
                  "testCases": [
                    {
                      "clientProfile": {
                        "client": "CHROME",
                        "ipVersion": "IPV4"
                      },
                      "condition": {
                        "conditionExpression": "Log request details - Accept-Language header is logged"
                      },
                      "testRequest": {
                        "requestMethod": "GET",
                        "testRequestUrl": "{{protocol}}://{{host}}{{path}}"
                      }
                    },
                    {
                      "clientProfile": {
                        "client": "CHROME",
                        "ipVersion": "IPV4"
                      },
                      "condition": {
                        "conditionExpression": "Log request details - Host header is logged"
                      },
                      "testRequest": {
                        "requestMethod": "GET",
                        "testRequestUrl": "{{protocol}}://{{host}}{{path}}"
                      }
                    },
                    {
                      "clientProfile": {
                        "client": "CHROME",
                        "ipVersion": "IPV4"
                      },
                      "condition": {
                        "conditionExpression": "Caching option is cache with max-age of \"0\" seconds"
                      },
                      "testRequest": {
                        "requestMethod": "GET",
                        "testRequestUrl": "{{protocol}}://{{host}}{{path}}"
                      }
                    }
                  ],
                  "testSuiteName": "Default test suite for config_user8 v79",
                  "variables": [
                    {
                      "variableName": "host",
                      "variableValue": "www.user8.example.com"
                    },
                    {
                      "variableName": "path",
                      "variableValue": "/image/cart.png"
                    },
                    {
                      "variableName": "protocol",
                      "variableValue": "https"
                    }
                  ]
                },
                "schema": {
                  "additionalProperties": false,
                  "description": "Contains information about a test suite with test cases and variables.",
                  "properties": {
                    "configs": {
                      "additionalProperties": false,
                      "description": "Specifies associated Property Manager property.",
                      "properties": {
                        "propertyManager": {
                          "additionalProperties": false,
                          "description": "Associated Property Manager property.",
                          "properties": {
                            "propertyId": {
                              "description": "Unique identifier of a property.",
                              "minimum": 1,
                              "type": "integer"
                            },
                            "propertyName": {
                              "description": "Name of a property.",
                              "minLength": 1,
                              "type": "string"
                            },
                            "propertyVersion": {
                              "description": "Version of a property.",
                              "minimum": 1,
                              "type": "integer"
                            }
                          },
                          "required": [
                            "propertyId",
                            "propertyName",
                            "propertyVersion"
                          ],
                          "type": "object"
                        }
                      },
                      "required": [
                        "propertyManager"
                      ],
                      "type": "object"
                    },
                    "isLocked": {
                      "description": "Locks the test suite so that only designated owners or editors can modify it.",
                      "type": "boolean"
                    },
                    "isStateful": {
                      "description": "Runs the test suite statefully, retaining cookies and session data for subsequent test cases within the test suite.",
                      "type": "boolean"
                    },
                    "testCases": {
                      "description": "Lists generated functional test cases and included objects: condition, test request, and client profile.",
                      "items": {
                        "additionalProperties": false,
                        "description": "Specifies a functional test case and included objects: condition, test request, and client profile.",
                        "properties": {
                          "clientProfile": {
                            "additionalProperties": false,
                            "description": "Specifies a client profile included in the test case.",
                            "properties": {
                              "client": {
                                "description": "Client type you want to use for the test run, either `CHROME` or `CURL`.",
                                "enum": [
                                  "CHROME",
                                  "CURL"
                                ],
                                "type": "string"
                              },
                              "clientVersion": {
                                "description": "__Read-only__ Version of the `client` used to execute the test run.",
                                "readOnly": true,
                                "type": "string"
                              },
                              "geoLocation": {
                                "description": "Location type you want to use for the test run. The only currently supported value is `US`.",
                                "enum": [
                                  "US"
                                ],
                                "type": "string"
                              },
                              "ipVersion": {
                                "description": "IP version to use in the test run, either `IPV4` or `IPV6`.",
                                "enum": [
                                  "IPV4",
                                  "IPV6"
                                ],
                                "type": "string"
                              }
                            },
                            "required": [
                              "ipVersion",
                              "client"
                            ],
                            "type": "object"
                          },
                          "condition": {
                            "additionalProperties": false,
                            "description": "Specifies a condition included in the test case.",
                            "properties": {
                              "conditionExpression": {
                                "description": "Condition expression you want to evaluate in the test run. To create the expression, you need to [Get the test catalog template](https://techdocs.akamai.com/test-ctr/reference/get-test-catalog-template). To learn more, see [Test Center concepts](https://techdocs.akamai.com/test-ctr/reference/test-center-concepts) and [Example: create a condition](https://techdocs.akamai.com/test-ctr/reference/example-create-condition).",
                                "minLength": 1,
                                "type": "string"
                              }
                            },
                            "required": [
                              "conditionExpression"
                            ],
                            "type": "object"
                          },
                          "testRequest": {
                            "additionalProperties": false,
                            "description": "Specifies a test request executed during the test.",
                            "properties": {
                              "requestMethod": {
                                "description": "Request method for the `testRequestUrl`. The available values are: `HEAD`, `GET`, and `POST`.",
                                "enum": [
                                  "HEAD",
                                  "GET",
                                  "POST"
                                ],
                                "type": "string"
                              },
                              "testRequestUrl": {
                                "description": "Fully qualified URL of the page or object you want to test, including any query string parameters. Test Center requests this URL from a browser, as well as any requests triggered by it.",
                                "format": "uri",
                                "maxLength": 2048,
                                "type": "string"
                              }
                            },
                            "required": [
                              "testRequestUrl",
                              "requestMethod"
                            ],
                            "type": "object"
                          }
                        },
                        "required": [
                          "testRequest",
                          "condition",
                          "clientProfile"
                        ],
                        "type": "object"
                      },
                      "minItems": 0,
                      "type": "array"
                    },
                    "testSuiteName": {
                      "description": "Unique name for each test suite.",
                      "minLength": 1,
                      "type": "string"
                    },
                    "variables": {
                      "description": "Lists generated variables referenced from a test case: `testRequestUrl`, `headerName`, `headerValue`, and `conditionExpression`.",
                      "items": {
                        "additionalProperties": false,
                        "description": "Variables referenced in `testRequestUrl`, `headerName`, `headerValue`, `requestBody`, or `conditionExpression` of a test case or in `function`. Variables appear with `{{variableName}}` syntax. To learn more, see [Variables](https://techdocs.akamai.com/test-ctr/reference/variables-overview).",
                        "properties": {
                          "variableName": {
                            "description": "Name of the variable.",
                            "maxLength": 100,
                            "minLength": 1,
                            "type": "string"
                          },
                          "variableValue": {
                            "description": "Value of the variable.",
                            "maxLength": 4000,
                            "minLength": 1,
                            "type": "string"
                          }
                        },
                        "required": [
                          "variableName",
                          "variableValue"
                        ],
                        "title": "Single variables",
                        "type": "object"
                      },
                      "minItems": 0,
                      "type": "array"
                    }
                  },
                  "required": [
                    "testSuiteName",
                    "isLocked",
                    "isStateful",
                    "configs",
                    "testCases",
                    "variables"
                  ],
                  "type": "object"
                }
              }
            },
            "description": "The response provides the generated test suite with test cases and variables."
          },
          "400": {
            "content": {
              "application/problem+json": {
                "example": {
                  "errors": [
                    {
                      "requestField": "propertyName",
                      "title": "Required field missing",
                      "type": "required.field.missing"
                    }
                  ],
                  "instance": "e4bdb007-213d-4573-ab76-4f071b55de59",
                  "problemId": "f4bdb007-213d-4599-ab76-4f071b3fc129",
                  "status": 400,
                  "title": "Validation error",
                  "type": "validation.error"
                },
                "schema": {
                  "additionalProperties": true,
                  "description": "Specifies the errors.",
                  "properties": {
                    "errors": {
                      "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc9457) objects indicating causes of failure.",
                      "items": {
                        "additionalProperties": false,
                        "description": "Specifies the error that occurred.",
                        "properties": {
                          "existingEntities": {
                            "description": "Lists objects included within the functional test case.",
                            "items": {
                              "additionalProperties": true,
                              "type": "object"
                            },
                            "minItems": 0,
                            "type": "array"
                          },
                          "problemId": {
                            "description": "An unique UUID generated for the error object.    ",
                            "type": "string"
                          },
                          "requestField": {
                            "description": "Request field name the error refers to. It can be a URL path or query parameter, or any request payload field name.",
                            "minLength": 1,
                            "type": "string"
                          },
                          "requestObjects": {
                            "description": "Lists invalid request objects.",
                            "items": {
                              "additionalProperties": true,
                              "type": "object"
                            },
                            "minItems": 0,
                            "type": "array"
                          },
                          "requestValues": {
                            "description": "Lists values corresponding to the `requestField`.",
                            "items": {
                              "anyOf": [
                                {
                                  "title": "String",
                                  "type": "string"
                                },
                                {
                                  "title": "Integer",
                                  "type": "integer"
                                },
                                {
                                  "title": "Object",
                                  "type": "object"
                                }
                              ]
                            },
                            "minItems": 0,
                            "type": "array"
                          },
                          "title": {
                            "description": "Title of the error.",
                            "minLength": 1,
                            "type": "string"
                          },
                          "type": {
                            "description": "Type of error.",
                            "minLength": 1,
                            "type": "string"
                          }
                        },
                        "required": [
                          "type",
                          "title",
                          "problemId"
                        ],
                        "type": "object"
                      },
                      "minItems": 0,
                      "type": "array"
                    },
                    "instance": {
                      "description": "Identifies an error.",
                      "minLength": 1,
                      "type": "string"
                    },
                    "problemId": {
                      "description": "An unique UUID generated for the error object.    ",
                      "type": "string"
                    },
                    "requestField": {
                      "description": "Request field name the error refers to. It can be a URL path or query parameter, or any request payload field name.",
                      "minLength": 1,
                      "type": "string"
                    },
                    "requestValues": {
                      "description": "Lists values corresponding to the `requestField`.",
                      "items": {
                        "anyOf": [
                          {
                            "title": "String",
                            "type": "string"
                          },
                          {
                            "title": "Integer",
                            "type": "integer"
                          },
                          {
                            "title": "Object",
                            "type": "object"
                          }
                        ]
                      },
                      "minItems": 0,
                      "type": "array"
                    },
                    "status": {
                      "description": "HTTP response code.",
                      "maximum": 599,
                      "minimum": 100,
                      "type": "integer"
                    },
                    "title": {
                      "description": "Title of the error.",
                      "minLength": 1,
                      "type": "string"
                    },
                    "type": {
                      "description": "Type of error.",
                      "minLength": 1,
                      "type": "string"
                    }
                  },
                  "required": [
                    "type",
                    "title",
                    "instance",
                    "status",
                    "problemId"
                  ],
                  "type": "object"
                }
              }
            },
            "description": "[Validation errors](https://techdocs.akamai.com/test-ctr/reference/400)."
          },
          "403": {
            "content": {
              "application/problem+json": {
                "example": {
                  "errors": [
                    {
                      "title": "Required permission missing",
                      "type": "required.permission.missing"
                    }
                  ],
                  "instance": "a86ef2f3-4ffa-4eef-a041-6558311dd3a2",
                  "problemId": "f4bdb007-213d-4599-ab76-4f071b3fc129",
                  "status": 403,
                  "title": "Authorization error",
                  "type": "authorization.error"
                },
                "schema": {
                  "additionalProperties": true,
                  "description": "Specifies the errors.",
                  "properties": {
                    "errors": {
                      "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc9457) objects indicating causes of failure.",
                      "items": {
                        "additionalProperties": false,
                        "description": "Specifies the error that occurred.",
                        "properties": {
                          "existingEntities": {
                            "description": "Lists objects included within the functional test case.",
                            "items": {
                              "additionalProperties": true,
                              "type": "object"
                            },
                            "minItems": 0,
                            "type": "array"
                          },
                          "problemId": {
                            "description": "An unique UUID generated for the error object.    ",
                            "type": "string"
                          },
                          "requestField": {
                            "description": "Request field name the error refers to. It can be a URL path or query parameter, or any request payload field name.",
                            "minLength": 1,
                            "type": "string"
                          },
                          "requestObjects": {
                            "description": "Lists invalid request objects.",
                            "items": {
                              "additionalProperties": true,
                              "type": "object"
                            },
                            "minItems": 0,
                            "type": "array"
                          },
                          "requestValues": {
                            "description": "Lists values corresponding to the `requestField`.",
                            "items": {
                              "anyOf": [
                                {
                                  "title": "String",
                                  "type": "string"
                                },
                                {
                                  "title": "Integer",
                                  "type": "integer"
                                },
                                {
                                  "title": "Object",
                                  "type": "object"
                                }
                              ]
                            },
                            "minItems": 0,
                            "type": "array"
                          },
                          "title": {
                            "description": "Title of the error.",
                            "minLength": 1,
                            "type": "string"
                          },
                          "type": {
                            "description": "Type of error.",
                            "minLength": 1,
                            "type": "string"
                          }
                        },
                        "required": [
                          "type",
                          "title",
                          "problemId"
                        ],
                        "type": "object"
                      },
                      "minItems": 0,
                      "type": "array"
                    },
                    "instance": {
                      "description": "Identifies an error.",
                      "minLength": 1,
                      "type": "string"
                    },
                    "problemId": {
                      "description": "An unique UUID generated for the error object.    ",
                      "type": "string"
                    },
                    "requestField": {
                      "description": "Request field name the error refers to. It can be a URL path or query parameter, or any request payload field name.",
                      "minLength": 1,
                      "type": "string"
                    },
                    "requestValues": {
                      "description": "Lists values corresponding to the `requestField`.",
                      "items": {
                        "anyOf": [
                          {
                            "title": "String",
                            "type": "string"
                          },
                          {
                            "title": "Integer",
                            "type": "integer"
                          },
                          {
                            "title": "Object",
                            "type": "object"
                          }
                        ]
                      },
                      "minItems": 0,
                      "type": "array"
                    },
                    "status": {
                      "description": "HTTP response code.",
                      "maximum": 599,
                      "minimum": 100,
                      "type": "integer"
                    },
                    "title": {
                      "description": "Title of the error.",
                      "minLength": 1,
                      "type": "string"
                    },
                    "type": {
                      "description": "Type of error.",
                      "minLength": 1,
                      "type": "string"
                    }
                  },
                  "required": [
                    "type",
                    "title",
                    "instance",
                    "status",
                    "problemId"
                  ],
                  "type": "object"
                }
              }
            },
            "description": "[Authorization error](https://techdocs.akamai.com/test-ctr/reference/403)."
          },
          "404": {
            "content": {
              "application/problem+json": {
                "example": {
                  "instance": "1dcdb168-8837-415e-92bc-31aa36326495",
                  "problemId": "f4bdb007-213d-4599-ab76-4f071b3fc129",
                  "requestField": "propertyName",
                  "requestValues": [
                    "atc_user1_config"
                  ],
                  "status": 404,
                  "title": "Resource not found",
                  "type": "resource.not.found"
                },
                "schema": {
                  "additionalProperties": true,
                  "description": "Specifies the errors.",
                  "properties": {
                    "errors": {
                      "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc9457) objects indicating causes of failure.",
                      "items": {
                        "additionalProperties": false,
                        "description": "Specifies the error that occurred.",
                        "properties": {
                          "existingEntities": {
                            "description": "Lists objects included within the functional test case.",
                            "items": {
                              "additionalProperties": true,
                              "type": "object"
                            },
                            "minItems": 0,
                            "type": "array"
                          },
                          "problemId": {
                            "description": "An unique UUID generated for the error object.    ",
                            "type": "string"
                          },
                          "requestField": {
                            "description": "Request field name the error refers to. It can be a URL path or query parameter, or any request payload field name.",
                            "minLength": 1,
                            "type": "string"
                          },
                          "requestObjects": {
                            "description": "Lists invalid request objects.",
                            "items": {
                              "additionalProperties": true,
                              "type": "object"
                            },
                            "minItems": 0,
                            "type": "array"
                          },
                          "requestValues": {
                            "description": "Lists values corresponding to the `requestField`.",
                            "items": {
                              "anyOf": [
                                {
                                  "title": "String",
                                  "type": "string"
                                },
                                {
                                  "title": "Integer",
                                  "type": "integer"
                                },
                                {
                                  "title": "Object",
                                  "type": "object"
                                }
                              ]
                            },
                            "minItems": 0,
                            "type": "array"
                          },
                          "title": {
                            "description": "Title of the error.",
                            "minLength": 1,
                            "type": "string"
                          },
                          "type": {
                            "description": "Type of error.",
                            "minLength": 1,
                            "type": "string"
                          }
                        },
                        "required": [
                          "type",
                          "title",
                          "problemId"
                        ],
                        "type": "object"
                      },
                      "minItems": 0,
                      "type": "array"
                    },
                    "instance": {
                      "description": "Identifies an error.",
                      "minLength": 1,
                      "type": "string"
                    },
                    "problemId": {
                      "description": "An unique UUID generated for the error object.    ",
                      "type": "string"
                    },
                    "requestField": {
                      "description": "Request field name the error refers to. It can be a URL path or query parameter, or any request payload field name.",
                      "minLength": 1,
                      "type": "string"
                    },
                    "requestValues": {
                      "description": "Lists values corresponding to the `requestField`.",
                      "items": {
                        "anyOf": [
                          {
                            "title": "String",
                            "type": "string"
                          },
                          {
                            "title": "Integer",
                            "type": "integer"
                          },
                          {
                            "title": "Object",
                            "type": "object"
                          }
                        ]
                      },
                      "minItems": 0,
                      "type": "array"
                    },
                    "status": {
                      "description": "HTTP response code.",
                      "maximum": 599,
                      "minimum": 100,
                      "type": "integer"
                    },
                    "title": {
                      "description": "Title of the error.",
                      "minLength": 1,
                      "type": "string"
                    },
                    "type": {
                      "description": "Type of error.",
                      "minLength": 1,
                      "type": "string"
                    }
                  },
                  "required": [
                    "type",
                    "title",
                    "instance",
                    "status",
                    "problemId"
                  ],
                  "type": "object"
                }
              }
            },
            "description": "[Resource not found error](https://techdocs.akamai.com/test-ctr/reference/404)."
          }
        },
        "summary": "Generate a test suite with child objects",
        "tags": [
          "Test suites"
        ]
      }
    }
  },
  "servers": [
    {
      "url": "https://{hostname}/test-management/v3"
    }
  ],
  "tags": [
    {
      "description": "Create and manage test suites for your organization.",
      "name": "Test suites"
    }
  ],
  "x-readme": {
    "samples-languages": [
      "curl",
      "python",
      "node"
    ],
    "explorer-enabled": true,
    "proxy-enabled": true
  }
}
```

# Sibling pages

* [Create a test suite](https://techdocs.akamai.com/test-ctr/reference/post-test-suites.md)
* [List test suites](https://techdocs.akamai.com/test-ctr/reference/get-test-suites.md)
* [Create a test suite with child objects](https://techdocs.akamai.com/test-ctr/reference/post-test-suites-with-child-objects.md)
* [Get a test suite](https://techdocs.akamai.com/test-ctr/reference/get-test-suite.md)
* [Update a test suite](https://techdocs.akamai.com/test-ctr/reference/put-test-suite.md)
* [Delete a test suite](https://techdocs.akamai.com/test-ctr/reference/delete-test-suite.md)
* [Restore a test suite](https://techdocs.akamai.com/test-ctr/reference/post-test-suite-restore.md)
* [Get a test suite with child objects](https://techdocs.akamai.com/test-ctr/reference/get-test-suites-with-child-objects.md)
* [Update a test suite with child objects](https://techdocs.akamai.com/test-ctr/reference/put-test-suites-with-child-objects.md)