Home > Configuration > Api > updateapispec

updateapispec

Use this method to updates the api spec with latest specfile. In a high availability configuration, the path to the specfile must be the same on the primary and secondary nodes.

Syntax



Parameters

name

Name for the spec. Must begin with an ASCII alphanumeric or underscore (_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period (.), space, colon (:), at (@), equals (=), and hyphen (-) characters. Cannot be changed after the spec is created. The following requirement applies only to the Citrix ADC CLI: If the name includes one or more spaces, enclose the name in double or single quotation marks (for example, "my spec" or 'my spec').
This is mandatory parameter.

file

Name of and, optionally, path to the api spec file. The spec file should be present on the appliance's hard-disk drive or solid-state drive. Storing a spec file in any location other than the default might cause inconsistency in a high availability setup. /nsconfig/apispec/ is the default path.
This is mandatory parameter.

type

Input format of the spec file. The three formats supported by the appliance are: PROTO OAS/Swagger GRAPHQL
Default value = NS_APISPEC_OAS.

skipvalidation

Disabling openapi spec validation while adding it
Default value = NO.

Return Value

Returns simpleResult

See Also