Sample - Box Platform API
POST/shield_information_barrier_segments

Create a shield information barrier segment

Creates a new shield information barrier segment. Supply the associated shield_information_barrier and a unique name, and optionally include a description. A 201 response returns the created segment with its identifier and audit timestamps.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

3 body fields

Shield information barrier segment details, including its associated barrier, name, and optional description.

shield_information_barrierobjectrequired
A base representation of a shield information barrier object.
namestringrequired
Name of the shield information barrier segment.
descriptionstringoptional
Description of the shield information barrier segment.

4 status codes
201Returns the created shield information barrier segment, including its identifier, associated barrier, name, description, and creation and update timestamps.
idstringoptional
The unique identifier for the shield information barrier segment.
typestringoptional
The type of the shield information barrier segment.
Allowed:shield_information_barrier_segment
shield_information_barrierobjectoptional
A base representation of a shield information barrier object.
namestringoptional
Name of the shield information barrier segment.
descriptionstringoptional
Description of the shield information barrier segment.
created_atstringoptional
ISO date time string when this shield information barrier object was created.
created_byobjectoptional
updated_atstringoptional
ISO date time string when this shield information barrier segment was updated.
updated_byobjectoptional
404Returned when the associated shield information barrier cannot be found.
typestringoptional
The value will always be `error`.
Allowed:error
statusintegeroptional
The HTTP status of the response.
codestringoptional
A Box-specific error code.
Allowed:createdacceptedno_contentredirectnot_modifiedbad_requestunauthorizedforbiddennot_foundmethod_not_allowedconflictprecondition_failed
messagestringoptional
A short message describing the error.
context_infoobjectoptional
A free-form object that contains additional context about the error. The possible fields are defined on a per-endpoint basis. `message` is only one example.
help_urlstringoptional
A URL that links to more information about why this error occurred.
request_idstringoptional
A unique identifier for this response, which can be used when contacting Box support.
409Returned when a shield information barrier segment with the same name already exists.
typestringoptional
The value will always be `error`.
Allowed:error
statusintegeroptional
The HTTP status of the response.
codestringoptional
A Box-specific error code.
Allowed:createdacceptedno_contentredirectnot_modifiedbad_requestunauthorizedforbiddennot_foundmethod_not_allowedconflictprecondition_failed
messagestringoptional
A short message describing the error.
context_infoobjectoptional
A free-form object that contains additional context about the error. The possible fields are defined on a per-endpoint basis. `message` is only one example.
help_urlstringoptional
A URL that links to more information about why this error occurred.
request_idstringoptional
A unique identifier for this response, which can be used when contacting Box support.
defaultReturned when an unexpected client error occurs.
typestringoptional
The value will always be `error`.
Allowed:error
statusintegeroptional
The HTTP status of the response.
codestringoptional
A Box-specific error code.
Allowed:createdacceptedno_contentredirectnot_modifiedbad_requestunauthorizedforbiddennot_foundmethod_not_allowedconflictprecondition_failed
messagestringoptional
A short message describing the error.
context_infoobjectoptional
A free-form object that contains additional context about the error. The possible fields are defined on a per-endpoint basis. `message` is only one example.
help_urlstringoptional
A URL that links to more information about why this error occurred.
request_idstringoptional
A unique identifier for this response, which can be used when contacting Box support.

Error handling

A 404 is returned when the specified shield_information_barrier does not exist. A 409 is returned when another segment already uses the same name. The shield_information_barrier object and name fields are required, and its type must be shield_information_barrier.