nova/api-ref/source/os-security-groups.inc
Andreas Jaeger dbe6321537 Update api-ref location
The api documentation is now published on docs.openstack.org instead
of developer.openstack.org. Update all links that are changed to the
new location.

Note that Neutron publishes to api-ref/network, not networking anymore.

Note that redirects will be set up as well but let's point now to the
new location.

For details, see:
http://lists.openstack.org/pipermail/openstack-discuss/2019-July/007828.html

Change-Id: Id2cf3aa252df6db46575b5988e4937ecfc6792bb
2019-07-22 19:17:28 +02:00

201 lines
4.4 KiB
ReStructuredText

.. -*- rst -*-
.. NOTE(gmann): These APIs are deprecated so do not update this
file even body, example or parameters are not complete.
==================================================
Security groups (os-security-groups) (DEPRECATED)
==================================================
.. warning::
These APIs are proxy calls to the Network service. Nova has
deprecated all the proxy APIs and users should use the native APIs
instead. These will fail with a 404 starting from microversion 2.36.
See: `Relevant Network APIs
<https://docs.openstack.org/api-ref/network/v2/#security-groups-security-groups>`__.
Lists, shows information for, creates, updates and deletes security groups.
List Security Groups
====================
.. rest_method:: GET /os-security-groups
Lists security groups.
Normal response codes: 200
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404)
Request
-------
.. rest_parameters:: parameters.yaml
- limit: limit_simple
- offset: offset_simple
- all_tenants: all_tenants_sec_grp_query
Response
--------
.. rest_parameters:: parameters.yaml
- security_groups: security_groups_obj
- description: description
- id: security_group_id_body
- name: name
- rules: rules
- tenant_id: tenant_id_body
**Example List security groups: JSON response**
.. literalinclude:: ../../doc/api_samples/os-security-groups/security-groups-list-get-resp.json
:language: javascript
Create Security Group
=====================
.. rest_method:: POST /os-security-groups
Creates a security group.
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403)
Request
-------
.. rest_parameters:: parameters.yaml
- security_group: security_group
- name: name
- description: description
**Example Create security group: JSON request**
.. literalinclude:: ../../doc/api_samples/os-security-groups/security-group-post-req.json
:language: javascript
Response
--------
.. rest_parameters:: parameters.yaml
- security_group: security_group
- description: description
- id: security_group_id_body
- name: name
- rules: rules
- tenant_id: tenant_id_body
**Example Create security group: JSON response**
.. literalinclude:: ../../doc/api_samples/os-security-groups/security-groups-create-resp.json
:language: javascript
Show Security Group Details
===========================
.. rest_method:: GET /os-security-groups/{security_group_id}
Shows details for a security group.
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403), itemNotFound(404)
Request
-------
.. rest_parameters:: parameters.yaml
- security_group_id: security_group_id
Response
--------
.. rest_parameters:: parameters.yaml
- security_group: security_group
- description: description
- id: security_group_id_body
- name: name
- rules: rules
- tenant_id: tenant_id_body
**Example Show security group: JSON response**
.. literalinclude:: ../../doc/api_samples/os-security-groups/security-groups-get-resp.json
:language: javascript
Update Security Group
=====================
.. rest_method:: PUT /os-security-groups/{security_group_id}
Updates a security group.
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403), itemNotFound(404)
Request
-------
.. rest_parameters:: parameters.yaml
- security_group_id: security_group_id
- name: name
- description: description
**Example Update security group: JSON request**
.. literalinclude:: ../../doc/api_samples/os-security-groups/security-group-post-req.json
:language: javascript
Response
--------
.. rest_parameters:: parameters.yaml
- security_group: security_group
- description: description
- id: security_group_id_body
- name: name
- rules: rules
- tenant_id: tenant_id_body
**Example Update security group: JSON response**
.. literalinclude:: ../../doc/api_samples/os-security-groups/security-groups-create-resp.json
:language: javascript
Delete Security Group
=====================
.. rest_method:: DELETE /os-security-groups/{security_group_id}
Deletes a security group.
Normal response codes: 202
Error response codes: badRequest(400), unauthorized(401), forbidden(403), itemNotFound(404)
Request
-------
.. rest_parameters:: parameters.yaml
- security_group_id: security_group_id
Response
--------
There is no body content for the response of a successful DELETE query.