api-protection response
api-protection response(1) BIG-IP TMSH Manual api-protection response(1)
NAME
response - Manages responses for API Protection Profile.
MODULE
api-protection response
SYNTAX
Configure the response component within the api-protection module using the following syntax.
CREATE/MODIFY
create response [name]
modify response [name]
options
app-service [[string] | none]
body [[string] | none]
description [[string] | none]
headers [add | delete | modify | none | replace-all-with] {
[name] {
app-service [[string] | none]
header-name [[string] | none]
header-value [[string] | none]
}
status-code [string]
status-string [string]
edit response [ [ [name] | [glob] | [regex] ] ... ]
options:
all-properties
non-default-properties
one-line
DISPLAY
list response
list response [ [ [name] | [glob] | [regex] ] ... ]
show running-config response
show running-config response [ [ [name] | [glob] | [regex] ] ... ]
options:
all-properties
non-default-properties
one-line
DELETE
delete response [name]
DESCRIPTION
You can use the response component to create and manage responses that can be used by the API Protection profile.
EXAMPLES
create response response401 {
description "Unauthorized Request"
status-code 401
status-string "Unauthorized"
}
Creates a response named response401 with status-code set to 401 and corresponding status-string set to Unauthorized.
list response
Displays a list of responses.
delete response response401
Deletes the response named response401.
OPTIONS
app-service
Specifies the name of the application service to which the object belongs. The default value is none. Note: If the
strict-updates option is enabled on the application service that owns the object, you cannot modify or delete the
object. Only the application service can modify or delete the object.
[name]
Specifies the name of the Response object. This setting is required.
body Specifies the body of the response. This value can be any string or session variable.
description
Specifies the description of the response.
partition
Displays the partition within which the component resides.
headers
Adds, deletes, modifies or replaces a set of headers, by specifying a header name and value for each entry. Header
name and header value can be any string or session variable.
status-code
Specifies the response code that must be issued. This value can be any string or session variable. This setting is
required.
status-string
Specifies the status string that must be issued. This value can be any string or session variable. This setting is
required.
SEE ALSO
api-protection profile apiprotection
COPYRIGHT
No part of this program may be reproduced or transmitted in any form or by any means, electronic or mechanical, including
photocopying, recording, or information storage and retrieval systems, for any purpose other than the purchaser's personal
use, without the express written permission of F5 Networks, Inc.
F5 Networks and BIG-IP (c) Copyright 2018. All rights reserved.
BIG-IP 2018-07-10 api-protection response(1)